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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ec2_ami_copy

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

• #description ⇒ String^?

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

• #encrypted ⇒ Boolean^?

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

• #kms_key_id ⇒ String^?

  KMS key id used to encrypt image.

• #name ⇒ String^?

  The name of the new AMI to copy.

• #source_image_id ⇒ String

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

• #source_region ⇒ String

  The source region the AMI should be copied from.

• #tag_equality ⇒ Boolean^?

  Whether to use tags if the source AMI already exists in the target region.

• #tags ⇒ Hash^?

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

• #wait ⇒ :yes, ...

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

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

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^?

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

attribute :description

#encrypted ⇒ Boolean^?

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

attribute :encrypted

#kms_key_id ⇒ String^?

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

attribute :kms_key_id

#name ⇒ String^?

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

attribute :name

#source_image_id ⇒ String

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

attribute :source_image_id

#source_region ⇒ String

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

attribute :source_region

#tag_equality ⇒ Boolean^?

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

attribute :tag_equality

#tags ⇒ Hash^?

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

attribute :tags

#wait ⇒ :yes, ...

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

attribute :wait

#wait_timeout ⇒ Integer^?

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

attribute :wait_timeout