Class: Ansible::Ruby::Modules::Ec2_ami_copy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/amazon/ec2_ami_copy.rb

Overview

Copies AMI from a source region to a destination region. This module has a dependency on python-boto >= 2.5

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

#description ⇒ String?

Returns An optional human-readable string describing the contents and purpose of the new AMI.

Returns:

  • (String, nil) —

    An optional human-readable string describing the contents and purpose of the new AMI.



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

attribute :description

#name ⇒ String?

Returns The name of the new image to copy.

Returns:

  • (String, nil) —

    The name of the new image to copy



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

attribute :name

#source_image_id ⇒ String

Returns the id of the image in source region that should be copied.

Returns:

  • (String) —

    the id of the image in source region that should be copied



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

attribute :source_image_id

#source_region ⇒ String

Returns the source region that AMI should be copied from.

Returns:

  • (String) —

    the source region that AMI should be copied from



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

attribute :source_region

#tags ⇒ Hash?

Returns a hash/dictionary of tags to add to the new copied AMI; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’.

Returns:

  • (Hash, nil) —

    a hash/dictionary of tags to add to the new copied AMI; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’



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

attribute :tags

#wait ⇒ :yes, ...

Returns wait for the copied AMI to be in state ‘available’ before returning.

Returns:

  • (:yes, :no, nil) —

    wait for the copied AMI to be in state ‘available’ before returning.



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

attribute :wait

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



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

attribute :wait_timeout