Class S3BucketMountConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringbucket()The name of the S3 bucket to mount.builder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final StringThe mount path for the S3 bucket inside the AgentCore Runtime.final Stringprefix()The key prefix to mount.final StringThe AWS account ID that must own the bucket.final StringThe AWS Region of the S3 bucket.static Class<? extends S3BucketMountConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The mount path for the S3 bucket inside the AgentCore Runtime. The path must be under
/mntwith 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
/mntwith exactly one subdirectory level (for example,/mnt/data).
-
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
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
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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<S3BucketMountConfiguration.Builder,S3BucketMountConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-