public static interface CopyImageRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>
| Modifier and Type | Method and Description |
|---|---|
CopyImageRequest.Builder |
clientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
CopyImageRequest.Builder |
description(String description)
A description for the new AMI in the destination Region.
|
CopyImageRequest.Builder |
encrypted(Boolean encrypted)
Specifies whether the destination snapshots of the copied image should be encrypted.
|
CopyImageRequest.Builder |
kmsKeyId(String kmsKeyId)
The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
creating encrypted volumes.
|
CopyImageRequest.Builder |
name(String name)
The name of the new AMI in the destination Region.
|
CopyImageRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CopyImageRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CopyImageRequest.Builder |
sourceImageId(String sourceImageId)
The ID of the AMI to copy.
|
CopyImageRequest.Builder |
sourceRegion(String sourceRegion)
The name of the Region that contains the AMI to copy.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCopyImageRequest.Builder clientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more
information, see How to Ensure
Idempotency in the Amazon Elastic Compute Cloud User Guide.CopyImageRequest.Builder description(String description)
A description for the new AMI in the destination Region.
description - A description for the new AMI in the destination Region.CopyImageRequest.Builder encrypted(Boolean encrypted)
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
CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using
KmsKeyId. For more information, see Amazon EBS Encryption in
the Amazon Elastic Compute Cloud User Guide.
encrypted - 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 CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS)
CMK using KmsKeyId. For more information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.CopyImageRequest.Builder kmsKeyId(String kmsKeyId)
The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you
specify a CMK, you must also set the encrypted state to true.
You can specify a CMK 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.
AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified CMK must exist in the destination Region.
Amazon EBS does not support asymmetric CMKs.
kmsKeyId - The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use
when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is
used. If you specify a CMK, you must also set the encrypted state to true.
You can specify a CMK 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.
AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified CMK must exist in the destination Region.
Amazon EBS does not support asymmetric CMKs.
CopyImageRequest.Builder name(String name)
The name of the new AMI in the destination Region.
name - The name of the new AMI in the destination Region.CopyImageRequest.Builder sourceImageId(String sourceImageId)
The ID of the AMI to copy.
sourceImageId - The ID of the AMI to copy.CopyImageRequest.Builder sourceRegion(String sourceRegion)
The name of the Region that contains the AMI to copy.
sourceRegion - The name of the Region that contains the AMI to copy.CopyImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCopyImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.