CfnTableProps
- class aws_cdk.aws_glue.CfnTableProps(*, catalog_id, database_name, name=None, open_table_format_input=None, table_input=None)
Bases:
objectProperties for defining a
CfnTable.- Parameters:
catalog_id (
str) – The ID of the Data Catalog in which to create theTable.database_name (
str) – The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.name (
Optional[str])open_table_format_input (
Union[IResolvable,OpenTableFormatInputProperty,Dict[str,Any],None]) – Specifies anOpenTableFormatInputstructure when creating an open format table.table_input (
Union[IResolvable,TableInputProperty,Dict[str,Any],None]) – A structure used to define a table.
- See:
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. from aws_cdk import aws_glue as glue # parameters: Any # properties: Any # skewed_column_value_location_maps: Any cfn_table_props = glue.CfnTableProps( catalog_id="catalogId", database_name="databaseName", # the properties below are optional name="name", open_table_format_input=glue.CfnTable.OpenTableFormatInputProperty( iceberg_input=glue.CfnTable.IcebergInputProperty( iceberg_table_input=glue.CfnTable.IcebergTableInputProperty( location="location", schema=glue.CfnTable.IcebergSchemaProperty( fields=[glue.CfnTable.IcebergStructFieldProperty( id=123, name="name", required=False, type="type", # the properties below are optional doc="doc" )], # the properties below are optional identifier_field_ids=[123], schema_id=123, type="type" ), # the properties below are optional partition_spec=glue.CfnTable.IcebergPartitionSpecProperty( fields=[glue.CfnTable.IcebergPartitionFieldProperty( name="name", source_id=123, transform="transform", # the properties below are optional field_id=123 )], # the properties below are optional spec_id=123 ), properties=properties, write_order=glue.CfnTable.IcebergSortOrderProperty( fields=[glue.CfnTable.IcebergSortFieldProperty( direction="direction", null_order="nullOrder", source_id=123, transform="transform" )], order_id=123 ) ), metadata_operation="metadataOperation", version="version" ) ), 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", region="region" ), view_definition=glue.CfnTable.ViewDefinitionProperty( definer="definer", is_protected=False, representations=[glue.CfnTable.ViewRepresentationProperty( dialect="dialect", dialect_version="dialectVersion", validation_connection="validationConnection", view_expanded_text="viewExpandedText", view_original_text="viewOriginalText" )], sub_objects=["subObjects"] ), view_expanded_text="viewExpandedText", view_original_text="viewOriginalText" ) )
Attributes
- catalog_id
The ID of the Data Catalog in which to create the
Table.
- database_name
The name of the database where the table metadata resides.
For Hive compatibility, this must be all lowercase.
- name
-
- Type:
see
- open_table_format_input
Specifies an
OpenTableFormatInputstructure when creating an open format table.
- table_input
A structure used to define a table.