Package software.amazon.awscdk.services.bedrockagentcore

Class S3ToolSchema

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.bedrockagentcore.ToolSchema
software.amazon.awscdk.services.bedrockagentcore.S3ToolSchema
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.503Z") @Stability(Stable) public class S3ToolSchema extends ToolSchema
Class to define a Tool Schema from an S3 object.

Example: 

 S3ToolSchema toolSchema = ToolSchema.fromS3File(Bucket.fromBucketName(this, "SchemasBucket", "my-schemas-bucket"), "tools/complex-tool-schema.json", "123456789012");

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    S3ToolSchema.Builder
    A fluent builder for S3ToolSchema.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    S3ToolSchema(Location location)
     
     
    S3ToolSchema(Location location, String bucketOwnerAccountId)
     
    protected
    S3ToolSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    S3ToolSchema(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    bind(software.constructs.Construct scope)
    Bind the schema to a construct.
    String
    getBucketOwnerAccountId()
    The account ID of the S3 bucket owner for cross-account access.
    void
    grantPermissionsToRole(IRole role)
    Grant permissions to the role.

    Methods inherited from class software.amazon.awscdk.services.bedrockagentcore.ToolSchema

    fromInline, fromLocalAsset, fromS3File, fromS3File, getInlineSchema, getS3File

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • S3ToolSchema

      protected S3ToolSchema(software.amazon.jsii.JsiiObjectRef objRef)

    • S3ToolSchema

      protected S3ToolSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • S3ToolSchema

      @Stability(Stable) public S3ToolSchema(@NotNull Location location, @Nullable String bucketOwnerAccountId)
      Parameters:
      location - This parameter is required.
      bucketOwnerAccountId - The account ID of the S3 bucket owner for cross-account access.

    • S3ToolSchema

      @Stability(Stable) public S3ToolSchema(@NotNull Location location)
      Parameters:
      location - This parameter is required.

  • Method Details

    • bind

      @Stability(Stable) public void bind(@NotNull software.constructs.Construct scope)
      Bind the schema to a construct.

      Specified by:
      bind in class ToolSchema
      Parameters:
      scope - This parameter is required.

    • grantPermissionsToRole

      @Stability(Stable) public void grantPermissionsToRole(@NotNull IRole role)
      Grant permissions to the role.

      Specified by:
      grantPermissionsToRole in class ToolSchema
      Parameters:
      role - This parameter is required.

    • getBucketOwnerAccountId

      @Stability(Stable) @Nullable public String getBucketOwnerAccountId()
      The account ID of the S3 bucket owner for cross-account access.
      Overrides:
      getBucketOwnerAccountId in class ToolSchema