Interface CopyImageRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>
,Ec2Request.Builder
,SdkBuilder<CopyImageRequest.Builder,CopyImageRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CopyImageRequest
public static interface CopyImageRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CopyImageRequest.Builder
clientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.CopyImageRequest.Builder
copyImageTags(Boolean copyImageTags)
Indicates whether to include your user-defined AMI tags when copying the AMI.CopyImageRequest.Builder
description(String description)
A description for the new AMI in the destination Region.CopyImageRequest.Builder
destinationOutpostArn(String destinationOutpostArn)
The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI.CopyImageRequest.Builder
dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.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 Key Management Service (KMS) KMS key to use when creating encrypted volumes.CopyImageRequest.Builder
name(String name)
The name of the new AMI in the destination Region.CopyImageRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CopyImageRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
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.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
clientToken
CopyImageRequest.Builder clientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- Parameters:
clientToken
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
description
CopyImageRequest.Builder description(String description)
A description for the new AMI in the destination Region.
- Parameters:
description
- A description for the new AMI in the destination Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encrypted
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 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 EC2 User Guide.- Parameters:
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 KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key usingKmsKeyId
. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
CopyImageRequest.Builder kmsKeyId(String kmsKeyId)
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.
- Parameters:
kmsKeyId
- 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 totrue
.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:
- Returns a reference to this object so that method calls can be chained together.
-
-
name
CopyImageRequest.Builder name(String name)
The name of the new AMI in the destination Region.
- Parameters:
name
- The name of the new AMI in the destination Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceImageId
CopyImageRequest.Builder sourceImageId(String sourceImageId)
The ID of the AMI to copy.
- Parameters:
sourceImageId
- The ID of the AMI to copy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceRegion
CopyImageRequest.Builder sourceRegion(String sourceRegion)
The name of the Region that contains the AMI to copy.
- Parameters:
sourceRegion
- The name of the Region that contains the AMI to copy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationOutpostArn
CopyImageRequest.Builder destinationOutpostArn(String destinationOutpostArn)
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 EC2 User Guide.
- Parameters:
destinationOutpostArn
- 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 EC2 User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dryRun
CopyImageRequest.Builder dryRun(Boolean dryRun)
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 isUnauthorizedOperation
.- Parameters:
dryRun
- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
copyImageTags
CopyImageRequest.Builder copyImageTags(Boolean copyImageTags)
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.
- Parameters:
copyImageTags
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
CopyImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CopyImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-