This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::BedrockAgentCore::GatewayTarget SchemaDefinition
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Description" :String, "Items" :SchemaDefinition, "Properties" :{, "Required" :Key:Value, ...}[ String, ... ], "Type" :String}
YAML
Description:StringItems:SchemaDefinitionProperties:Required:Key:Value- StringType:String
Properties
Description-
The description of the schema definition. This description provides information about the purpose and usage of the schema.
Required: No
Type: String
Update requires: No interruption
Items-
The items in the schema definition. This field is used for array types to define the structure of the array elements.
Required: No
Type: SchemaDefinition
Update requires: No interruption
Properties-
The properties of the schema definition. These properties define the fields in the schema.
Required: No
Type: Object of SchemaDefinition
Update requires: No interruption
Required-
The required fields in the schema definition. These fields must be provided when using the schema.
Required: No
Type: Array of String
Update requires: No interruption
Type-
The type of the schema definition. This field specifies the data type of the schema.
Required: Yes
Type: String
Allowed values:
string | number | object | array | boolean | integerUpdate requires: No interruption