CfnSchemaPropsMixin

class aws_cdk.mixins_preview.aws_glue.mixins.CfnSchemaPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html
CloudformationResource:: AWS::Glue::Schema
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

cfn_schema_props_mixin = glue_mixins.CfnSchemaPropsMixin(glue_mixins.CfnSchemaMixinProps(
    checkpoint_version=glue_mixins.CfnSchemaPropsMixin.SchemaVersionProperty(
        is_latest=False,
        version_number=123
    ),
    compatibility="compatibility",
    data_format="dataFormat",
    description="description",
    name="name",
    registry=glue_mixins.CfnSchemaPropsMixin.RegistryProperty(
        arn="arn",
        name="name"
    ),
    schema_definition="schemaDefinition",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Glue::Schema.

Parameters:

props (Union[CfnSchemaMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['checkpointVersion', 'compatibility', 'dataFormat', 'description', 'name', 'registry', 'schemaDefinition', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

RegistryProperty

class CfnSchemaPropsMixin.RegistryProperty(*, arn=None, name=None)

Bases: object

Specifies a registry in the AWS Glue Schema Registry.

Parameters:

arn (Optional[str]) – The Amazon Resource Name (ARN) of the registry.
name (Optional[str]) – The name of the registry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-registry.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.mixins_preview.aws_glue import mixins as glue_mixins

registry_property = glue_mixins.CfnSchemaPropsMixin.RegistryProperty(
    arn="arn",
    name="name"
)

Attributes

arn

The Amazon Resource Name (ARN) of the registry.

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

name

The name of the registry.

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

SchemaVersionProperty

class CfnSchemaPropsMixin.SchemaVersionProperty(*, is_latest=None, version_number=None)

Bases: object

Specifies the version of a schema.

Parameters:

is_latest (Union[bool, IResolvable, None]) – Indicates if this version is the latest version of the schema.
version_number (Union[int, float, None]) – The version number of the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.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.mixins_preview.aws_glue import mixins as glue_mixins

schema_version_property = glue_mixins.CfnSchemaPropsMixin.SchemaVersionProperty(
    is_latest=False,
    version_number=123
)

Attributes

is_latest

Indicates if this version is the latest version of the schema.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.html#cfn-glue-schema-schemaversion-islatest

version_number

The version number of the schema.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.html#cfn-glue-schema-schemaversion-versionnumber