interface ToolSchemaProperty

Language	Type name
.NET	Amazon.CDK.AWS.BedrockAgentCore.CfnGatewayTarget.ToolSchemaProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnGatewayTarget_ToolSchemaProperty
Java	software.amazon.awscdk.services.bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty
Python	aws_cdk.aws_bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty
TypeScript	aws-cdk-lib » aws_bedrockagentcore » CfnGatewayTarget » ToolSchemaProperty

The tool schema for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';

declare const schemaDefinitionProperty_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty;
const toolSchemaProperty: bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty = {
  inlinePayload: [{
    description: 'description',
    inputSchema: {
      type: 'type',

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

    // the properties below are optional
    outputSchema: {
      type: 'type',

      // the properties below are optional
      description: 'description',
      items: schemaDefinitionProperty_,
      properties: {
        propertiesKey: schemaDefinitionProperty_,
      },
      required: ['required'],
    },
  }],
  s3: {
    bucketOwnerAccountId: 'bucketOwnerAccountId',
    uri: 'uri',
  },
};

Properties

Name	Type	Description
inlinePayload?	IResolvable | (IResolvable | ToolDefinitionProperty)[]	The inline payload for the gateway target.
s3?	IResolvable | S3ConfigurationProperty	The S3 tool schema for the gateway target.

---

inlinePayload?

Type: IResolvable | (IResolvable | ToolDefinitionProperty)[] (optional)

The inline payload for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload

---

s3?

Type: IResolvable | S3ConfigurationProperty (optional)

The S3 tool schema for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-s3