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

• #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

included

Methods inherited from Base

#ansible_name, #to_h

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, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 47

attribute :delete_on_termination

#device_name ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 43

attribute :device_name

#encrypted ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 36

attribute :encrypted

#id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 20

attribute :id

#instance ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 12

attribute :instance

#iops ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 32

attribute :iops

#kms_key_id ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 40

attribute :kms_key_id

#name ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 16

attribute :name

#snapshot ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 55

attribute :snapshot

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 63

attribute :state

#tags ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 67

attribute :tags

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 59

attribute :validate_certs

#volume_size ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 24

attribute :volume_size

#volume_type ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 28

attribute :volume_type

#zone ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vol.rb', line 51

attribute :zone