Abstract Class: ApiSchema
March 19, 2026 ยท View on GitHub
@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / bedrock / ApiSchema
Abstract Class: ApiSchema
Represents the concept of an API Schema for a Bedrock Agent Action Group.
Extended by
Constructors
Constructor
protectednew ApiSchema(s3File?,inlineSchema?):ApiSchema
Constructor accessible only to extending classes.
Parameters
s3File?
Location
inlineSchema?
string
Returns
ApiSchema
Properties
inlineSchema?
readonlyoptionalinlineSchema?:string
s3File?
readonlyoptionals3File?:Location
Methods
_render()
abstract_render():APISchemaProperty
Internal
Format as CFN properties
This is an internal core function and should not be called directly.
Returns
APISchemaProperty
fromInline()
staticfromInline(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
fromLocalAsset()
staticfromLocalAsset(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
fromS3File()
staticfromS3File(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