Class: MintPress::Aws::EC2::Volume

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb

Properties (Read/Write)

  • #device ⇒ [String]
    'The device name.'
    Property Attributes
    • attach_volume_prop ⇒ 'device'
    • read_only ⇒ false
    • source ⇒ "detach_volume"
    • detach_volume_prop ⇒ 'device'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 33

property :device, attach_volume_prop: 'device', type: [String], read_only: false, source: "detach_volume", description: 'The device name.', detach_volume_prop: 'device'
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • attach_volume_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_volume"
    • create_volume_prop ⇒ 'dry_run'
    • delete_volume_prop ⇒ 'dry_run'
    • describe_volumes_prop ⇒ 'dry_run'
    • detach_volume_prop ⇒ 'dry_run'
    • modify_volume_prop ⇒ 'dry_run'
    

34
35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 34

property :dry_run, attach_volume_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_volume", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', create_volume_prop: 'dry_run', delete_volume_prop: 'dry_run', describe_volumes_prop: 'dry_run', detach_volume_prop: 'dry_run', modify_volume_prop: 'dry_run'
  • #availability_zone ⇒ [String]
    'The Availability Zone in which to create the volume.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'availability_zone'
    • create_volume_prop ⇒ 'availability_zone'
    • read_only ⇒ false
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 39

property :availability_zone, description: 'The Availability Zone in which to create the volume.', source: "create_volume", orig_name: 'availability_zone', type: [String], create_volume_prop: 'availability_zone', read_only: false
  • #encrypted ⇒ [TrueClass,FalseClass]
    'Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'encrypted'
    • create_volume_prop ⇒ 'encrypted'
    • read_only ⇒ false
    

41
42
43
44
45
46
47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 41

property :encrypted, description: 'Indicates whether the volume should be encrypted. The effect of
setting the encryption state to true depends on the volume origin
(new or from a snapshot), starting encryption state, ownership, and
whether encryption by default is enabled. For more information, see
Encryption by default in the Amazon Elastic Compute Cloud User
Guide.

Encrypted Amazon EBS volumes must be attached to instances that
support Amazon EBS encryption. For more information, see Supported
instance types.', source: "create_volume", orig_name: 'encrypted', type: [TrueClass,FalseClass], create_volume_prop: 'encrypted', read_only: false
  • #iops ⇒ [Integer]
    'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: gp3: 3,000-16,000 IOPS io1: 100-64,000 IOPS io2: 100-64,000 IOPS For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'iops'
    • create_volume_prop ⇒ 'iops'
    • read_only ⇒ false
    • modify_volume_prop ⇒ 'iops'
    

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 52

property :iops, description: 'The number of I/O operations per second (IOPS). For gp3, io1, and
io2 volumes, this represents the number of IOPS that are provisioned
for the volume. For gp2 volumes, this represents the baseline
performance of the volume and the rate at which the volume accumulates
I/O credits for bursting.

The following are the supported values for each volume type:


gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS



For io1 and io2 volumes, we guarantee 64,000 IOPS only for
Instances built on the Nitro System. Other instance families
guarantee performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default
for gp3 volumes is 3,000 IOPS. This parameter is not supported for
gp2, st1, sc1, or standard volumes.', source: "create_volume", orig_name: 'iops', type: [Integer], create_volume_prop: 'iops', read_only: false, modify_volume_prop: 'iops'
  • #multi_attach_enabled ⇒ [TrueClass,FalseClass]
    'Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'multi_attach_enabled'
    • create_volume_prop ⇒ 'multi_attach_enabled'
    • read_only ⇒ false
    • modify_volume_prop ⇒ 'multi_attach_enabled'
    

74
75
76
77
78
79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 74

property :multi_attach_enabled, description: 'Indicates whether to enable Amazon EBS Multi-Attach. If you enable
Multi-Attach, you can attach the volume to up to 16 Instances built
on the Nitro System in the same Availability Zone. This parameter
is supported with io1 and io2 volumes only. For more information,
see  Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud
User Guide.', source: "create_volume", orig_name: 'multi_attach_enabled', type: [TrueClass,FalseClass], create_volume_prop: 'multi_attach_enabled', read_only: false, modify_volume_prop: 'multi_attach_enabled'
  • #outpost_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the Outpost.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'outpost_arn'
    • create_volume_prop ⇒ 'outpost_arn'
    • read_only ⇒ false
    

80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 80

property :outpost_arn, description: 'The Amazon Resource Name (ARN) of the Outpost.', source: "create_volume", orig_name: 'outpost_arn', type: [String], create_volume_prop: 'outpost_arn', read_only: false
  • #size ⇒ [Integer]
    'The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: gp2 and gp3: 1-16,384 io1 and io2: 4-16,384 st1 and sc1: 125-16,384 standard: 1-1,024'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'size'
    • create_volume_prop ⇒ 'size'
    • read_only ⇒ false
    • modify_volume_prop ⇒ 'size'
    

81
82
83
84
85
86
87
88
89
90
91
92
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 81

