Class CopyImageRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.CopyImageRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<CopyImageRequest>
,Serializable
,Cloneable
public class CopyImageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<CopyImageRequest>
Contains the parameters for CopyImage.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CopyImageRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CopyImageRequest
clone()
Creates a shallow clone of this request.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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
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.
-
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.
-
withSourceRegion
public CopyImageRequest withSourceRegion(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.
-
setSourceImageId
public void setSourceImageId(String sourceImageId)
The ID of the AMI to copy.
- Parameters:
sourceImageId
- The ID of the AMI to copy.
-
getSourceImageId
public String getSourceImageId()
The ID of the AMI to copy.
- Returns:
- The ID of the AMI to copy.
-
withSourceImageId
public CopyImageRequest withSourceImageId(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.
-
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.
-
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.
-
withName
public CopyImageRequest withName(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.
-
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.
-
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.
-
withDescription
public CopyImageRequest withDescription(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.
-
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.
-
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.
-
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.
- 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.
-
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 withKmsKeyId
. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
-
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.
-
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.- 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 withKmsKeyId
. 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.
-
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.
-
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, thekey
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 aKmsKeyId
is specified, theEncrypted
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 thearn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, thekey
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 aKmsKeyId
is specified, theEncrypted
flag must also be set.
-
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, thekey
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 aKmsKeyId
is specified, theEncrypted
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, thekey
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 aKmsKeyId
is specified, theEncrypted
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, thekey
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 aKmsKeyId
is specified, theEncrypted
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 thearn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, thekey
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 aKmsKeyId
is specified, theEncrypted
flag must also be set.- Returns:
- Returns a reference to this 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 interfaceDryRunSupportedRequest<CopyImageRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CopyImageRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-