aws-cdk-lib.aws_glue.CfnSchemaProps

interface CfnSchemaProps

LanguageType name
.NETAmazon.CDK.AWS.Glue.CfnSchemaProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnSchemaProps
Javasoftware.amazon.awscdk.services.glue.CfnSchemaProps
Pythonaws_cdk.aws_glue.CfnSchemaProps
TypeScript aws-cdk-lib » aws_glue » 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_glue as glue } from 'aws-cdk-lib';
const cfnSchemaProps: glue.CfnSchemaProps = {
  compatibility: 'compatibility',
  dataFormat: 'dataFormat',
  name: 'name',
  schemaDefinition: 'schemaDefinition',

  // the properties below are optional
  checkpointVersion: {
    isLatest: false,
    versionNumber: 123,
  },
  description: 'description',
  registry: {
    arn: 'arn',
    name: 'name',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
compatibilitystringThe compatibility mode of the schema.
dataFormatstringThe data format of the schema definition.
namestringName of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark.
schemaDefinitionstringThe schema definition using the DataFormat setting for SchemaName .
checkpointVersion?IResolvable | SchemaVersionPropertySpecify the VersionNumber or the IsLatest for setting the checkpoint for the schema.
description?stringA description of the schema if specified when created.
registry?IResolvable | RegistryPropertyThe registry where a schema is stored.
tags?CfnTag[]AWS tags that contain a key value pair and may be searched by console, command line, or API.

compatibility

Type: string

The compatibility mode of the schema.


dataFormat

Type: string

The data format of the schema definition.

Currently only AVRO is supported.


name

Type: string

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.


schemaDefinition

Type: string

The schema definition using the DataFormat setting for SchemaName .


checkpointVersion?

Type: IResolvable | SchemaVersionProperty (optional)

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

This is only required for updating a checkpoint.


description?

Type: string (optional)

A description of the schema if specified when created.


registry?

Type: IResolvable | RegistryProperty (optional)

The registry where a schema is stored.


tags?

Type: CfnTag[] (optional)

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