CfnTableProps

class aws_cdk.aws_glue.CfnTableProps(*, catalog_id, database_name, table_input)

Bases: object

Properties for defining a CfnTable.

Parameters
  • catalog_id (str) – The ID of the Data Catalog in which to create the Table . If none is supplied, the AWS account ID is used by default.

  • database_name (str) – The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

  • table_input (Union[IResolvable, TableInputProperty, Dict[str, Any]]) – A structure used to define a table.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_glue as glue

# parameters: Any
# skewed_column_value_location_maps: Any

cfn_table_props = glue.CfnTableProps(
    catalog_id="catalogId",
    database_name="databaseName",
    table_input=glue.CfnTable.TableInputProperty(
        description="description",
        name="name",
        owner="owner",
        parameters=parameters,
        partition_keys=[glue.CfnTable.ColumnProperty(
            name="name",

            # the properties below are optional
            comment="comment",
            type="type"
        )],
        retention=123,
        storage_descriptor=glue.CfnTable.StorageDescriptorProperty(
            bucket_columns=["bucketColumns"],
            columns=[glue.CfnTable.ColumnProperty(
                name="name",

                # the properties below are optional
                comment="comment",
                type="type"
            )],
            compressed=False,
            input_format="inputFormat",
            location="location",
            number_of_buckets=123,
            output_format="outputFormat",
            parameters=parameters,
            schema_reference=glue.CfnTable.SchemaReferenceProperty(
                schema_id=glue.CfnTable.SchemaIdProperty(
                    registry_name="registryName",
                    schema_arn="schemaArn",
                    schema_name="schemaName"
                ),
                schema_version_id="schemaVersionId",
                schema_version_number=123
            ),
            serde_info=glue.CfnTable.SerdeInfoProperty(
                name="name",
                parameters=parameters,
                serialization_library="serializationLibrary"
            ),
            skewed_info=glue.CfnTable.SkewedInfoProperty(
                skewed_column_names=["skewedColumnNames"],
                skewed_column_value_location_maps=skewed_column_value_location_maps,
                skewed_column_values=["skewedColumnValues"]
            ),
            sort_columns=[glue.CfnTable.OrderProperty(
                column="column",
                sort_order=123
            )],
            stored_as_sub_directories=False
        ),
        table_type="tableType",
        target_table=glue.CfnTable.TableIdentifierProperty(
            catalog_id="catalogId",
            database_name="databaseName",
            name="name"
        ),
        view_expanded_text="viewExpandedText",
        view_original_text="viewOriginalText"
    )
)

Attributes

catalog_id

The ID of the Data Catalog in which to create the Table .

If none is supplied, the AWS account ID is used by default.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-catalogid

Return type

str

database_name

The name of the database where the table metadata resides.

For Hive compatibility, this must be all lowercase.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-databasename

Return type

str

table_input

A structure used to define a table.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-tableinput

Return type

Union[IResolvable, TableInputProperty]