Class: Ansible::Ruby::Modules::Ec2_snapshot_copy

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

Overview

Copies an EC2 Snapshot from a source region to a destination region.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#description ⇒ Object?

Returns An optional human-readable string describing purpose of the new Snapshot.

Returns:

  • (Object, nil) —

    An optional human-readable string describing purpose of the new Snapshot.



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

attribute :description

#encrypted ⇒ :yes, ...

Returns Whether or not the destination Snapshot should be encrypted.

Returns:

  • (:yes, :no, nil) —

    Whether or not the destination Snapshot should be encrypted.



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

attribute :encrypted

#kms_key_id ⇒ String?

Returns KMS key id used to encrypt snapshot. If not specified, defaults to EBS Customer Master Key (CMK) for that account.

Returns:

  • (String, nil) —

    KMS key id used to encrypt snapshot. If not specified, defaults to EBS Customer Master Key (CMK) for that account.



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

attribute :kms_key_id

#source_region ⇒ String

Returns The source region the Snapshot should be copied from.

Returns:

  • (String) —

    The source region the Snapshot should be copied from.



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

attribute :source_region

#source_snapshot_id ⇒ String

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

Returns:

  • (String) —

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



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

attribute :source_snapshot_id

#tags ⇒ Hash?

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

Returns:

  • (Hash, nil) —

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



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

attribute :tags

#wait ⇒ :yes, ...

Returns Wait for the copied Snapshot to be in ‘Available’ state before returning.

Returns:

  • (:yes, :no, nil) —

    Wait for the copied Snapshot to be in ‘Available’ state before returning.



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

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.



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

attribute :wait_timeout