aws-cdk-lib.aws_eventschemas.CfnSchemaProps

interface CfnSchemaProps

LanguageType name
.NETAmazon.CDK.AWS.EventSchemas.CfnSchemaProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseventschemas#CfnSchemaProps
Javasoftware.amazon.awscdk.services.eventschemas.CfnSchemaProps
Pythonaws_cdk.aws_eventschemas.CfnSchemaProps
TypeScript aws-cdk-lib » aws_eventschemas » CfnSchemaProps

Properties for defining a CfnSchema.

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

NameTypeDescription
contentstringThe source of the schema definition.
registryNamestringThe name of the schema registry.
typestringThe type of schema.
description?stringA description of the schema.
schemaName?stringThe name of the schema.
tags?TagsEntryProperty[]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: TagsEntryProperty[] (optional)

Tags associated with the schema.