Class CopySnapshotRequest
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<CopySnapshotRequest>
,Serializable
,Cloneable
Contains the parameters for CopySnapshot.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A description for the EBS snapshot.The destination region to use in thePresignedUrl
parameter of a snapshot copy operation.This method is intended for internal use only.Specifies whether the destination snapshot should be encrypted.The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.The pre-signed URL that facilitates copying an encrypted snapshot.The ID of the region that contains the snapshot to be copied.The ID of the EBS snapshot to copy.int
hashCode()
Specifies whether the destination snapshot should be encrypted.void
setDescription
(String description) A description for the EBS snapshot.void
setDestinationRegion
(String destinationRegion) The destination region to use in thePresignedUrl
parameter of a snapshot copy operation.void
setEncrypted
(Boolean encrypted) Specifies whether the destination snapshot should be encrypted.void
setKmsKeyId
(String kmsKeyId) The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.void
setPresignedUrl
(String presignedUrl) The pre-signed URL that facilitates copying an encrypted snapshot.void
setSourceRegion
(String sourceRegion) The ID of the region that contains the snapshot to be copied.void
setSourceSnapshotId
(String sourceSnapshotId) The ID of the EBS snapshot to copy.toString()
Returns a string representation of this object; useful for testing and debugging.withDescription
(String description) A description for the EBS snapshot.withDestinationRegion
(String destinationRegion) The destination region to use in thePresignedUrl
parameter of a snapshot copy operation.withEncrypted
(Boolean encrypted) Specifies whether the destination snapshot should be encrypted.withKmsKeyId
(String kmsKeyId) The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.withPresignedUrl
(String presignedUrl) The pre-signed URL that facilitates copying an encrypted snapshot.withSourceRegion
(String sourceRegion) The ID of the region that contains the snapshot to be copied.withSourceSnapshotId
(String sourceSnapshotId) The ID of the EBS snapshot 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
-
Constructor Details
-
CopySnapshotRequest
public CopySnapshotRequest()
-
-
Method Details
-
setSourceRegion
The ID of the region that contains the snapshot to be copied.
- Parameters:
sourceRegion
- The ID of the region that contains the snapshot to be copied.
-
getSourceRegion
The ID of the region that contains the snapshot to be copied.
- Returns:
- The ID of the region that contains the snapshot to be copied.
-
withSourceRegion
The ID of the region that contains the snapshot to be copied.
- Parameters:
sourceRegion
- The ID of the region that contains the snapshot to be copied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceSnapshotId
The ID of the EBS snapshot to copy.
- Parameters:
sourceSnapshotId
- The ID of the EBS snapshot to copy.
-
getSourceSnapshotId
The ID of the EBS snapshot to copy.
- Returns:
- The ID of the EBS snapshot to copy.
-
withSourceSnapshotId
The ID of the EBS snapshot to copy.
- Parameters:
sourceSnapshotId
- The ID of the EBS snapshot to copy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
A description for the EBS snapshot.
- Parameters:
description
- A description for the EBS snapshot.
-
getDescription
A description for the EBS snapshot.
- Returns:
- A description for the EBS snapshot.
-
withDescription
A description for the EBS snapshot.
- Parameters:
description
- A description for the EBS snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDestinationRegion
The destination region to use in the
PresignedUrl
parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in aPresignedUrl
parameter, where it is required.CopySnapshot
sends the snapshot copy to the regional endpoint that you send the HTTP request to, such asec2.us-east-1.amazonaws.com
(in the AWS CLI, this is specified with the--region
parameter or the default region in your AWS configuration file).- Parameters:
destinationRegion
- The destination region to use in thePresignedUrl
parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in aPresignedUrl
parameter, where it is required.CopySnapshot
sends the snapshot copy to the regional endpoint that you send the HTTP request to, such asec2.us-east-1.amazonaws.com
(in the AWS CLI, this is specified with the--region
parameter or the default region in your AWS configuration file).
-
getDestinationRegion
The destination region to use in the
PresignedUrl
parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in aPresignedUrl
parameter, where it is required.CopySnapshot
sends the snapshot copy to the regional endpoint that you send the HTTP request to, such asec2.us-east-1.amazonaws.com
(in the AWS CLI, this is specified with the--region
parameter or the default region in your AWS configuration file).- Returns:
- The destination region to use in the
PresignedUrl
parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in aPresignedUrl
parameter, where it is required.CopySnapshot
sends the snapshot copy to the regional endpoint that you send the HTTP request to, such asec2.us-east-1.amazonaws.com
(in the AWS CLI, this is specified with the--region
parameter or the default region in your AWS configuration file).
-
withDestinationRegion
The destination region to use in the
PresignedUrl
parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in aPresignedUrl
parameter, where it is required.CopySnapshot
sends the snapshot copy to the regional endpoint that you send the HTTP request to, such asec2.us-east-1.amazonaws.com
(in the AWS CLI, this is specified with the--region
parameter or the default region in your AWS configuration file).- Parameters:
destinationRegion
- The destination region to use in thePresignedUrl
parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in aPresignedUrl
parameter, where it is required.CopySnapshot
sends the snapshot copy to the regional endpoint that you send the HTTP request to, such asec2.us-east-1.amazonaws.com
(in the AWS CLI, this is specified with the--region
parameter or the default region in your AWS configuration file).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPresignedUrl
The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The
PresignedUrl
should use the snapshot source endpoint, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signedPresignedUrl
will cause the copy operation to fail asynchronously, and the snapshot will move to anerror
state.- Parameters:
presignedUrl
- The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. ThePresignedUrl
should use the snapshot source endpoint, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signedPresignedUrl
will cause the copy operation to fail asynchronously, and the snapshot will move to anerror
state.
-
getPresignedUrl
The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The
PresignedUrl
should use the snapshot source endpoint, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signedPresignedUrl
will cause the copy operation to fail asynchronously, and the snapshot will move to anerror
state.- Returns:
- The pre-signed URL that facilitates copying an encrypted
snapshot. This parameter is only required when copying an
encrypted snapshot with the Amazon EC2 Query API; it is available
as an optional parameter in all other cases. The
PresignedUrl
should use the snapshot source endpoint, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signedPresignedUrl
will cause the copy operation to fail asynchronously, and the snapshot will move to anerror
state.
-
withPresignedUrl
The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The
PresignedUrl
should use the snapshot source endpoint, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signedPresignedUrl
will cause the copy operation to fail asynchronously, and the snapshot will move to anerror
state.- Parameters:
presignedUrl
- The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. ThePresignedUrl
should use the snapshot source endpoint, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signedPresignedUrl
will cause the copy operation to fail asynchronously, and the snapshot will move to anerror
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEncrypted
Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. 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 snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. 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
Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. 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 snapshot should be encrypted.
There is no way to create an unencrypted snapshot copy from an
encrypted snapshot; however, you can encrypt a copy of an
unencrypted snapshot with this flag. 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
Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. 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 snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. 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
Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. 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 snapshot should be encrypted.
There is no way to create an unencrypted snapshot copy from an
encrypted snapshot; however, you can encrypt a copy of an
unencrypted snapshot with this flag. 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
The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. 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 creating the snapshot copy. 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
The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. 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 creating the snapshot copy. 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
The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. 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 creating the snapshot copy. 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
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<CopySnapshotRequest>
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-