Class: Ansible::Ruby::Modules::Ec2_vol

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/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

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

Returns When set to “yes”, the volume will be deleted upon instance termination.

Returns:

  • (:yes, :no, nil) —

    When set to “yes”, the volume will be deleted upon instance termination.



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

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.

Returns:

  • (String, nil) —

    device id to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows.



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

attribute :device_name

#encrypted ⇒ Boolean?

Returns Enable encryption at rest for this volume.

Returns:

  • (Boolean, nil) —

    Enable encryption at rest for this volume.



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

attribute :encrypted

#id ⇒ String?

Returns volume id if you wish to attach an existing volume (requires instance) or remove an existing volume.

Returns:

  • (String, nil) —

    volume id if you wish to attach an existing volume (requires instance) or remove an existing volume



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

attribute :id

#instance ⇒ String?

Returns instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach.

Returns:

  • (String, nil) —

    instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach.



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

attribute :instance

#iops ⇒ Integer?

Returns the provisioned IOPs you want to associate with this volume (integer).

Returns:

  • (Integer, nil) —

    the provisioned IOPs you want to associate with this volume (integer).



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

attribute :iops

#name ⇒ String?

Returns volume Name tag if you wish to attach an existing volume (requires instance).

Returns:

  • (String, nil) —

    volume Name tag if you wish to attach an existing volume (requires instance)



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

attribute :name

#snapshot ⇒ String?

Returns snapshot ID on which to base the volume.

Returns:

  • (String, nil) —

    snapshot ID on which to base the volume



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

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

Returns:

  • (:absent, :present, :list, nil) —

    whether to ensure the volume is present or absent, or to list existing volumes (The C(list) option was added in version 1.8).



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

attribute :state

#validate_certs ⇒ :yes, ...

Returns When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.

Returns:

  • (:yes, :no, nil) —

    When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.



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

attribute :validate_certs

#volume_size ⇒ Integer?

Returns size of volume (in GB) to create.

Returns:

  • (Integer, nil) —

    size of volume (in GB) to create.



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

attribute :volume_size

#volume_type ⇒ String?

Returns Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS). “Standard” is the old EBS default and continues to remain the Ansible default for backwards compatibility.

Returns:

  • (String, nil) —

    Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS). “Standard” is the old EBS default and continues to remain the Ansible default for backwards compatibility.



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

attribute :volume_type

#zone ⇒ String?

Returns zone in which to create the volume, if unset uses the zone the instance is in (if set).

Returns:

  • (String, nil) —

    zone in which to create the volume, if unset uses the zone the instance is in (if set)



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

attribute :zone