class InlineToolSchema 🔹

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

Extends ToolSchema

Class to define a Tool Schema from an inline string.

The schema can be provided directly as a string in either JSON or YAML format.

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';

declare const schemaDefinition_: bedrock_agentcore_alpha.SchemaDefinition;
const inlineToolSchema = new bedrock_agentcore_alpha.InlineToolSchema([{
  description: 'description',
  inputSchema: {
    type: bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

    // the properties below are optional
    description: 'description',
    items: schemaDefinition_,
    properties: {
      propertiesKey: schemaDefinition_,
    },
    required: ['required'],
  },
  name: 'name',

  // the properties below are optional
  outputSchema: {
    type: bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

    // the properties below are optional
    description: 'description',
    items: schemaDefinition_,
    properties: {
      propertiesKey: schemaDefinition_,
    },
    required: ['required'],
  },
}]);

Initializer

new InlineToolSchema(schema: ToolDefinition[])

Parameters

• schema 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.

---

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.