Class EbsVolumeConfiguration

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

The configuration for an Amazon EBS-backed persistent volume. The service creates persistent volumes when a session first launches, and the volumes survive instance termination. The volumes persist until you delete the session.

See Also:

  • Method Details

    • name

      public final String name()

      The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime.

      Returns:
      The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime.

    • sizeGiB

      public final Integer sizeGiB()

      The size of the volume, in GiB.

      Returns:
      The size of the volume, in GiB.

    • 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. Valid only for gp3, io1, and io2 volumes.

      Returns:
      The number of IOPS to provision. Valid only for gp3, io1, and io2 volumes.

    • throughput

      public final Integer throughput()

      The throughput, in MiB/s. Valid only for gp3 volumes.

      Returns:
      The throughput, in MiB/s. Valid only for gp3 volumes.

    • encrypted

      public final Boolean encrypted()

      Specifies whether to encrypt the volume. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true.

      Returns:
      Specifies whether to encrypt the volume. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true.

    • kmsKeyId

      public final String kmsKeyId()

      The identifier of the KMS key to use for encryption.

      Returns:
      The identifier of the KMS key to use for encryption.

    • snapshotId

      public final String snapshotId()

      An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored.

      Returns:
      An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored.

    • toBuilder

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

    • builder

      public static EbsVolumeConfiguration.Builder builder()

    • serializableBuilderClass

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