CfnSchemaProps
- class aws_cdk.aws_glue.CfnSchemaProps(*, compatibility, data_format, name, checkpoint_version=None, description=None, registry=None, schema_definition=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 onlyAVRO
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.checkpoint_version (
Union
[IResolvable
,SchemaVersionProperty
,Dict
[str
,Any
],None
]) – Specify theVersionNumber
or theIsLatest
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.schema_definition (
Optional
[str
]) – The schema definition using theDataFormat
setting forSchemaName
.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.
- See:
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. from aws_cdk import aws_glue as glue cfn_schema_props = glue.CfnSchemaProps( compatibility="compatibility", data_format="dataFormat", name="name", # 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" ), schema_definition="schemaDefinition", tags=[CfnTag( key="key", value="value" )] )
Attributes
- checkpoint_version
Specify the
VersionNumber
or theIsLatest
for setting the checkpoint for the schema.This is only required for updating a checkpoint.
- compatibility
The compatibility mode of the schema.
- data_format
The data format of the schema definition.
Currently only
AVRO
is supported.
- description
A description of the schema if specified when created.
- 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.
- registry
The registry where a schema is stored.
- schema_definition
The schema definition using the
DataFormat
setting forSchemaName
.
- tags
AWS tags that contain a key value pair and may be searched by console, command line, or API.