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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CopyImageRequest data as a hash:

{
  client_token: "String",
  description: "String",
  encrypted: false,
  kms_key_id: "KmsKeyId",
  name: "String", # required
  source_image_id: "String", # required
  source_region: "String", # required
  destination_outpost_arn: "String",
  dry_run: false,
}

Contains the parameters for CopyImage.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

Returns:

  • (String)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#descriptionString

A description for the new AMI in the destination Region.

Returns:

  • (String)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#destination_outpost_arnString

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 Copying AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#dry_runBoolean

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)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#encryptedBoolean

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 Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Boolean)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#kms_key_idString

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)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#nameString

The name of the new AMI in the destination Region.

Returns:

  • (String)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#source_image_idString

The ID of the AMI to copy.

Returns:

  • (String)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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

#source_regionString

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

Returns:

  • (String)


5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5375

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