public static interface CopySnapshotRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>
Modifier and Type | Method and Description |
---|---|
CopySnapshotRequest.Builder |
description(String description)
A description for the EBS snapshot.
|
CopySnapshotRequest.Builder |
destinationRegion(String destinationRegion)
The destination region to use in the
PresignedUrl parameter of a snapshot copy operation. |
CopySnapshotRequest.Builder |
encrypted(Boolean encrypted)
Specifies whether the destination snapshot should be encrypted.
|
CopySnapshotRequest.Builder |
kmsKeyId(String kmsKeyId)
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted volume.
|
CopySnapshotRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CopySnapshotRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CopySnapshotRequest.Builder |
presignedUrl(String presignedUrl)
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL.
|
CopySnapshotRequest.Builder |
sourceRegion(String sourceRegion)
The ID of the region that contains the snapshot to be copied.
|
CopySnapshotRequest.Builder |
sourceSnapshotId(String sourceSnapshotId)
The ID of the EBS snapshot to copy.
|
build
overrideConfiguration
copy
applyMutation, build
CopySnapshotRequest.Builder description(String description)
A description for the EBS snapshot.
description
- A description for the EBS snapshot.CopySnapshotRequest.Builder destinationRegion(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 AWS CLI, this is specified using the
--region
parameter or the default region in your AWS 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 AWS CLI, this is specified using the
--region
parameter or the default region in your AWS configuration file.
CopySnapshotRequest.Builder encrypted(Boolean encrypted)
Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted
snapshot, but you cannot use it to create an unencrypted copy of an encrypted snapshot. Your default CMK for
EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using
KmsKeyId
. For more information, see Amazon EBS Encryption in the
Amazon Elastic Compute Cloud User Guide.
encrypted
- Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an
unencrypted snapshot, but you cannot use it to create an unencrypted copy of an encrypted snapshot.
Your default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS)
CMK using KmsKeyId
. For more information, see Amazon EBS Encryption
in the Amazon Elastic Compute Cloud User Guide.CopySnapshotRequest.Builder kmsKeyId(String kmsKeyId)
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted volume. 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. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID 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.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of
the CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For
example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. The action will eventually fail.
kmsKeyId
- An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
creating the encrypted volume. 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. If a KmsKeyId
is
specified, the Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID 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.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the
region of the CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the
CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to
complete even though you provided an invalid identifier. The action will eventually fail.
CopySnapshotRequest.Builder presignedUrl(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 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 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 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 signed PresignedUrl
will cause the
copy operation to fail asynchronously, and the snapshot will move to an error
state.
CopySnapshotRequest.Builder sourceRegion(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.CopySnapshotRequest.Builder sourceSnapshotId(String sourceSnapshotId)
The ID of the EBS snapshot to copy.
sourceSnapshotId
- The ID of the EBS snapshot to copy.CopySnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CopySnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.