Interface S3BucketMountConfiguration.Builder

  • Method Details

    • bucket

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

      Parameters:
      bucket - The name of the S3 bucket to mount. You can specify a general purpose bucket or a directory bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • s3BucketOwner

      S3BucketMountConfiguration.Builder s3BucketOwner(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • s3BucketRegion

      S3BucketMountConfiguration.Builder s3BucketRegion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.