class ToolSchema 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.ToolSchema
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#ToolSchema
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.ToolSchema
Python	aws_cdk.aws_bedrock_agentcore_alpha.ToolSchema
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » ToolSchema

Implemented by AssetToolSchema, InlineToolSchema, S3ToolSchema

**************************************************************************** TOOL SCHEMA CLASS ***************************************************************************.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const toolSchema = bedrock_agentcore_alpha.ToolSchema.fromLocalAsset('path');

Initializer (protected)

super(s3File?: Location, bucketOwnerAccountId?: string, inlineSchema?: ToolDefinition[])

Parameters

• s3File Location
• bucketOwnerAccountId string
• inlineSchema ToolDefinition[]

Properties

Name	Type	Description
bucketOwnerAccountId?🔹	string	The account ID of the S3 bucket owner for cross-account access.
inlineSchema?🔹	ToolDefinition[]	The inline tool schema definition as a string, if using an inline schema.
s3File?🔹	Location	The S3 location of the tool schema file, if using an S3-based schema.

---

bucketOwnerAccountId?🔹

Type: string (optional)

The account ID of the S3 bucket owner for cross-account access.

---

inlineSchema?🔹

Type: ToolDefinition[] (optional)

The inline tool schema definition as a string, if using an inline schema.

Can be in JSON or YAML format.

---

s3File?🔹

Type: Location (optional)

The S3 location of the tool schema file, if using an S3-based schema.

Contains the bucket name and object key information.

Methods

Name	Description
bind(scope)🔹	Bind the schema to a construct.
grantPermissionsToRole(role)🔹	Grant permissions to the role.
static fromInline(schema)🔹	Creates a Tool Schema from an inline string.
static fromLocalAsset(path)🔹	Creates a tool Schema from a local file.
static fromS3File(bucket, objectKey, bucketOwnerAccountId?)🔹	Creates a Tool Schema from an S3 File.

---

bind(scope)🔹

public bind(scope: Construct): void

Parameters

• scope Construct

Bind the schema to a construct.

---

grantPermissionsToRole(role)🔹

public grantPermissionsToRole(role: IRole): void

Parameters

• role IRole

Grant permissions to the role.

---

static fromInline(schema)🔹

public static fromInline(schema: ToolDefinition[]): InlineToolSchema

Parameters

• schema ToolDefinition[] — - the JSON or YAML payload defining the OpenAPI schema for the action group.

Returns

• InlineToolSchema

Creates a Tool Schema from an inline string.

---

static fromLocalAsset(path)🔹

public static fromLocalAsset(path: string): ToolSchema

Parameters

• path string — - the path to the local file containing the function schema for the tool.

Returns

• ToolSchema

Creates a tool Schema from a local file.

---

static fromS3File(bucket, objectKey, bucketOwnerAccountId?)🔹

public static fromS3File(bucket: IBucket, objectKey: string, bucketOwnerAccountId?: string): S3ToolSchema

Parameters

• bucket IBucket — - the bucket containing the local file containing the OpenAPI schema for the action group.
• objectKey string — - object key in the bucket.
• bucketOwnerAccountId string — - optional The account ID of the Amazon S3 bucket owner.

Returns

• S3ToolSchema

Creates a Tool Schema from an S3 File.