com.amazonaws.services.ec2.model

Class CopyImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CopyImageRequest

All Implemented Interfaces:

DryRunSupportedRequest<CopyImageRequest>, Serializable, Cloneable

public class CopyImageRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<CopyImageRequest>

Container for the parameters to the CopyImage operation.

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.copyImage(CopyImageRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CopyImageRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	getDescription() A description for the new AMI in the destination region.
Request<CopyImageRequest>	getDryRunRequest() This method is intended for internal use only.
Boolean	getEncrypted() Specifies whether the destination snapshots of the copied image should be encrypted.
String	getKmsKeyId() 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	getName() The name of the new AMI in the destination region.
String	getSourceImageId() The ID of the AMI to copy.
String	getSourceRegion() The name of the region that contains the AMI to copy.
int	hashCode()
Boolean	isEncrypted() Specifies whether the destination snapshots of the copied image should be encrypted.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
void	setDescription(String description) A description for the new AMI in the destination region.
void	setEncrypted(Boolean encrypted) Specifies whether the destination snapshots of the copied image should be encrypted.
void	setKmsKeyId(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.
void	setName(String name) The name of the new AMI in the destination region.
void	setSourceImageId(String sourceImageId) The ID of the AMI to copy.
void	setSourceRegion(String sourceRegion) The name of the region that contains the AMI to copy.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CopyImageRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
CopyImageRequest	withDescription(String description) A description for the new AMI in the destination region.
CopyImageRequest	withEncrypted(Boolean encrypted) Specifies whether the destination snapshots of the copied image should be encrypted.
CopyImageRequest	withKmsKeyId(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.
CopyImageRequest	withName(String name) The name of the new AMI in the destination region.
CopyImageRequest	withSourceImageId(String sourceImageId) The ID of the AMI to copy.
CopyImageRequest	withSourceRegion(String sourceRegion) The name of the region that contains the AMI to copy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyImageRequest

public CopyImageRequest()

Method Detail

getSourceRegion

public String getSourceRegion()

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

Returns:

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

setSourceRegion

public void setSourceRegion(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.

withSourceRegion

public CopyImageRequest withSourceRegion(String sourceRegion)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceImageId

public String getSourceImageId()

The ID of the AMI to copy.

Returns:

The ID of the AMI to copy.

setSourceImageId

public void setSourceImageId(String sourceImageId)

The ID of the AMI to copy.

Parameters:

sourceImageId - The ID of the AMI to copy.

withSourceImageId

public CopyImageRequest withSourceImageId(String sourceImageId)

The ID of the AMI to copy.

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

Parameters:

sourceImageId - The ID of the AMI to copy.

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public String getName()

The name of the new AMI in the destination region.

Returns:

The name of the new AMI in the destination region.

setName

public void setName(String name)

The name of the new AMI in the destination region.

Parameters:

name - The name of the new AMI in the destination region.

withName

public CopyImageRequest withName(String name)

The name of the new AMI in the destination region.

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

Parameters:

name - The name of the new AMI in the destination region.

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()

A description for the new AMI in the destination region.

Returns:

A description for the new AMI in the destination region.

setDescription

public void setDescription(String description)

A description for the new AMI in the destination region.

Parameters:

description - A description for the new AMI in the destination region.

withDescription

public CopyImageRequest withDescription(String description)

A description for the new AMI in the destination region.

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

Parameters:

description - A description for the new AMI in the destination region.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public String getClientToken()

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.

setClientToken

public void setClientToken(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.

withClientToken

public CopyImageRequest withClientToken(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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

isEncrypted

public Boolean isEncrypted()

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.

setEncrypted

public void setEncrypted(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.

Parameters:

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.

withEncrypted

public CopyImageRequest withEncrypted(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getEncrypted

public Boolean getEncrypted()

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.

getKmsKeyId

public String getKmsKeyId()

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.

setKmsKeyId

public void setKmsKeyId(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.

Parameters:

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.

withKmsKeyId

public CopyImageRequest withKmsKeyId(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<CopyImageRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CopyImageRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object