property :size, description: 'The size of the volume, in GiBs. You must specify either a snapshot ID
or a volume size. If you specify a snapshot, the default is the
snapshot size. You can specify a volume size that is equal to or
larger than the snapshot size.

The following are the supported volumes sizes for each volume type:


gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024', source: "create_volume", orig_name: 'size', type: [Integer], create_volume_prop: 'size', read_only: false, modify_volume_prop: 'size'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to apply to the volume during creation.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'tags'
    • create_volume_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

94
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 94

property :tags, description: 'The tags to apply to the volume during creation.', source: "create_volume", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_volume_prop: 'tag_specifications', read_only: false, hash: true
  • #throughput ⇒ [Integer]
    'The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. Maximum value of 1000.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'throughput'
    • create_volume_prop ⇒ 'throughput'
    • read_only ⇒ false
    • modify_volume_prop ⇒ 'throughput'
    

95
96
97
98
99
100
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 95

property :throughput, description: 'The throughput to provision for a volume, with a maximum of 1,000
MiB/s.

This parameter is valid only for gp3 volumes.

Valid Range: Minimum value of 125. Maximum value of 1000.', source: "create_volume", orig_name: 'throughput', type: [Integer], create_volume_prop: 'throughput', read_only: false, modify_volume_prop: 'throughput'
  • #volume_type ⇒ [String]
    'The volume type. This parameter can be one of the following values: General Purpose SSD: gp2 | gp3 Provisioned IOPS SSD: io1 | io2 Throughput Optimized HDD: st1 Cold HDD: sc1 Magnetic: standard For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. Default: gp2'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'volume_type'
    • create_volume_prop ⇒ 'volume_type'
    • read_only ⇒ false
    • modify_volume_prop ⇒ 'volume_type'
    

101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 101

property :volume_type, description: 'The volume type. This parameter can be one of the following values:


General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard



For more information, see Amazon EBS volume types in the Amazon
Elastic Compute Cloud User Guide.

Default: gp2', source: "create_volume", orig_name: 'volume_type', type: [String], create_volume_prop: 'volume_type', read_only: false, modify_volume_prop: 'volume_type'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. attachment.attach-time - The time stamp when the attachment initiated. attachment.delete-on-termination - Whether the volume is deleted on instance termination. attachment.device - The device name specified in the block device mapping (for example, /dev/sda1). attachment.instance-id - The ID of the instance the volume is attached to. attachment.status - The attachment state (attaching | attached | detaching). availability-zone - The Availability Zone in which the volume was created. create-time - The time stamp when the volume was created. encrypted - Indicates whether the volume is encrypted (true | false) multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false) fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false). size - The size of the volume, in GiB. snapshot-id - The snapshot from which the volume was created. status - The state of the volume (creating | available | in-use | deleting | deleted | error). tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. volume-id - The volume ID. volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)'
    Property Attributes
    • describe_volumes_prop ⇒ 'filters'
    • source ⇒ "describe_volumes"
    

116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 116

property :filters, describe_volumes_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_volumes", description: 'The filters.


attachment.attach-time - The time stamp when the attachment
initiated.
attachment.delete-on-termination - Whether the volume is deleted
on instance termination.
attachment.device - The device name specified in the block device
mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is
attached to.
attachment.status - The attachment state (attaching |
attached | detaching).
availability-zone - The Availability Zone in which the volume was
created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true |
false)
multi-attach-enabled - Indicates whether the volume is enabled for
Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a
snapshot that is enabled for fast snapshot restore (true |
false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available |
in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1
| io2 | st1 | sc1| standard)', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
    Property Attributes
    • describe_volumes_prop ⇒ 'max_results'
    • source ⇒ "describe_volumes"
    

154
155
156
157
158
159
160
161
162
163
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 154

property :max_results, describe_volumes_prop: 'max_results', type: [Integer], source: "describe_volumes", description: 'The maximum number of volume results returned by DescribeVolumes in
paginated output. When this parameter is used, DescribeVolumes only
returns MaxResults results in a single page along with a NextToken
response element. The remaining results of the initial request can be
seen by sending another DescribeVolumes request with the returned
NextToken value. This value can be between 5 and 500; if
MaxResults is given a value larger than 500, only 500 results are
returned. If this parameter is not used, then DescribeVolumes
returns all results. You cannot specify this parameter and the volume
IDs parameter in the same request.'
  • #force ⇒ [TrueClass,FalseClass]
    'Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won"t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.'
    Property Attributes
    • detach_volume_prop ⇒ 'force'
    • read_only ⇒ false
    • source ⇒ "detach_volume"
    

164
165
166
167
168
169
170
171
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 164

