CfnSchemaProps

class aws_cdk.aws_glue.CfnSchemaProps(*, compatibility, data_format, name, schema_definition, checkpoint_version=None, description=None, registry=None, tags=None)

Bases: object

Properties for defining a CfnSchema.

Parameters
  • compatibility (str) – The compatibility mode of the schema.

  • data_format (str) – The data format of the schema definition. Currently only AVRO is supported.

  • name (str) – Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

  • schema_definition (str) – The schema definition using the DataFormat setting for SchemaName .

  • checkpoint_version (Union[IResolvable, SchemaVersionProperty, Dict[str, Any], None]) – Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.

  • description (Optional[str]) – A description of the schema if specified when created.

  • registry (Union[IResolvable, RegistryProperty, Dict[str, Any], None]) – The registry where a schema is stored.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – AWS tags that contain a key value pair and may be searched by console, command line, or API.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-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.
import aws_cdk.aws_glue as glue

cfn_schema_props = glue.CfnSchemaProps(
    compatibility="compatibility",
    data_format="dataFormat",
    name="name",
    schema_definition="schemaDefinition",

    # the properties below are optional
    checkpoint_version=glue.CfnSchema.SchemaVersionProperty(
        is_latest=False,
        version_number=123
    ),
    description="description",
    registry=glue.CfnSchema.RegistryProperty(
        arn="arn",
        name="name"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

checkpoint_version

Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.

This is only required for updating a checkpoint.

Link

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

compatibility

The compatibility mode of the schema.

Link

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

data_format

The data format of the schema definition.

Currently only AVRO is supported.

Link

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

description

A description of the schema if specified when created.

Link

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

name

Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark.

No whitespace.

Link

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

registry

The registry where a schema is stored.

Link

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

schema_definition

The schema definition using the DataFormat setting for SchemaName .

Link

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

tags

AWS tags that contain a key value pair and may be searched by console, command line, or API.

Link

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