Class: Ansible::Ruby::Modules::Ec2_vol
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Ec2_vol
- Includes:
- Helpers::Aws
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb,
lib/ansible/ruby/modules/custom/cloud/core/amazon/ec2_vol.rb
Overview
creates an EBS volume and optionally attaches it to an instance. If both an instance ID and a device name is given and the instance has a device at the device name, then no volume is created and no attachment is made. This module has a dependency on python-boto.
Instance Method Summary collapse
-
#delete_on_termination ⇒ :yes, ...
When set to “yes”, the volume will be deleted upon instance termination.
-
#device_name ⇒ String?
Device id to override device mapping.
-
#encrypted ⇒ String?
Enable encryption at rest for this volume.
-
#id ⇒ String?
Volume id if you wish to attach an existing volume (requires instance) or remove an existing volume.
-
#instance ⇒ String?
Instance ID if you wish to attach the volume.
-
#iops ⇒ Integer?
The provisioned IOPs you want to associate with this volume (integer).
-
#kms_key_id ⇒ Object?
Specify the id of the KMS key to use.
-
#name ⇒ String?
Volume Name tag if you wish to attach an existing volume (requires instance).
-
#snapshot ⇒ String?
Snapshot ID on which to base the volume.
-
#state ⇒ :absent, ...
Whether to ensure the volume is present or absent, or to list existing volumes (The C(list) option was added in version 1.8).
-
#tags ⇒ Object?
Tag:value pairs to add to the volume after creation.
-
#validate_certs ⇒ :yes, ...
When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.
-
#volume_size ⇒ Integer?
Size of volume (in GB) to create.
-
#volume_type ⇒ String?
Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD).
-
#zone ⇒ String?
Zone in which to create the volume, if unset uses the zone the instance is in (if set).
Methods included from Helpers::Aws
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#delete_on_termination ⇒ :yes, ...
Returns When set to “yes”, the volume will be deleted upon instance termination.
47 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 47 attribute :delete_on_termination |
#device_name ⇒ String?
Returns device id to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows.
43 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 43 attribute :device_name |
#encrypted ⇒ String?
Returns Enable encryption at rest for this volume.
36 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 36 attribute :encrypted |
#id ⇒ String?
Returns volume id if you wish to attach an existing volume (requires instance) or remove an existing volume.
20 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 20 attribute :id |
#instance ⇒ String?
Returns instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach.
12 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 12 attribute :instance |
#iops ⇒ Integer?
Returns the provisioned IOPs you want to associate with this volume (integer).
32 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 32 attribute :iops |
#kms_key_id ⇒ Object?
Returns Specify the id of the KMS key to use.
40 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 40 attribute :kms_key_id |
#name ⇒ String?
Returns volume Name tag if you wish to attach an existing volume (requires instance).
16 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 16 attribute :name |
#snapshot ⇒ String?
Returns snapshot ID on which to base the volume.
55 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 55 attribute :snapshot |
#state ⇒ :absent, ...
Returns whether to ensure the volume is present or absent, or to list existing volumes (The C(list) option was added in version 1.8).
63 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 63 attribute :state |
#tags ⇒ Object?
Returns tag:value pairs to add to the volume after creation.
67 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 67 attribute :tags |
#validate_certs ⇒ :yes, ...
Returns When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.
59 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 59 attribute :validate_certs |
#volume_size ⇒ Integer?
Returns size of volume (in GB) to create.
24 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 24 attribute :volume_size |
#volume_type ⇒ String?
Returns Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD). “Standard” is the old EBS default and continues to remain the Ansible default for backwards compatibility.
28 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 28 attribute :volume_type |
#zone ⇒ String?
Returns zone in which to create the volume, if unset uses the zone the instance is in (if set).
51 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 51 attribute :zone |