LaunchTemplateEbsBlockDeviceRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.ec2.model.LaunchTemplateEbsBlockDeviceRequest

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>

@Generated(value="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 and Description

static interface LaunchTemplateEbsBlockDeviceRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LaunchTemplateEbsBlockDeviceRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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)` Indicates whether some other object is "equal to" this one by SDK fields.
`<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 a `gp3` volume, with a maximum of 1,000 MiB/s.
`LaunchTemplateEbsBlockDeviceRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
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-16,000 IOPS
    - io1: 100-64,000 IOPS
    - io2: 100-64,000 IOPS
    For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.
    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-16,000 IOPS
    
    io1: 100-64,000 IOPS
    
    io2: 100-64,000 IOPS
    
    For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.
  - 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 and gp3: 1-16,384
    - io1 and io2: 4-16,384
    - st1 and sc1: 125-16,384
    - standard: 1-1,024
    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 and gp3: 1-16,384
    
    io1 and io2: 4-16,384
    
    st1 and sc1: 125-16,384
    
    standard: 1-1,024
  - volumeType
```
public final VolumeType volumeType()
```
    The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
    
    See Also:
    
    VolumeType
  - volumeTypeAsString
```
public final String volumeTypeAsString()
```
    The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>
    
    Returns:
    
    a builder for type T
  - 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.90

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields