CfnSchemaProps

class aws_cdk.aws_eventschemas.CfnSchemaProps(*, content, registry_name, type, description=None, schema_name=None, tags=None)

Bases: object

Properties for defining a CfnSchema.

Parameters:
  • content (str) – The source of the schema definition.

  • registry_name (str) – The name of the schema registry.

  • type (str) – The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4 .

  • description (Optional[str]) – A description of the schema.

  • schema_name (Optional[str]) – The name of the schema.

  • tags (Optional[Sequence[Union[TagsEntryProperty, Dict[str, Any]]]]) – Tags associated with the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eventschemas as eventschemas

cfn_schema_props = eventschemas.CfnSchemaProps(
    content="content",
    registry_name="registryName",
    type="type",

    # the properties below are optional
    description="description",
    schema_name="schemaName",
    tags=[eventschemas.CfnSchema.TagsEntryProperty(
        key="key",
        value="value"
    )]
)

Attributes

content

The source of the schema definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-content

description

A description of the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-description

registry_name

The name of the schema registry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-registryname

schema_name

The name of the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-schemaname

tags

Tags associated with the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-tags

type

The type of schema.

Valid types include OpenApi3 and JSONSchemaDraft4 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-type