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.
`Integer`	`ebsCardIndex()`	The index of the EBS card.
`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()`	Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends LaunchTemplateEbsBlockDeviceRequest.Builder>`	`serializableBuilderClass()`
`String`	`snapshotId()`	The ID of the snapshot.
`Integer`	`throughput()`	The throughput to provision for a `gp3` volume, with a maximum of 2,000 MiB/s.
`LaunchTemplateEbsBlockDeviceRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`volumeInitializationRate()`	Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume.
`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, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 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 - 80,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, and gp3 volumes only.
    Returns:
    
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 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 - 80,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, and gp3 volumes only.
  - kmsKeyId
```
public final String kmsKeyId()
```
    Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
    
    Returns:
    
    Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS 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: 1 - 16,384 GiB
    
    gp3: 1 - 65,536 GiB
    
    io1: 4 - 16,384 GiB
    
    io2: 4 - 65,536 GiB
    
    st1 and sc1: 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: 1 - 16,384 GiB
    
    gp3: 1 - 65,536 GiB
    
    io1: 4 - 16,384 GiB
    
    io2: 4 - 65,536 GiB
    
    st1 and sc1: 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 return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().
    
    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 return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().
    
    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 2,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 2,000.
    
    Returns:
    
    The throughput to provision for a gp3 volume, with a maximum of 2,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 2,000.
  - volumeInitializationRate
```
public final Integer volumeInitializationRate()
```
    Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
    
    This parameter is supported only for volumes created from snapshots. Omit this parameter if:
    
    You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
    
    If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
    
    You want to create a volume that is initialized at the default rate.
    
    For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
    
    Valid range: 100 - 300 MiB/s
    Returns:
    
    Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
    
    This parameter is supported only for volumes created from snapshots. Omit this parameter if:
    
    You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
    
    If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
    
    You want to create a volume that is initialized at the default rate.
    
    For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
    
    Valid range: 100 - 300 MiB/s
  - ebsCardIndex
```
public final Integer ebsCardIndex()
```
    The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.
    
    Returns:
    
    The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.
  - toBuilder
```
public LaunchTemplateEbsBlockDeviceRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>
  - builder
```
public static LaunchTemplateEbsBlockDeviceRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LaunchTemplateEbsBlockDeviceRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class LaunchTemplateEbsBlockDeviceRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

encrypted

deleteOnTermination

iops

kmsKeyId

snapshotId

volumeSize

volumeType

volumeTypeAsString

throughput

volumeInitializationRate

ebsCardIndex

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField