software.amazon.awssdk.services.ec2.model

Class CopyImageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.core.AwsRequest

software.amazon.awssdk.services.ec2.model.EC2Request

software.amazon.awssdk.services.ec2.model.CopyImageRequest

All Implemented Interfaces:

software.amazon.awssdk.utils.builder.ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class CopyImageRequest
extends EC2Request
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>

Contains the parameters for CopyImage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CopyImageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CopyImageRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	description() A description for the new AMI in the destination region.
Boolean	encrypted() Specifies whether the destination snapshots of the copied image should be encrypted.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId() The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation.
String	name() The name of the new AMI in the destination region.
static Class<? extends CopyImageRequest.Builder>	serializableBuilderClass()
String	sourceImageId() The ID of the AMI to copy.
String	sourceRegion() The name of the region that contains the AMI to copy.
CopyImageRequest.Builder	toBuilder()
String	toString()

Methods inherited from class software.amazon.awssdk.core.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clientToken

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

Returns:

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.

description

public String description()

A description for the new AMI in the destination region.

Returns:

A description for the new AMI in the destination region.

encrypted

public Boolean encrypted()

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Returns:

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

kmsKeyId

public String kmsKeyId()

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

Returns:

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

name

public String name()

The name of the new AMI in the destination region.

Returns:

The name of the new AMI in the destination region.

sourceImageId

public String sourceImageId()

The ID of the AMI to copy.

Returns:

The ID of the AMI to copy.

sourceRegion

public String sourceRegion()

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

Returns:

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

toBuilder

public CopyImageRequest.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>

Specified by:

toBuilder in class EC2Request

builder

public static CopyImageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CopyImageRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest