interface CfnSchemaProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.EventSchemas.CfnSchemaProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awseventschemas#CfnSchemaProps |
Java | software.amazon.awscdk.services.eventschemas.CfnSchemaProps |
Python | aws_cdk.aws_eventschemas.CfnSchemaProps |
TypeScript | aws-cdk-lib » aws_eventschemas » CfnSchemaProps |
Properties for defining a CfnSchema.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventschemas as eventschemas } from 'aws-cdk-lib';
const cfnSchemaProps: eventschemas.CfnSchemaProps = {
content: 'content',
registryName: 'registryName',
type: 'type',
// the properties below are optional
description: 'description',
schemaName: 'schemaName',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| content | string | The source of the schema definition. |
| registry | string | The name of the schema registry. |
| type | string | The type of schema. |
| description? | string | A description of the schema. |
| schema | string | The name of the schema. |
| tags? | Tags[] | Tags associated with the schema. |
content
Type:
string
The source of the schema definition.
registryName
Type:
string
The name of the schema registry.
type
Type:
string
The type of schema.
Valid types include OpenApi3 and JSONSchemaDraft4 .
description?
Type:
string
(optional)
A description of the schema.
schemaName?
Type:
string
(optional)
The name of the schema.
tags?
Type:
Tags[]
(optional)
Tags associated with the schema.

.NET
Go
Java
Python
TypeScript