property :force, detach_volume_prop: 'force', type: [TrueClass,FalseClass], read_only: false, source: "detach_volume", description: 'Forces detachment if the previous detachment attempt did not occur
cleanly (for example, logging into an instance, unmounting the volume,
and detaching normally). This option can lead to data loss or a
corrupted file system. Use this option only as a last resort to detach
a volume from a failed instance. The instance won"t have an
opportunity to flush file system caches or file system metadata. If
you use this option, you must perform file system check and repair
procedures.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The volume IDs.'
    Property Attributes
    • read_only ⇒ false
    • source ⇒ "describe_volumes"
    • orig_name ⇒ 'volume_id'
    • attach_volume_prop ⇒ 'volume_id'
    • delete_volume_prop ⇒ 'volume_id'
    • detach_volume_prop ⇒ 'volume_id'
    • modify_volume_prop ⇒ 'volume_id'
    • describe_volumes_prop ⇒ 'volume_ids'
    • default ⇒ Proc.new { self.name }
    

172
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 172

property :id, read_only: false, description: 'The volume IDs.', source: "describe_volumes", orig_name: 'volume_id', type: [String], attach_volume_prop: 'volume_id', delete_volume_prop: 'volume_id', detach_volume_prop: 'volume_id', modify_volume_prop: 'volume_id', array: false, hash: false, describe_volumes_prop: 'volume_ids', default: Proc.new { self.name }
  • #snapshots ⇒ Hash of ⇒ [MintPress::Aws::EC2::Snapshot]
    'The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.'
    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Volume"
    • orig_name ⇒ 'snapshots'
    • create_volume_prop ⇒ 'snapshot_id'
    • read_only ⇒ false
    • from ⇒ String
    

173
174
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 173

property :snapshots, disposition: :association, description: 'The snapshot from which to create the volume. You must specify either
a snapshot ID or a volume size.', source: "Volume", orig_name: 'snapshots', type: [MintPress::Aws::EC2::Snapshot], create_volume_prop: 'snapshot_id', read_only: false, array: false, from: String, hash: true
  • #instance ⇒ [MintPress::Aws::EC2::Instance]
    'The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.'
    Property Attributes
    • attach_volume_prop ⇒ 'instance_id'
    • read_only ⇒ false
    • source ⇒ "detach_volume"
    • detach_volume_prop ⇒ 'instance_id'
    • from ⇒ String
    

175
176
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 175

property :instance, attach_volume_prop: 'instance_id', type: [MintPress::Aws::EC2::Instance], read_only: false, source: "detach_volume", description: 'The ID of the instance. If you are detaching a Multi-Attach enabled
volume, you must specify an instance ID.', detach_volume_prop: 'instance_id', from: String
  • #kms_key ⇒ [String]
    'The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true. You can specify the CMK using any of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example, alias/ExampleAlias. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.'
    Property Attributes
    • source ⇒ "create_volume"
    • orig_name ⇒ 'kms_key_id'
    • create_volume_prop ⇒ 'kms_key_id'
    • read_only ⇒ false
    

177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 177

property :kms_key, description: 'The identifier of the AWS Key Management Service (AWS KMS) customer
master key (CMK) to use for Amazon EBS encryption. If this parameter
is not specified, your AWS managed CMK for EBS is used. If KmsKeyId
is specified, the encrypted state must be true.

You can specify the CMK using any of the following:


Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example,
arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.



AWS authenticates the CMK asynchronously. Therefore, if you specify an
ID, alias, or ARN that is not valid, the action can appear to
complete, but eventually fails.', source: "create_volume", orig_name: 'kms_key_id', type: [String], create_volume_prop: 'kms_key_id', read_only: false
  • #name ⇒ String

    Property Attributes 
    

197
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 197

property :name, type: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

201
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 201

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

204
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 204

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #attachments ⇒ Hash of ⇒ [MintPress::Aws::EC2::VolumeAttachment]
    'Information about the volume attachments.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Volume"
    • orig_name ⇒ 'attachments'
    • read_only ⇒ true
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 38

property :attachments, disposition: :read_only_attribute, description: 'Information about the volume attachments.', source: "Volume", orig_name: 'attachments', type: [MintPress::Aws::EC2::VolumeAttachment], array: false, read_only: true, hash: true
  • #create_time ⇒ [Time]
    'The time stamp when volume creation was initiated.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Volume"
    • orig_name ⇒ 'create_time'
    • read_only ⇒ true
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 40

property :create_time, disposition: :read_only_attribute, description: 'The time stamp when volume creation was initiated.', source: "Volume", orig_name: 'create_time', type: [Time], read_only: true
  • #fast_restored ⇒ [TrueClass,FalseClass]
    'Indicates whether the volume was created using fast snapshot restore.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Volume"
    • orig_name ⇒ 'fast_restored'
    • read_only ⇒ true
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 51

property :fast_restored, disposition: :read_only_attribute, description: 'Indicates whether the volume was created using fast snapshot restore.', source: "Volume", orig_name: 'fast_restored', type: [TrueClass,FalseClass], read_only: true
  • #state ⇒ [String]
    'The volume state.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Volume"
    • orig_name ⇒ 'state'
    • read_only ⇒ true
    

93
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume.rb', line 93

property :state, disposition: :read_only_attribute, description: 'The volume state.', source: "Volume", orig_name: 'state', type: [String], read_only: true

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Volume

Returns a new instance of Volume.

Instance Method Details

#attach ⇒ Object

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#detach ⇒ Object

#modify ⇒ Object