CfnPartitionPropsMixin

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

Bases: Mixin

The AWS::Glue::Partition resource creates an AWS Glue partition, which represents a slice of table data.

For more information, see CreatePartition Action and Partition Structure in the AWS Glue Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html
CloudformationResource:: AWS::Glue::Partition
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

# parameters: Any
# skewed_column_value_location_maps: Any

cfn_partition_props_mixin = glue_mixins.CfnPartitionPropsMixin(glue_mixins.CfnPartitionMixinProps(
    catalog_id="catalogId",
    database_name="databaseName",
    partition_input=glue_mixins.CfnPartitionPropsMixin.PartitionInputProperty(
        parameters=parameters,
        storage_descriptor=glue_mixins.CfnPartitionPropsMixin.StorageDescriptorProperty(
            bucket_columns=["bucketColumns"],
            columns=[glue_mixins.CfnPartitionPropsMixin.ColumnProperty(
                comment="comment",
                name="name",
                type="type"
            )],
            compressed=False,
            input_format="inputFormat",
            location="location",
            number_of_buckets=123,
            output_format="outputFormat",
            parameters=parameters,
            schema_reference=glue_mixins.CfnPartitionPropsMixin.SchemaReferenceProperty(
                schema_id=glue_mixins.CfnPartitionPropsMixin.SchemaIdProperty(
                    registry_name="registryName",
                    schema_arn="schemaArn",
                    schema_name="schemaName"
                ),
                schema_version_id="schemaVersionId",
                schema_version_number=123
            ),
            serde_info=glue_mixins.CfnPartitionPropsMixin.SerdeInfoProperty(
                name="name",
                parameters=parameters,
                serialization_library="serializationLibrary"
            ),
            skewed_info=glue_mixins.CfnPartitionPropsMixin.SkewedInfoProperty(
                skewed_column_names=["skewedColumnNames"],
                skewed_column_value_location_maps=skewed_column_value_location_maps,
                skewed_column_values=["skewedColumnValues"]
            ),
            sort_columns=[glue_mixins.CfnPartitionPropsMixin.OrderProperty(
                column="column",
                sort_order=123
            )],
            stored_as_sub_directories=False
        ),
        values=["values"]
    ),
    table_name="tableName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnPartitionMixinProps, 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 = ['catalogId', 'databaseName', 'partitionInput', 'tableName']

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

ColumnProperty

class CfnPartitionPropsMixin.ColumnProperty(*, comment=None, name=None, type=None)

Bases: object

A column in a Table .

Parameters:

comment (Optional[str]) – A free-form text comment.
name (Optional[str]) – The name of the Column .
type (Optional[str]) – The data type of the Column .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.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

column_property = glue_mixins.CfnPartitionPropsMixin.ColumnProperty(
    comment="comment",
    name="name",
    type="type"
)

Attributes

comment

A free-form text comment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-comment

name

The name of the Column .

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

type

The data type of the Column .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-type

OrderProperty

class CfnPartitionPropsMixin.OrderProperty(*, column=None, sort_order=None)

Bases: object

Specifies the sort order of a sorted column.

Parameters:

column (Optional[str]) – The name of the column.
sort_order (Union[int, float, None]) – Indicates that the column is sorted in ascending order ( == 1 ), or in descending order ( ==0 ).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.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

order_property = glue_mixins.CfnPartitionPropsMixin.OrderProperty(
    column="column",
    sort_order=123
)

Attributes

column

The name of the column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-column

sort_order

Indicates that the column is sorted in ascending order ( == 1 ), or in descending order ( ==0 ).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-sortorder

PartitionInputProperty

class CfnPartitionPropsMixin.PartitionInputProperty(*, parameters=None, storage_descriptor=None, values=None)

Bases: object

The structure used to create and update a partition.

Parameters:

parameters (Any) – These key-value pairs define partition parameters.
storage_descriptor (Union[IResolvable, StorageDescriptorProperty, Dict[str, Any], None]) – Provides information about the physical location where the partition is stored.
values (Optional[Sequence[str]]) – The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input. The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values to the wrong keys.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.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

# parameters: Any
# skewed_column_value_location_maps: Any

partition_input_property = glue_mixins.CfnPartitionPropsMixin.PartitionInputProperty(
    parameters=parameters,
    storage_descriptor=glue_mixins.CfnPartitionPropsMixin.StorageDescriptorProperty(
        bucket_columns=["bucketColumns"],
        columns=[glue_mixins.CfnPartitionPropsMixin.ColumnProperty(
            comment="comment",
            name="name",
            type="type"
        )],
        compressed=False,
        input_format="inputFormat",
        location="location",
        number_of_buckets=123,
        output_format="outputFormat",
        parameters=parameters,
        schema_reference=glue_mixins.CfnPartitionPropsMixin.SchemaReferenceProperty(
            schema_id=glue_mixins.CfnPartitionPropsMixin.SchemaIdProperty(
                registry_name="registryName",
                schema_arn="schemaArn",
                schema_name="schemaName"
            ),
            schema_version_id="schemaVersionId",
            schema_version_number=123
        ),
        serde_info=glue_mixins.CfnPartitionPropsMixin.SerdeInfoProperty(
            name="name",
            parameters=parameters,
            serialization_library="serializationLibrary"
        ),
        skewed_info=glue_mixins.CfnPartitionPropsMixin.SkewedInfoProperty(
            skewed_column_names=["skewedColumnNames"],
            skewed_column_value_location_maps=skewed_column_value_location_maps,
            skewed_column_values=["skewedColumnValues"]
        ),
        sort_columns=[glue_mixins.CfnPartitionPropsMixin.OrderProperty(
            column="column",
            sort_order=123
        )],
        stored_as_sub_directories=False
    ),
    values=["values"]
)

Attributes

parameters

These key-value pairs define partition parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-parameters

storage_descriptor

Provides information about the physical location where the partition is stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-storagedescriptor

values

The values of the partition.

Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values to the wrong keys.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-values

SchemaIdProperty

class CfnPartitionPropsMixin.SchemaIdProperty(*, registry_name=None, schema_arn=None, schema_name=None)

Bases: object

A structure that contains schema identity fields.

Either this or the SchemaVersionId has to be provided.

Parameters:

registry_name (Optional[str]) – The name of the schema registry that contains the schema.
schema_arn (Optional[str]) – The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
schema_name (Optional[str]) – The name of the schema. One of SchemaArn or SchemaName has to be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.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_id_property = glue_mixins.CfnPartitionPropsMixin.SchemaIdProperty(
    registry_name="registryName",
    schema_arn="schemaArn",
    schema_name="schemaName"
)

Attributes

registry_name

The name of the schema registry that contains the schema.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-registryname

schema_arn

The Amazon Resource Name (ARN) of the schema.

One of SchemaArn or SchemaName has to be provided.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-schemaarn

schema_name

The name of the schema.

One of SchemaArn or SchemaName has to be provided.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-schemaname

SchemaReferenceProperty

class CfnPartitionPropsMixin.SchemaReferenceProperty(*, schema_id=None, schema_version_id=None, schema_version_number=None)

Bases: object

An object that references a schema stored in the AWS Glue Schema Registry.

Parameters:

schema_id (Union[IResolvable, SchemaIdProperty, Dict[str, Any], None]) – A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
schema_version_id (Optional[str]) – The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
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-partition-schemareference.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_reference_property = glue_mixins.CfnPartitionPropsMixin.SchemaReferenceProperty(
    schema_id=glue_mixins.CfnPartitionPropsMixin.SchemaIdProperty(
        registry_name="registryName",
        schema_arn="schemaArn",
        schema_name="schemaName"
    ),
    schema_version_id="schemaVersionId",
    schema_version_number=123
)

Attributes

schema_id

A structure that contains schema identity fields.

Either this or the SchemaVersionId has to be provided.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaid

schema_version_id

The unique ID assigned to a version of the schema.

Either this or the SchemaId has to be provided.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaversionid

schema_version_number

The version number of the schema.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaversionnumber

SerdeInfoProperty

class CfnPartitionPropsMixin.SerdeInfoProperty(*, name=None, parameters=None, serialization_library=None)

Bases: object

Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.

Parameters:

name (Optional[str]) – Name of the SerDe.
parameters (Any) – These key-value pairs define initialization parameters for the SerDe.
serialization_library (Optional[str]) – Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.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

# parameters: Any

serde_info_property = glue_mixins.CfnPartitionPropsMixin.SerdeInfoProperty(
    name="name",
    parameters=parameters,
    serialization_library="serializationLibrary"
)

Attributes

name

Name of the SerDe.

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

parameters

These key-value pairs define initialization parameters for the SerDe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-parameters

serialization_library

Usually the class that implements the SerDe.

An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-serializationlibrary

SkewedInfoProperty

class CfnPartitionPropsMixin.SkewedInfoProperty(*, skewed_column_names=None, skewed_column_value_location_maps=None, skewed_column_values=None)

Bases: object

Specifies skewed values in a table.

Skewed values are those that occur with very high frequency.

Parameters:

skewed_column_names (Optional[Sequence[str]]) – A list of names of columns that contain skewed values.
skewed_column_value_location_maps (Any) – A mapping of skewed values to the columns that contain them.
skewed_column_values (Optional[Sequence[str]]) – A list of values that appear so frequently as to be considered skewed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.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

# skewed_column_value_location_maps: Any

skewed_info_property = glue_mixins.CfnPartitionPropsMixin.SkewedInfoProperty(
    skewed_column_names=["skewedColumnNames"],
    skewed_column_value_location_maps=skewed_column_value_location_maps,
    skewed_column_values=["skewedColumnValues"]
)

Attributes

skewed_column_names

A list of names of columns that contain skewed values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnnames

skewed_column_value_location_maps

A mapping of skewed values to the columns that contain them.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvaluelocationmaps

skewed_column_values

A list of values that appear so frequently as to be considered skewed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvalues

StorageDescriptorProperty

class CfnPartitionPropsMixin.StorageDescriptorProperty(*, bucket_columns=None, columns=None, compressed=None, input_format=None, location=None, number_of_buckets=None, output_format=None, parameters=None, schema_reference=None, serde_info=None, skewed_info=None, sort_columns=None, stored_as_sub_directories=None)

Bases: object

Describes the physical storage of table data.

Parameters:

bucket_columns (Optional[Sequence[str]]) – A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
columns (Union[IResolvable, Sequence[Union[IResolvable, ColumnProperty, Dict[str, Any]]], None]) – A list of the Columns in the table.
compressed (Union[bool, IResolvable, None]) – True if the data in the table is compressed, or False if not.
input_format (Optional[str]) – The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.
location (Optional[str]) – The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
number_of_buckets (Union[int, float, None]) – The number of buckets. You must specify this property if the partition contains any dimension columns.
output_format (Optional[str]) – The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.
parameters (Any) – The user-supplied properties in key-value form.
schema_reference (Union[IResolvable, SchemaReferenceProperty, Dict[str, Any], None]) – An object that references a schema stored in the AWS Glue Schema Registry.
serde_info (Union[IResolvable, SerdeInfoProperty, Dict[str, Any], None]) – The serialization/deserialization (SerDe) information.
skewed_info (Union[IResolvable, SkewedInfoProperty, Dict[str, Any], None]) – The information about values that appear frequently in a column (skewed values).
sort_columns (Union[IResolvable, Sequence[Union[IResolvable, OrderProperty, Dict[str, Any]]], None]) – A list specifying the sort order of each bucket in the table.
stored_as_sub_directories (Union[bool, IResolvable, None]) – True if the table data is stored in subdirectories, or False if not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.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

# parameters: Any
# skewed_column_value_location_maps: Any

storage_descriptor_property = glue_mixins.CfnPartitionPropsMixin.StorageDescriptorProperty(
    bucket_columns=["bucketColumns"],
    columns=[glue_mixins.CfnPartitionPropsMixin.ColumnProperty(
        comment="comment",
        name="name",
        type="type"
    )],
    compressed=False,
    input_format="inputFormat",
    location="location",
    number_of_buckets=123,
    output_format="outputFormat",
    parameters=parameters,
    schema_reference=glue_mixins.CfnPartitionPropsMixin.SchemaReferenceProperty(
        schema_id=glue_mixins.CfnPartitionPropsMixin.SchemaIdProperty(
            registry_name="registryName",
            schema_arn="schemaArn",
            schema_name="schemaName"
        ),
        schema_version_id="schemaVersionId",
        schema_version_number=123
    ),
    serde_info=glue_mixins.CfnPartitionPropsMixin.SerdeInfoProperty(
        name="name",
        parameters=parameters,
        serialization_library="serializationLibrary"
    ),
    skewed_info=glue_mixins.CfnPartitionPropsMixin.SkewedInfoProperty(
        skewed_column_names=["skewedColumnNames"],
        skewed_column_value_location_maps=skewed_column_value_location_maps,
        skewed_column_values=["skewedColumnValues"]
    ),
    sort_columns=[glue_mixins.CfnPartitionPropsMixin.OrderProperty(
        column="column",
        sort_order=123
    )],
    stored_as_sub_directories=False
)