class S3ApiSchema 🔹

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

Extends ApiSchema

Class to define an API Schema from an S3 object.

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 s3ApiSchema = new bedrock_agentcore_alpha.S3ApiSchema({
  bucketName: 'bucketName',
  objectKey: 'objectKey',

  // the properties below are optional
  objectVersion: 'objectVersion',
}, /* all optional props */ 'bucketOwnerAccountId');

Initializer

new S3ApiSchema(location: Location, bucketOwnerAccountId?: string)

Parameters

• location Location
• bucketOwnerAccountId string — The account ID of the S3 bucket owner for cross-account access.

Properties

Name	Type	Description
bucketOwnerAccountId?🔹	string	The account ID of the S3 bucket owner for cross-account access.
inlineSchema?🔹	string	The inline OpenAPI schema definition as a string, if using an inline schema.
s3File?🔹	Location	The S3 location of the API 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: string (optional)

The inline OpenAPI 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 API 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.