AWS::Glue::Schema - AWS CloudFormation

AWS::Glue::Schema

The AWS::Glue::Schema is an AWS Glue resource type that manages schemas in the AWS Glue Schema Registry.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Glue::Schema", "Properties" : { "CheckpointVersion" : SchemaVersion, "Compatibility" : String, "DataFormat" : String, "Description" : String, "Name" : String, "Registry" : Registry, "SchemaDefinition" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Glue::Schema Properties: CheckpointVersion: SchemaVersion Compatibility: String DataFormat: String Description: String Name: String Registry: Registry SchemaDefinition: String Tags: - Tag

Properties

CheckpointVersion

Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.

Required: No

Type: SchemaVersion

Update requires: No interruption

Compatibility

The compatibility mode of the schema.

Required: Yes

Type: String

Update requires: No interruption

DataFormat

The data format of the schema definition. Currently only AVRO is supported.

Required: Yes

Type: String

Update requires: Replacement

Description

A description of the schema if specified when created.

Required: No

Type: String

Update requires: No interruption

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.

Required: Yes

Type: String

Update requires: Replacement

Registry

The registry where a schema is stored.

Required: No

Type: Registry

Update requires: Replacement

SchemaDefinition

The schema definition using the DataFormat setting for SchemaName.

Required: Yes

Type: String

Update requires: Replacement

Tags

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

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the schema.

InitialSchemaVersionId

Not currently supported by AWS CloudFormation.