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

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

@Generated("software.amazon.awssdk:codegen")
public final class EbsBlockDevice
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EbsBlockDevice.Builder,EbsBlockDevice>

Describes a block device for an EBS volume.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface EbsBlockDevice.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EbsBlockDevice.Builder`	`builder()`
`Boolean`	`deleteOnTermination()`	Indicates whether the EBS volume is deleted on instance termination.
`Boolean`	`encrypted()`	Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
`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, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
`String`	`outpostArn()`	The ARN of the Outpost on which the snapshot is stored.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EbsBlockDevice.Builder>`	`serializableBuilderClass()`
`String`	`snapshotId()`	The ID of the snapshot.
`Integer`	`throughput()`	The throughput that the volume supports, in MiB/s.
`EbsBlockDevice.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
  - deleteOnTermination
```
public final Boolean deleteOnTermination()
```
    Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
    
    Returns:
    
    Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
  - 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 - 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 required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.
    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 - 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 required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.
  - 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. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
    
    The following are the supported sizes for each volume type:
    
    gp2 and gp3: 1 - 16,384 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. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
    
    The following are the supported sizes for each volume type:
    
    gp2 and gp3: 1 - 16,384 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 EC2 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 EC2 User Guide.
    
    See Also:
    
    VolumeType
  - volumeTypeAsString
```
public final String volumeTypeAsString()
```
    The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 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 EC2 User Guide.
    
    See Also:
    
    VolumeType
  - kmsKeyId
```
public final String kmsKeyId()
```
    Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
    
    This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
    
    Returns:
    
    Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
    
    This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
  - throughput
```
public final Integer throughput()
```
    The throughput that the volume supports, in MiB/s.
    
    This parameter is valid only for gp3 volumes.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
    
    Returns:
    
    The throughput that the volume supports, in MiB/s.
    
    This parameter is valid only for gp3 volumes.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
  - outpostArn
```
public final String outpostArn()
```
    The ARN of the Outpost on which the snapshot is stored.
    
    This parameter is not supported when using CreateImage.
    
    Returns:
    
    The ARN of the Outpost on which the snapshot is stored.
    
    This parameter is not supported when using CreateImage.
  - encrypted
```
public final Boolean encrypted()
```
    Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
    
    In no case can you remove encryption from an encrypted volume.
    
    Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
    
    This parameter is not returned by DescribeImageAttribute.
    
    For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
    
    If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
    
    If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
    
    If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
    
    If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false , the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
    Returns:
    
    Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
    
    In no case can you remove encryption from an encrypted volume.
    
    Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
    
    This parameter is not returned by DescribeImageAttribute.
    
    For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
    
    If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
    
    If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
    
    If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
    
    If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
  - toBuilder
```
public EbsBlockDevice.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EbsBlockDevice.Builder,EbsBlockDevice>
  - builder
```
public static EbsBlockDevice.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EbsBlockDevice.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

Class EbsBlockDevice

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

deleteOnTermination

iops

snapshotId

volumeSize

volumeType

volumeTypeAsString

kmsKeyId

throughput

outpostArn

encrypted

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields