@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<CopySnapshotRequest>
NOOP
Constructor and Description |
---|
CopySnapshotRequest() |
Modifier and Type | Method and Description |
---|---|
CopySnapshotRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getDescription()
A description for the EBS snapshot.
|
String |
getDestinationOutpostArn()
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot.
|
String |
getDestinationRegion()
The destination Region to use in the
PresignedUrl parameter of a snapshot copy operation. |
Request<CopySnapshotRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
Boolean |
getEncrypted()
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using
this parameter.
|
String |
getKmsKeyId()
The identifier of the KMS key to use for Amazon EBS encryption.
|
String |
getPresignedUrl()
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL.
|
String |
getSourceRegion()
The ID of the Region that contains the snapshot to be copied.
|
String |
getSourceSnapshotId()
The ID of the EBS snapshot to copy.
|
List<TagSpecification> |
getTagSpecifications()
The tags to apply to the new snapshot.
|
int |
hashCode() |
Boolean |
isEncrypted()
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using
this parameter.
|
void |
setDescription(String description)
A description for the EBS snapshot.
|
void |
setDestinationOutpostArn(String destinationOutpostArn)
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot.
|
void |
setDestinationRegion(String destinationRegion)
The destination Region to use in the
PresignedUrl parameter of a snapshot copy operation. |
void |
setEncrypted(Boolean encrypted)
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using
this parameter.
|
void |
setKmsKeyId(String kmsKeyId)
The identifier of the KMS key to use for Amazon EBS encryption.
|
void |
setPresignedUrl(String presignedUrl)
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL.
|
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.
|
void |
setTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the new snapshot.
|
String |
toString()
Returns a string representation of this object.
|
CopySnapshotRequest |
withDescription(String description)
A description for the EBS snapshot.
|
CopySnapshotRequest |
withDestinationOutpostArn(String destinationOutpostArn)
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot.
|
CopySnapshotRequest |
withDestinationRegion(String destinationRegion)
The destination Region to use in the
PresignedUrl parameter of a snapshot copy operation. |
CopySnapshotRequest |
withEncrypted(Boolean encrypted)
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using
this parameter.
|
CopySnapshotRequest |
withKmsKeyId(String kmsKeyId)
The identifier of the KMS key to use for Amazon EBS encryption.
|
CopySnapshotRequest |
withPresignedUrl(String presignedUrl)
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL.
|
CopySnapshotRequest |
withSourceRegion(String sourceRegion)
The ID of the Region that contains the snapshot to be copied.
|
CopySnapshotRequest |
withSourceSnapshotId(String sourceSnapshotId)
The ID of the EBS snapshot to copy.
|
CopySnapshotRequest |
withTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the new snapshot.
|
CopySnapshotRequest |
withTagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the new snapshot.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDescription(String description)
A description for the EBS snapshot.
description
- A description for the EBS snapshot.public String getDescription()
A description for the EBS snapshot.
public CopySnapshotRequest withDescription(String description)
A description for the EBS snapshot.
description
- A description for the EBS snapshot.public void setDestinationOutpostArn(String destinationOutpostArn)
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
destinationOutpostArn
- The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter
when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the
Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one
Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
public String getDestinationOutpostArn()
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
public CopySnapshotRequest withDestinationOutpostArn(String destinationOutpostArn)
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
destinationOutpostArn
- The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter
when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the
Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one
Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
public void setDestinationRegion(String destinationRegion)
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 a PresignedUrl
parameter, where it
is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the CLI, this is specified using the --region
parameter or the default Region in your Amazon Web Services configuration file.
destinationRegion
- 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 a PresignedUrl
parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the CLI, this is specified using the --region
parameter or the default Region in your Amazon Web Services configuration file.
public String 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 a PresignedUrl
parameter, where it
is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the CLI, this is specified using the --region
parameter or the default Region in your Amazon Web Services configuration file.
PresignedUrl
parameter of a snapshot copy operation.
This parameter is only valid for specifying the destination Region in a PresignedUrl
parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the CLI, this is specified using the
--region
parameter or the default Region in your Amazon Web Services configuration file.
public CopySnapshotRequest withDestinationRegion(String destinationRegion)
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 a PresignedUrl
parameter, where it
is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the CLI, this is specified using the --region
parameter or the default Region in your Amazon Web Services configuration file.
destinationRegion
- 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 a PresignedUrl
parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the CLI, this is specified using the --region
parameter or the default Region in your Amazon Web Services configuration file.
public void setEncrypted(Boolean encrypted)
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
encrypted
- To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption
using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit
this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more
information, see Amazon EBS
encryption in the Amazon EBS User Guide.public Boolean getEncrypted()
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
public CopySnapshotRequest withEncrypted(Boolean encrypted)
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
encrypted
- To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption
using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit
this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more
information, see Amazon EBS
encryption in the Amazon EBS User Guide.public Boolean isEncrypted()
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
public void setKmsKeyId(String kmsKeyId)
The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key
for Amazon EBS is used. If KmsKeyId
is specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
kmsKeyId
- The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your
KMS key for Amazon EBS is used. If KmsKeyId
is specified, the encrypted state must be
true
.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
public String getKmsKeyId()
The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key
for Amazon EBS is used. If KmsKeyId
is specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
KmsKeyId
is specified, the encrypted state must be
true
.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
public CopySnapshotRequest withKmsKeyId(String kmsKeyId)
The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key
for Amazon EBS is used. If KmsKeyId
is specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
kmsKeyId
- The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your
KMS key for Amazon EBS is used. If KmsKeyId
is specified, the encrypted state must be
true
.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
public void setPresignedUrl(String presignedUrl)
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and
include the SourceRegion
, SourceSnapshotId
, and DestinationRegion
parameters. The PresignedUrl
must be signed using Amazon Web Services 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: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3
API Reference. An invalid or improperly signed PresignedUrl
will cause the copy operation to
fail asynchronously, and the snapshot will move to an error
state.
presignedUrl
- When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed
URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and include the SourceRegion
, SourceSnapshotId
, and
DestinationRegion
parameters. The PresignedUrl
must be signed using Amazon Web
Services 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: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 API
Reference. An invalid or improperly signed PresignedUrl
will cause the copy operation to
fail asynchronously, and the snapshot will move to an error
state.
public String getPresignedUrl()
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and
include the SourceRegion
, SourceSnapshotId
, and DestinationRegion
parameters. The PresignedUrl
must be signed using Amazon Web Services 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: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3
API Reference. An invalid or improperly signed PresignedUrl
will cause the copy operation to
fail asynchronously, and the snapshot will move to an error
state.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and include the SourceRegion
, SourceSnapshotId
, and
DestinationRegion
parameters. The PresignedUrl
must be signed using Amazon Web
Services 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: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 API
Reference. An invalid or improperly signed PresignedUrl
will cause the copy operation to
fail asynchronously, and the snapshot will move to an error
state.
public CopySnapshotRequest withPresignedUrl(String presignedUrl)
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and
include the SourceRegion
, SourceSnapshotId
, and DestinationRegion
parameters. The PresignedUrl
must be signed using Amazon Web Services 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: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3
API Reference. An invalid or improperly signed PresignedUrl
will cause the copy operation to
fail asynchronously, and the snapshot will move to an error
state.
presignedUrl
- When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed
URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and include the SourceRegion
, SourceSnapshotId
, and
DestinationRegion
parameters. The PresignedUrl
must be signed using Amazon Web
Services 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: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 API
Reference. An invalid or improperly signed PresignedUrl
will cause the copy operation to
fail asynchronously, and the snapshot will move to an error
state.
public void setSourceRegion(String sourceRegion)
The ID of the Region that contains the snapshot to be copied.
sourceRegion
- The ID of the Region that contains the snapshot to be copied.public String getSourceRegion()
The ID of the Region that contains the snapshot to be copied.
public CopySnapshotRequest withSourceRegion(String sourceRegion)
The ID of the Region that contains the snapshot to be copied.
sourceRegion
- The ID of the Region that contains the snapshot to be copied.public void setSourceSnapshotId(String sourceSnapshotId)
The ID of the EBS snapshot to copy.
sourceSnapshotId
- The ID of the EBS snapshot to copy.public String getSourceSnapshotId()
The ID of the EBS snapshot to copy.
public CopySnapshotRequest withSourceSnapshotId(String sourceSnapshotId)
The ID of the EBS snapshot to copy.
sourceSnapshotId
- The ID of the EBS snapshot to copy.public List<TagSpecification> getTagSpecifications()
The tags to apply to the new snapshot.
public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the new snapshot.
tagSpecifications
- The tags to apply to the new snapshot.public CopySnapshotRequest withTagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the new snapshot.
NOTE: This method appends the values to the existing list (if any). Use
setTagSpecifications(java.util.Collection)
or withTagSpecifications(java.util.Collection)
if
you want to override the existing values.
tagSpecifications
- The tags to apply to the new snapshot.public CopySnapshotRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the new snapshot.
tagSpecifications
- The tags to apply to the new snapshot.public Request<CopySnapshotRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<CopySnapshotRequest>
public String toString()
toString
in class Object
Object.toString()
public CopySnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()