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
Tool
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
const toolSchema = agentcore.ToolSchema.fromInline([{
name: "hello_world",
description: "A simple hello world tool",
inputSchema: {
type: agentcore.SchemaDefinitionType.OBJECT,
properties: {
name: {
type: agentcore.SchemaDefinitionType.STRING,
description: "The name to greet",
},
},
required: ["name"],
},
}]);
Initializer
new InlineToolSchema(schema: ToolDefinition[])
Parameters
- schema
ToolDefinition []
Properties
| Name | Type | Description |
|---|---|---|
| bucket | string | The account ID of the S3 bucket owner for cross-account access. |
| inline | Tool[] | The inline tool schema definition as a string, if using an inline schema. |
| s3 | 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:
Tool[]
(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. |
| grant | 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.

.NET
Go
Java
Python
TypeScript (