generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs


@cdklabs/generative-ai-cdk-constructs / bedrock / InlineApiSchema

Class: InlineApiSchema

Represents the concept of an API Schema for a Bedrock Agent Action Group.

Extends

Constructors

new InlineApiSchema()

new InlineApiSchema(schema): InlineApiSchema

Parameters

schema

string

Returns

InlineApiSchema

Overrides

ApiSchema.constructor

Properties

inlineSchema?

readonly optional inlineSchema: string

Inherited from

ApiSchema.inlineSchema


s3File?

readonly optional s3File: Location

Inherited from

ApiSchema.s3File

Methods

_render()

_render(): APISchemaProperty

Internal

This is an internal core function and should not be called directly.

Returns

APISchemaProperty

Overrides

ApiSchema._render


fromInline()

static fromInline(schema): InlineApiSchema

Creates an API Schema from an inline string.

Parameters

schema

string

the JSON or YAML payload defining the OpenAPI schema for the action group

Returns

InlineApiSchema

Inherited from

ApiSchema.fromInline


fromLocalAsset()

static fromLocalAsset(path): InlineApiSchema

Creates an API Schema from a local file.

Parameters

path

string

the path to the local file containing the OpenAPI schema for the action group

Returns

InlineApiSchema

Inherited from

ApiSchema.fromLocalAsset


fromS3File()

static fromS3File(bucket, objectKey): S3ApiSchema

Creates an API Schema from an S3 File

Parameters

bucket

IBucket

the bucket containing the local file containing the OpenAPI schema for the action group

objectKey

string

object key in the bucket

Returns

S3ApiSchema

Inherited from

ApiSchema.fromS3File