Interface CreateSnapshotRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>
,Ec2Request.Builder
,SdkBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CreateSnapshotRequest
public static interface CreateSnapshotRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateSnapshotRequest.Builder
description(String description)
A description for the snapshot.CreateSnapshotRequest.Builder
dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.CreateSnapshotRequest.Builder
outpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.CreateSnapshotRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateSnapshotRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateSnapshotRequest.Builder
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the snapshot during creation.CreateSnapshotRequest.Builder
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the snapshot during creation.CreateSnapshotRequest.Builder
tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the snapshot during creation.CreateSnapshotRequest.Builder
volumeId(String volumeId)
The ID of the Amazon EBS volume.-
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
CreateSnapshotRequest.Builder description(String description)
A description for the snapshot.
- Parameters:
description
- A description for the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outpostArn
CreateSnapshotRequest.Builder outpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
-
To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.
-
To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.
-
To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.
For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
- Parameters:
outpostArn
- The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.-
To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.
-
To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.
-
To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.
For more information, see Create local snapshots from volumes on 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.
-
-
volumeId
CreateSnapshotRequest.Builder volumeId(String volumeId)
The ID of the Amazon EBS volume.
- Parameters:
volumeId
- The ID of the Amazon EBS volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CreateSnapshotRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the snapshot during creation.
- Parameters:
tagSpecifications
- The tags to apply to the snapshot during creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CreateSnapshotRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the snapshot during creation.
- Parameters:
tagSpecifications
- The tags to apply to the snapshot during creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CreateSnapshotRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the snapshot during creation.
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
CreateSnapshotRequest.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
CreateSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-