Package 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("software.amazon.awssdk:codegen") public final class Ebs extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Ebs.Builder,Ebs>

Describes information used to set up an Amazon EBS volume specified in a block device mapping.

See Also:

  • Method Details

    • snapshotId

      public final String snapshotId()

      The snapshot ID of the volume to use.

      You must specify either a VolumeSize or a SnapshotId.

      Returns:
      The snapshot ID of the volume to use.

      You must specify either a VolumeSize or a SnapshotId.

    • volumeSize

      public final Integer volumeSize()

      The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

      • gp2 and gp3: 1-16,384

      • io1: 4-16,384

      • st1 and sc1: 125-16,384

      • standard: 1-1,024

      You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

      Returns:
      The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

      • gp2 and gp3: 1-16,384

      • io1: 4-16,384

      • st1 and sc1: 125-16,384

      • standard: 1-1,024

      You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

    • volumeType

      public final String volumeType()

      The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances.

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

      Returns:
      The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances.

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

    • deleteOnTermination

      public final Boolean deleteOnTermination()

      Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

      Returns:
      Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

    • iops

      public final Integer iops()

      The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

      For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

      Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

      Returns:
      The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

      For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

      Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

    • encrypted

      public final Boolean encrypted()

      Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

      If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

      If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

      For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.

      Returns:
      Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

      If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

      If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

      For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.

    • throughput

      public final Integer throughput()

      The throughput (MiBps) to provision for a gp3 volume.

      Returns:
      The throughput (MiBps) to provision for a gp3 volume.

    • toBuilder

      public Ebs.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<Ebs.Builder,Ebs>
      Returns:
      a builder for type T

    • builder

      public static Ebs.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Ebs.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.