interface CfnSchemaProps

Language	Type name
.NET	Amazon.CDK.AWS.Glue.CfnSchemaProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnSchemaProps
Java	software.amazon.awscdk.services.glue.CfnSchemaProps
Python	aws_cdk.aws_glue.CfnSchemaProps
TypeScript	aws-cdk-lib » aws_glue » CfnSchemaProps

Properties for defining a CfnSchema.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html

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',

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

Properties

Name	Type	Description
compatibility	string	The compatibility mode of the schema.
dataFormat	string	The data format of the schema definition.
name	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.
checkpointVersion?	IResolvable | SchemaVersionProperty	Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.
description?	string	A description of the schema if specified when created.
registry?	IResolvable | RegistryProperty	The registry where a schema is stored.
schemaDefinition?	string	The schema definition using the DataFormat setting for SchemaName .
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.

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

---

dataFormat

Type: string

The data format of the schema definition.

Currently only AVRO is supported.

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

---

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.

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

---

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.

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

---

description?

Type: string (optional)

A description of the schema if specified when created.

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

---

registry?

Type: IResolvable | RegistryProperty (optional)

The registry where a schema is stored.

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

---

schemaDefinition?

Type: string (optional)

The schema definition using the DataFormat setting for SchemaName .

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

---

tags?

Type: CfnTag[] (optional)

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

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