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::AgentRegistry::Registry CustomMetadataSchemaConfiguration
Configuration that defines a typed custom metadata schema for a registry. A default schema and schema overrides for specific record types are both optional.
Schema evolution is additive only. You can add fields and enum values. You can't remove fields, change field types, or remove enum values.
If you remove this configuration from the template during a stack update, the existing schema isn't cleared. The service keeps the current schema.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "DefaultSchema" :String, "RecordTypeSchemaOverrides" :[ RecordTypeSchemaOverride, ... ]}
YAML
DefaultSchema:StringRecordTypeSchemaOverrides:- RecordTypeSchemaOverride
Properties
DefaultSchema-
The default JSON Schema for custom metadata. It applies to record types that don't have a schema override. The schema can contain 1 to 10,240 characters.
Supported property types are string, string with an enum constraint, string with a
uriformat, and boolean.Required: No
Type: String
Minimum:
1Maximum:
10240Update requires: No interruption
RecordTypeSchemaOverrides-
A list of schema overrides for specific record types. You can specify up to 5 overrides. When a record's type matches an override, the service uses that override's schema instead of the default schema for validation.
Required: No
Type: Array of RecordTypeSchemaOverride
Maximum:
5Update requires: No interruption