ec2/aws.sdk.kotlin.services.ec2.model/CopyImageRequest/Builder

Builder

Properties

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

copyImageTags

var copyImageTags: Boolean?

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

description

var description: String?

A description for the new AMI in the destination Region.

destinationOutpostArn

var destinationOutpostArn: 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.

dryRun

var dryRun: 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.

encrypted

var 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.

kmsKeyId

var kmsKeyId: 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.

name

var name: String?

The name of the new AMI in the destination Region.

snapshotCopyCompletionDurationMinutes

var snapshotCopyCompletionDurationMinutes: Long?

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, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target.

sourceImageId

var sourceImageId: String?

The ID of the AMI to copy.

sourceRegion

var sourceRegion: String?

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

tagSpecifications

var tagSpecifications: List<TagSpecification>?

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