Class S3BucketMountConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.S3BucketMountConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3BucketMountConfiguration.Builder,S3BucketMountConfiguration>

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

Mounts an Amazon S3 bucket in the AgentCore Runtime with Mountpoint for Amazon S3. Files under the mount path map to objects in the bucket.

See Also:
  • Method Details

    • bucket

      public final String bucket()

      The name of the S3 bucket to mount. You can specify a general purpose bucket or a directory bucket.

      Returns:
      The name of the S3 bucket to mount. You can specify a general purpose bucket or a directory bucket.
    • mountPath

      public final String mountPath()

      The mount path for the S3 bucket inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).

      Returns:
      The mount path for the S3 bucket inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).
    • prefix

      public final String prefix()

      The key prefix to mount. Only objects under this prefix are visible at the mount path. To give each session its own prefix, include {runtimeSessionId} (for example, data/{runtimeSessionId}/). If you omit the prefix, the whole bucket is mounted.

      Returns:
      The key prefix to mount. Only objects under this prefix are visible at the mount path. To give each session its own prefix, include {runtimeSessionId} (for example, data/{runtimeSessionId}/). If you omit the prefix, the whole bucket is mounted.
    • s3BucketOwner

      public final String s3BucketOwner()

      The AWS account ID that must own the bucket. If you omit it, the bucket must be owned by the account that owns the AgentCore Runtime.

      Returns:
      The AWS account ID that must own the bucket. If you omit it, the bucket must be owned by the account that owns the AgentCore Runtime.
    • s3BucketRegion

      public final String s3BucketRegion()

      The AWS Region of the S3 bucket. If you omit it, the bucket must be in the same Region as the AgentCore Runtime.

      Returns:
      The AWS Region of the S3 bucket. If you omit it, the bucket must be in the same Region as the AgentCore Runtime.
    • 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<S3BucketMountConfiguration.Builder,S3BucketMountConfiguration>
      Returns:
      a builder for type T
    • builder

      public static S3BucketMountConfiguration.Builder builder()
    • serializableBuilderClass

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