Interface CopyVolumesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CopyVolumesRequest.Builder,CopyVolumesRequest>,Ec2Request.Builder,SdkBuilder<CopyVolumesRequest.Builder,CopyVolumesRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CopyVolumesRequest
@Mutable @NotThreadSafe public static interface CopyVolumesRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CopyVolumesRequest.Builder,CopyVolumesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CopyVolumesRequest.BuilderclientToken(String clientToken)Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.CopyVolumesRequest.BuilderdryRun(Boolean dryRun)Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.CopyVolumesRequest.Builderiops(Integer iops)The number of I/O operations per second (IOPS) to provision for the volume copy.CopyVolumesRequest.BuildermultiAttachEnabled(Boolean multiAttachEnabled)Indicates whether to enable Amazon EBS Multi-Attach for the volume copy.CopyVolumesRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CopyVolumesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CopyVolumesRequest.Buildersize(Integer size)The size of the volume copy, in GiBs.CopyVolumesRequest.BuildersourceVolumeId(String sourceVolumeId)The ID of the source EBS volume to copy.CopyVolumesRequest.BuildertagSpecifications(Collection<TagSpecification> tagSpecifications)The tags to apply to the volume copy during creation.CopyVolumesRequest.BuildertagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)The tags to apply to the volume copy during creation.CopyVolumesRequest.BuildertagSpecifications(TagSpecification... tagSpecifications)The tags to apply to the volume copy during creation.CopyVolumesRequest.Builderthroughput(Integer throughput)The throughput to provision for the volume copy, in MiB/s.CopyVolumesRequest.BuildervolumeType(String volumeType)The volume type for the volume copy.CopyVolumesRequest.BuildervolumeType(VolumeType volumeType)The volume type for the volume copy.-
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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
sourceVolumeId
CopyVolumesRequest.Builder sourceVolumeId(String sourceVolumeId)
The ID of the source EBS volume to copy.
- Parameters:
sourceVolumeId- The ID of the source EBS volume to copy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iops
CopyVolumesRequest.Builder iops(Integer iops)
The number of I/O operations per second (IOPS) to provision for the volume copy. Required for
io1andio2volumes. Optional forgp3volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.Valid ranges:
-
gp3:
3,000(default)- 80,000IOPS -
io1:
100 - 64,000IOPS -
io2:
100 - 256,000IOPS
Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
- Parameters:
iops- The number of I/O operations per second (IOPS) to provision for the volume copy. Required forio1andio2volumes. Optional forgp3volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.Valid ranges:
-
gp3:
3,000(default)- 80,000IOPS -
io1:
100 - 64,000IOPS -
io2:
100 - 256,000IOPS
Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
size
CopyVolumesRequest.Builder size(Integer size)
The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.
Maximum supported sizes:
-
gp2:
16,384GiB -
gp3:
65,536GiB -
io1:
16,384GiB -
io2:
65,536GiB -
st1 and sc1:
16,384GiB -
standard:
1024GiB
- Parameters:
size- The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.Maximum supported sizes:
-
gp2:
16,384GiB -
gp3:
65,536GiB -
io1:
16,384GiB -
io2:
65,536GiB -
st1 and sc1:
16,384GiB -
standard:
1024GiB
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
volumeType
CopyVolumesRequest.Builder volumeType(String volumeType)
The volume type for the volume copy. If not specified, the volume type defaults to
gp2.- Parameters:
volumeType- The volume type for the volume copy. If not specified, the volume type defaults togp2.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeType,VolumeType
-
volumeType
CopyVolumesRequest.Builder volumeType(VolumeType volumeType)
The volume type for the volume copy. If not specified, the volume type defaults to
gp2.- Parameters:
volumeType- The volume type for the volume copy. If not specified, the volume type defaults togp2.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeType,VolumeType
-
dryRun
CopyVolumesRequest.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.
-
tagSpecifications
CopyVolumesRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the volume copy during creation.
- Parameters:
tagSpecifications- The tags to apply to the volume copy during creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CopyVolumesRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the volume copy during creation.
- Parameters:
tagSpecifications- The tags to apply to the volume copy during creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CopyVolumesRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the volume copy during creation.
This is a convenience method that creates an instance of theTagSpecification.Builderavoiding the need to create one manually viaTagSpecification.builder().When the
Consumercompletes,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)
-
multiAttachEnabled
CopyVolumesRequest.Builder multiAttachEnabled(Boolean multiAttachEnabled)
Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. Supported with
io1andio2volumes only. For more information, see Amazon EBS Multi-Attach.- Parameters:
multiAttachEnabled- Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. Supported withio1andio2volumes only. For more information, see Amazon EBS Multi-Attach.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
throughput
CopyVolumesRequest.Builder throughput(Integer throughput)
The throughput to provision for the volume copy, in MiB/s. Supported for
gp3volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.Valid Range:
125 - 2000MiB/s- Parameters:
throughput- The throughput to provision for the volume copy, in MiB/s. Supported forgp3volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.Valid Range:
125 - 2000MiB/s- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
CopyVolumesRequest.Builder clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
- Parameters:
clientToken- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CopyVolumesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CopyVolumesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-