Interface CopySnapshotRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>
,Ec2Request.Builder
,SdkBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CopySnapshotRequest
public static interface CopySnapshotRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CopySnapshotRequest.Builder
description(String description)
A description for the EBS snapshot.CopySnapshotRequest.Builder
destinationOutpostArn(String destinationOutpostArn)
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot.CopySnapshotRequest.Builder
destinationRegion(String destinationRegion)
The destination Region to use in thePresignedUrl
parameter of a snapshot copy operation.CopySnapshotRequest.Builder
dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.CopySnapshotRequest.Builder
encrypted(Boolean encrypted)
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.CopySnapshotRequest.Builder
kmsKeyId(String kmsKeyId)
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.CopySnapshotRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CopySnapshotRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
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.CopySnapshotRequest.Builder
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the new snapshot.CopySnapshotRequest.Builder
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the new snapshot.CopySnapshotRequest.Builder
tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the new snapshot.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
description
CopySnapshotRequest.Builder description(String description)
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.
-
destinationOutpostArn
CopySnapshotRequest.Builder destinationOutpostArn(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 Elastic Compute Cloud User Guide.
- Parameters:
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 Elastic Compute Cloud User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationRegion
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 aPresignedUrl
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.- 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.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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encrypted
CopySnapshotRequest.Builder encrypted(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 Elastic Compute Cloud User Guide.
- Parameters:
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 Elastic Compute Cloud User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
CopySnapshotRequest.Builder kmsKeyId(String kmsKeyId)
The identifier of the Key Management Service (KMS) 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 betrue
.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.
- Parameters:
kmsKeyId
- The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. IfKmsKeyId
is specified, the encrypted state must betrue
.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
presignedUrl
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, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
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 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
- 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, theCopySnapshot
action, and include theSourceRegion
,SourceSnapshotId
, andDestinationRegion
parameters. ThePresignedUrl
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 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.
-
sourceRegion
CopySnapshotRequest.Builder sourceRegion(String sourceRegion)
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.
-
sourceSnapshotId
CopySnapshotRequest.Builder sourceSnapshotId(String sourceSnapshotId)
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.
-
tagSpecifications
CopySnapshotRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the new snapshot.
- Parameters:
tagSpecifications
- The tags to apply to the new snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CopySnapshotRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the new snapshot.
- Parameters:
tagSpecifications
- The tags to apply to the new snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CopySnapshotRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the new snapshot.
This is a convenience method that creates an instance of theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tagSpecifications(List
.) - Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tagSpecifications(java.util.Collection
)
-
dryRun
CopySnapshotRequest.Builder dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Parameters:
dryRun
- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CopySnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CopySnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-