software.amazon.awssdk.services.ec2.model

Class LaunchTemplateEbsBlockDeviceRequest

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

Method Summary

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) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2.
String	kmsKeyId() The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.
List<SdkField<?>>	sdkFields()
static Class<? extends LaunchTemplateEbsBlockDeviceRequest.Builder>	serializableBuilderClass()
String	snapshotId() The ID of the snapshot.
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 GiB.
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 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 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 Integer iops()

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

Returns:

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro- based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

kmsKeyId

public String kmsKeyId()

The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.

Returns:

The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.

snapshotId

public String snapshotId()

The ID of the snapshot.

Returns:

The ID of the snapshot.

volumeSize

public Integer volumeSize()

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Returns:

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

volumeType

public VolumeType volumeType()

The volume type.

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.

See Also:

VolumeType

volumeTypeAsString

public String volumeTypeAsString()

The volume type.

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.

See Also:

VolumeType

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.