Skip to content
v2.275.0

CustomMetadataSchemaConfigurationProperty Struct Added in v2.275.0 ​

Configuration that defines a typed metadata schema for a registry.

A default schema and per-record-type schema overrides are both optional. Schema evolution is additive only: you can add fields and enum values, but you cannot remove fields, change types, or remove enum values.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_agentregistry as agentregistry } from 'aws-cdk-lib';
const customMetadataSchemaConfigurationProperty: agentregistry.CfnRegistry.CustomMetadataSchemaConfigurationProperty = {
  defaultSchema: 'defaultSchema',
  recordTypeSchemaOverrides: [{
    recordType: 'recordType',
    schema: 'schema',
  }],
};

Properties ​

defaultSchemaoptionalstringdefault_schemaoptionalstrdefaultSchemaoptionalStringDefaultSchemaoptionalstringDefaultSchemaoptional*string#
The default JSON Schema that applies to record types without a specific override.

Supported property types are string, string with an enum constraint, string with a uri format, and boolean.

recordTypeSchemaOverridesoptionalIResolvable | IResolvable | CfnRegistry.RecordTypeSchemaOverrideProperty[]record_type_schema_overridesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RecordTypeSchemaOverrideProperty]]]recordTypeSchemaOverridesoptionalIResolvableRecordTypeSchemaOverridesoptionalIResolvableRecordTypeSchemaOverridesoptionalinterface{}#
A list of per-record-type schema overrides.

When a record's type matches an override, that override's schema is used instead of the default schema for validation.