Class EphemeralEBSVolumeConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.EphemeralEBSVolumeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EphemeralEBSVolumeConfiguration.Builder,EphemeralEBSVolumeConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class EphemeralEBSVolumeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EphemeralEBSVolumeConfiguration.Builder,EphemeralEBSVolumeConfiguration>

The shared Amazon EBS performance and encryption properties for a volume. These properties are common across the different volume configurations for a capacity provider.

See Also:

  • Method Details

    • volumeType

      public final EbsVolumeType volumeType()

      The Amazon EBS volume type. If you do not specify a type, the default is gp3.

      If the service returns an enum value that is not available in the current SDK version, volumeType will return EbsVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().

      Returns:
      The Amazon EBS volume type. If you do not specify a type, the default is gp3.
      See Also:

    • volumeTypeAsString

      public final String volumeTypeAsString()

      The Amazon EBS volume type. If you do not specify a type, the default is gp3.

      If the service returns an enum value that is not available in the current SDK version, volumeType will return EbsVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().

      Returns:
      The Amazon EBS volume type. If you do not specify a type, the default is gp3.
      See Also:

    • iops

      public final Integer iops()

      The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

      Returns:
      The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

    • throughput

      public final Integer throughput()

      The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

      Returns:
      The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

    • encrypted

      public final Boolean encrypted()

      Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

      Returns:
      Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

    • kmsKeyId

      public final String kmsKeyId()

      The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption.

      Returns:
      The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS 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 GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536.

      Returns:
      The size of the volume, in GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536.

    • volumeInitializationRate

      public final Integer volumeInitializationRate()

      The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s.

      Returns:
      The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s.

    • ebsCardIndex

      public final Integer ebsCardIndex()

      The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

      Returns:
      The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

    • toBuilder

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

    • builder

      public static EphemeralEBSVolumeConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.