Class LaunchTemplateEbsBlockDeviceRequest
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.LaunchTemplateEbsBlockDeviceRequest
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>
@Generated("software.amazon.awssdk:codegen") public final class LaunchTemplateEbsBlockDeviceRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>
The parameters for a block device for an EBS volume.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LaunchTemplateEbsBlockDeviceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LaunchTemplateEbsBlockDeviceRequest.Builder
builder()
Boolean
deleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination.Boolean
encrypted()
Indicates whether the EBS volume is encrypted.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
iops()
The number of I/O operations per second (IOPS).String
kmsKeyId()
The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.List<SdkField<?>>
sdkFields()
static Class<? extends LaunchTemplateEbsBlockDeviceRequest.Builder>
serializableBuilderClass()
String
snapshotId()
The ID of the snapshot.Integer
throughput()
The throughput to provision for agp3
volume, with a maximum of 1,000 MiB/s.LaunchTemplateEbsBlockDeviceRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.Integer
volumeSize()
The size of the volume, in GiBs.VolumeType
volumeType()
The volume type.String
volumeTypeAsString()
The volume type.-
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
-
encrypted
public final Boolean encrypted()
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
- Returns:
- Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
-
deleteOnTermination
public final Boolean deleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination.
- Returns:
- Indicates whether the EBS volume is deleted on instance termination.
-
iops
public final Integer iops()
The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type:
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
For
io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.This parameter is supported for
io1
,io2
, andgp3
volumes only.- Returns:
- The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type:
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
For
io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.This parameter is supported for
io1
,io2
, andgp3
volumes only. -
-
-
kmsKeyId
public final String kmsKeyId()
The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
- Returns:
- The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
-
snapshotId
public final String snapshotId()
The ID of the snapshot.
- Returns:
- The ID of the snapshot.
-
volumeSize
public final Integer volumeSize()
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
-
gp2
andgp3
: 1 - 16,384 GiB -
io1
: 4 - 16,384 GiB -
io2
: 4 - 65,536 GiB -
st1
andsc1
: 125 - 16,384 GiB -
standard
: 1 - 1024 GiB
- Returns:
- The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following
are the supported volumes sizes for each volume type:
-
gp2
andgp3
: 1 - 16,384 GiB -
io1
: 4 - 16,384 GiB -
io2
: 4 - 65,536 GiB -
st1
andsc1
: 125 - 16,384 GiB -
standard
: 1 - 1024 GiB
-
-
-
volumeType
public final VolumeType volumeType()
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
- See Also:
VolumeType
-
volumeTypeAsString
public final String volumeTypeAsString()
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
- See Also:
VolumeType
-
throughput
public final Integer throughput()
The throughput to provision for a
gp3
volume, with a maximum of 1,000 MiB/s.Valid Range: Minimum value of 125. Maximum value of 1000.
- Returns:
- The throughput to provision for a
gp3
volume, with a maximum of 1,000 MiB/s.Valid Range: Minimum value of 125. Maximum value of 1000.
-
toBuilder
public LaunchTemplateEbsBlockDeviceRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>
-
builder
public static LaunchTemplateEbsBlockDeviceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends LaunchTemplateEbsBlockDeviceRequest.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-