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

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

Overview

Copies AMI from a source region to a destination region. B(Since version 2.3 this module depends on boto3.)

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.



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

attribute :description

#encrypted ⇒ Boolean?

Returns Whether or not the destination snapshots of the copied AMI should be encrypted.

Returns:

  • (Boolean, nil) —

    Whether or not the destination snapshots of the copied AMI should be encrypted.



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

attribute :encrypted

#kms_key_id ⇒ String?

Returns KMS key id used to encrypt image. If not specified, uses default EBS Customer Master Key (CMK) for your account.

Returns:

  • (String, nil) —

    KMS key id used to encrypt image. If not specified, uses default EBS Customer Master Key (CMK) for your account.



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

attribute :kms_key_id

#name ⇒ String?

Returns The name of the new AMI to copy. (As of 2.3 the default is ‘default’, in prior versions it was ‘null’.).

Returns:

  • (String, nil) —

    The name of the new AMI to copy. (As of 2.3 the default is ‘default’, in prior versions it was ‘null’.)



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

attribute :name

#source_image_id ⇒ String

Returns The ID of the AMI in source region that should be copied.

Returns:

  • (String) —

    The ID of the AMI in source region that should be copied.



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

attribute :source_image_id

#source_region ⇒ String

Returns The source region the AMI should be copied from.

Returns:

  • (String) —

    The source region the AMI should be copied from.



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

attribute :source_region

#tag_equality ⇒ Boolean?

Returns Whether to use tags if the source AMI already exists in the target region. If this is set, and all tags match in an existing AMI, the AMI will not be copied again.

Returns:

  • (Boolean, nil) —

    Whether to use tags if the source AMI already exists in the target region. If this is set, and all tags match in an existing AMI, the AMI will not be copied again.



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

attribute :tag_equality

#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”’



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

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.



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

attribute :wait

#wait_timeout ⇒ Integer?

Returns How long before wait gives up, in seconds. Prior to 2.3 the default was 1200.,From 2.3-2.5 this option was deprecated in favor of boto3 waiter defaults. This was reenabled in 2.6 to allow timeouts greater than 10 minutes.

Returns:

  • (Integer, nil) —

    How long before wait gives up, in seconds. Prior to 2.3 the default was 1200.,From 2.3-2.5 this option was deprecated in favor of boto3 waiter defaults. This was reenabled in 2.6 to allow timeouts greater than 10 minutes.



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

attribute :wait_timeout