Class: Aws::EC2::Types::CopyImageRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CopyImageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Contains the parameters for CopyImage.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier you provide to ensure idempotency of the request.

• #copy_image_tags ⇒ Boolean

  Indicates whether to include your user-defined AMI tags when copying the AMI.

• #description ⇒ String

  A description for the new AMI in the destination Region.

• #destination_outpost_arn ⇒ String

  The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #encrypted ⇒ Boolean

  Specifies whether the destination snapshots of the copied image should be encrypted.

• #kms_key_id ⇒ String

  The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes.

• #name ⇒ String

  The name of the new AMI in the destination Region.

• #snapshot_copy_completion_duration_minutes ⇒ Integer

  Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy.

• #source_image_id ⇒ String

  The ID of the AMI to copy.

• #source_region ⇒ String

  The name of the Region that contains the AMI to copy.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the new AMI and new snapshots.

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see [Ensuring idempotency] in the *Amazon EC2 API Reference*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#copy_image_tags ⇒ Boolean

Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with ‘aws:`)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the new AMI in the destination Region.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#destination_outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see [Copy AMIs from an Amazon Web Services Region to an Outpost] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-amis

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using ‘KmsKeyId`. For more information, see [Use encryption with EBS-backed AMIs] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to ‘true`.

You can specify a KMS key using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the new AMI in the destination Region.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_copy_completion_duration_minutes ⇒ Integer

Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, regardless of their size.

If you do not specify a value, the AMI copy operation is completed on a best-effort basis.

For more information, see [ Time-based copies].

[1]: docs.aws.amazon.com/ebs/latest/userguide/time-based-copies.html

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#source_image_id ⇒ String

The ID of the AMI to copy.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#source_region ⇒ String

The name of the Region that contains the AMI to copy.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ‘ResourceType` must be `image`.

• To tag the new snapshots, the value for ‘ResourceType` must be `snapshot`. The same tag is applied to all the new snapshots.

If you specify other values for ‘ResourceType`, the request fails.

To tag an AMI or snapshot after it has been created, see [CreateTags].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 7222

class CopyImageRequest < Struct.new(
  :client_token,
  :description,
  :encrypted,
  :kms_key_id,
  :name,
  :source_image_id,
  :source_region,
  :destination_outpost_arn,
  :copy_image_tags,
  :tag_specifications,
  :snapshot_copy_completion_duration_minutes,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end