interface APISchemaProperty

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.CfnAgent.APISchemaProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnAgent_APISchemaProperty
Java	software.amazon.awscdk.services.bedrock.CfnAgent.APISchemaProperty
Python	aws_cdk.aws_bedrock.CfnAgent.APISchemaProperty
TypeScript	aws-cdk-lib » aws_bedrock » CfnAgent » APISchemaProperty

Contains details about the OpenAPI schema for the action group.

For more information, see Action group OpenAPI schemas . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const aPISchemaProperty: bedrock.CfnAgent.APISchemaProperty = {
  payload: 'payload',
  s3: {
    s3BucketName: 's3BucketName',
    s3ObjectKey: 's3ObjectKey',
  },
};

Properties

Name	Type	Description
payload?	string	The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
s3?	IResolvable | S3IdentifierProperty	Contains details about the S3 object containing the OpenAPI schema for the action group.

---

payload?

Type: string (optional)

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-payload

---

s3?

Type: IResolvable | S3IdentifierProperty (optional)

Contains details about the S3 object containing the OpenAPI schema for the action group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-s3