Class CopyVolumesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.CopyVolumesRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CopyVolumesRequest.Builder,CopyVolumesRequest>
@Generated("software.amazon.awssdk:codegen") public final class CopyVolumesRequest extends Ec2Request implements ToCopyableBuilder<CopyVolumesRequest.Builder,CopyVolumesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCopyVolumesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CopyVolumesRequest.Builderbuilder()StringclientToken()Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.BooleandryRun()Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTagSpecifications()For responses, this returns true if the service returned a value for the TagSpecifications property.Integeriops()The number of I/O operations per second (IOPS) to provision for the volume copy.BooleanmultiAttachEnabled()Indicates whether to enable Amazon EBS Multi-Attach for the volume copy.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CopyVolumesRequest.Builder>serializableBuilderClass()Integersize()The size of the volume copy, in GiBs.StringsourceVolumeId()The ID of the source EBS volume to copy.List<TagSpecification>tagSpecifications()The tags to apply to the volume copy during creation.Integerthroughput()The throughput to provision for the volume copy, in MiB/s.CopyVolumesRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.VolumeTypevolumeType()The volume type for the volume copy.StringvolumeTypeAsString()The volume type for the volume copy.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
sourceVolumeId
public final String sourceVolumeId()
The ID of the source EBS volume to copy.
- Returns:
- The ID of the source EBS volume to copy.
-
iops
public final 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.
- Returns:
- 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.
-
-
-
size
public final 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
- Returns:
- 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
-
-
-
volumeType
public final VolumeType volumeType()
The volume type for the volume copy. If not specified, the volume type defaults to
gp2.If the service returns an enum value that is not available in the current SDK version,
volumeTypewill returnVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvolumeTypeAsString().- Returns:
- The volume type for the volume copy. If not specified, the volume type defaults to
gp2. - See Also:
VolumeType
-
volumeTypeAsString
public final String volumeTypeAsString()
The volume type for the volume copy. If not specified, the volume type defaults to
gp2.If the service returns an enum value that is not available in the current SDK version,
volumeTypewill returnVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvolumeTypeAsString().- Returns:
- The volume type for the volume copy. If not specified, the volume type defaults to
gp2. - See Also:
VolumeType
-
dryRun
public final 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.- Returns:
- 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.
-
hasTagSpecifications
public final boolean hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tagSpecifications
public final List<TagSpecification> tagSpecifications()
The tags to apply to the volume copy during creation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagSpecifications()method.- Returns:
- The tags to apply to the volume copy during creation.
-
multiAttachEnabled
public final 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.- Returns:
- 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.
-
throughput
public final 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- Returns:
- 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
-
clientToken
public final String clientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
- Returns:
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
-
toBuilder
public CopyVolumesRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CopyVolumesRequest.Builder,CopyVolumesRequest>- Specified by:
toBuilderin classEc2Request
-
builder
public static CopyVolumesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CopyVolumesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-