software.amazon.awssdk.services.autoscaling.model

Class Ebs

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.Ebs

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Ebs.Builder,Ebs>

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

Describes an Amazon EBS volume. Used in combination with BlockDeviceMapping.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Ebs.Builder

Method Summary

Modifier and Type	Method and Description
static Ebs.Builder	builder()
Boolean	deleteOnTermination() Indicates whether the volume is deleted on instance termination.
Boolean	encrypted() Specifies whether the volume should be encrypted.
boolean	equals(Object obj)
<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 the volume.
List<SdkField<?>>	sdkFields()
static Class<? extends Ebs.Builder>	serializableBuilderClass()
String	snapshotId() The ID of the snapshot.
Ebs.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	volumeSize() The volume size, in GiB.
String	volumeType() The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD.

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

snapshotId

public String snapshotId()

The ID of the snapshot. This parameter is optional if you specify a volume size.

Returns:

The ID of the snapshot. This parameter is optional if you specify a volume size.

volumeSize

public Integer volumeSize()

The volume size, in GiB.

Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

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

At least one of VolumeSize or SnapshotId is required.

Returns:

The volume size, in GiB.

Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

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

At least one of VolumeSize or SnapshotId is required.

volumeType

public String volumeType()

The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1

Returns:

The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1

deleteOnTermination

public Boolean deleteOnTermination()

Indicates whether the volume is deleted on instance termination. The default value is true.

Returns:

Indicates whether the volume is deleted on instance termination. The default value is true.

iops

public Integer iops()

The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Returns:

The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

encrypted

public Boolean encrypted()

Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

Returns:

Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

toBuilder

public Ebs.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Ebs.Builder,Ebs>

builder

public static Ebs.Builder builder()

serializableBuilderClass

public static Class<? extends Ebs.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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