class InlineApiSchema 🔹

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

Extends ApiSchema

Class to define an API Schema from an inline string.

The schema can be provided directly as a string. Validation is performed at the target configuration level where the schema type is known.

Example

const inlineSchema = agentcore.ApiSchema.fromInline(`
openapi: 3.0.3
info:
  title: Library API
  version: 1.0.0
paths:
  /search:
    get:
      summary: Search for books
      operationId: searchBooks
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
`);

Initializer

new InlineApiSchema(schema: string)

Parameters

• schema string

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.