software.amazon.awssdk.services.ec2.model

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

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) An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume.
CopyImageRequest.Builder	name(String name) The name of the new AMI in the destination region.
CopyImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CopyImageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
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.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientToken

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

Parameters:

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.

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

CopyImageRequest.Builder kmsKeyId(String kmsKeyId)

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

• Key ID

• Key alias, in the form alias/ExampleAlias

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the region that the snapshot is being copied to.

Parameters:

kmsKeyId - An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

• Key ID

• Key alias, in the form alias/ExampleAlias

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the region that the snapshot is being copied to.

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.

overrideConfiguration

CopyImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CopyImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.