CfnTablePropsMixin
- class aws_cdk.cfn_property_mixins.aws_glue.CfnTablePropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::Glue::Tableresource specifies tabular data in the AWS Glue data catalog.For more information, see Defining Tables in the AWS Glue Data Catalog and Table Structure in the AWS Glue Developer Guide .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html
- CloudformationResource:
AWS::Glue::Table
- 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.cfn_property_mixins import aws_glue as glue import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy # parameters: Any # properties: Any # skewed_column_value_location_maps: Any cfn_table_props_mixin = glue.CfnTablePropsMixin(glue.CfnTableMixinProps( catalog_id="catalogId", database_name="databaseName", name="name", open_table_format_input=glue.CfnTablePropsMixin.OpenTableFormatInputProperty( iceberg_input=glue.CfnTablePropsMixin.IcebergInputProperty( iceberg_table_input=glue.CfnTablePropsMixin.IcebergTableInputProperty( location="location", partition_spec=glue.CfnTablePropsMixin.IcebergPartitionSpecProperty( fields=[glue.CfnTablePropsMixin.IcebergPartitionFieldProperty( field_id=123, name="name", source_id=123, transform="transform" )], spec_id=123 ), properties=properties, schema=glue.CfnTablePropsMixin.IcebergSchemaProperty( fields=[glue.CfnTablePropsMixin.IcebergStructFieldProperty( doc="doc", id=123, name="name", required=False, type="type" )], identifier_field_ids=[123], schema_id=123, type="type" ), write_order=glue.CfnTablePropsMixin.IcebergSortOrderProperty( fields=[glue.CfnTablePropsMixin.IcebergSortFieldProperty( direction="direction", null_order="nullOrder", source_id=123, transform="transform" )], order_id=123 ) ), metadata_operation="metadataOperation", version="version" ) ), table_input=glue.CfnTablePropsMixin.TableInputProperty( description="description", name="name", owner="owner", parameters=parameters, partition_keys=[glue.CfnTablePropsMixin.ColumnProperty( comment="comment", name="name", type="type" )], retention=123, storage_descriptor=glue.CfnTablePropsMixin.StorageDescriptorProperty( bucket_columns=["bucketColumns"], columns=[glue.CfnTablePropsMixin.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.CfnTablePropsMixin.SchemaReferenceProperty( schema_id=glue.CfnTablePropsMixin.SchemaIdProperty( registry_name="registryName", schema_arn="schemaArn", schema_name="schemaName" ), schema_version_id="schemaVersionId", schema_version_number=123 ), serde_info=glue.CfnTablePropsMixin.SerdeInfoProperty( name="name", parameters=parameters, serialization_library="serializationLibrary" ), skewed_info=glue.CfnTablePropsMixin.SkewedInfoProperty( skewed_column_names=["skewedColumnNames"], skewed_column_value_location_maps=skewed_column_value_location_maps, skewed_column_values=["skewedColumnValues"] ), sort_columns=[glue.CfnTablePropsMixin.OrderProperty( column="column", sort_order=123 )], stored_as_sub_directories=False ), table_type="tableType", target_table=glue.CfnTablePropsMixin.TableIdentifierProperty( catalog_id="catalogId", database_name="databaseName", name="name", region="region" ), view_definition=glue.CfnTablePropsMixin.ViewDefinitionProperty( definer="definer", is_protected=False, representations=[glue.CfnTablePropsMixin.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" ) ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::Glue::Table.- Parameters:
props (
Union[CfnTableMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['catalogId', 'databaseName', 'name', 'openTableFormatInput', 'tableInput']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
ColumnProperty
- class CfnTablePropsMixin.ColumnProperty(*, comment=None, name=None, type=None)
Bases:
objectA column in a
Table.- Parameters:
comment (
Optional[str]) – A free-form text comment.name (
Optional[str]) – The name of theColumn.type (
Optional[str]) – The data type of theColumn.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-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.cfn_property_mixins import aws_glue as glue column_property = glue.CfnTablePropsMixin.ColumnProperty( comment="comment", name="name", type="type" )
Attributes
- comment
A free-form text comment.
- name
The name of the
Column.
- type
The data type of the
Column.
IcebergInputProperty
- class CfnTablePropsMixin.IcebergInputProperty(*, iceberg_table_input=None, metadata_operation=None, version=None)
Bases:
objectSpecifies an input structure that defines an Apache Iceberg metadata table.
- Parameters:
iceberg_table_input (
Union[IResolvable,IcebergTableInputProperty,Dict[str,Any],None])metadata_operation (
Optional[str]) – A required metadata operation. Can only be set to CREATE.version (
Optional[str]) – The table version for the Iceberg table. Defaults to 2.
- See:
- 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.cfn_property_mixins import aws_glue as glue # properties: Any iceberg_input_property = glue.CfnTablePropsMixin.IcebergInputProperty( iceberg_table_input=glue.CfnTablePropsMixin.IcebergTableInputProperty( location="location", partition_spec=glue.CfnTablePropsMixin.IcebergPartitionSpecProperty( fields=[glue.CfnTablePropsMixin.IcebergPartitionFieldProperty( field_id=123, name="name", source_id=123, transform="transform" )], spec_id=123 ), properties=properties, schema=glue.CfnTablePropsMixin.IcebergSchemaProperty( fields=[glue.CfnTablePropsMixin.IcebergStructFieldProperty( doc="doc", id=123, name="name", required=False, type="type" )], identifier_field_ids=[123], schema_id=123, type="type" ), write_order=glue.CfnTablePropsMixin.IcebergSortOrderProperty( fields=[glue.CfnTablePropsMixin.IcebergSortFieldProperty( direction="direction", null_order="nullOrder", source_id=123, transform="transform" )], order_id=123 ) ), metadata_operation="metadataOperation", version="version" )
Attributes
- iceberg_table_input
-
- Type:
see
- metadata_operation
A required metadata operation.
Can only be set to CREATE.
- version
The table version for the Iceberg table.
Defaults to 2.
IcebergPartitionFieldProperty
- class CfnTablePropsMixin.IcebergPartitionFieldProperty(*, field_id=None, name=None, source_id=None, transform=None)
Bases:
object- Parameters:
field_id (
Union[int,float,None])name (
Optional[str])source_id (
Union[int,float,None])transform (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_glue as glue iceberg_partition_field_property = glue.CfnTablePropsMixin.IcebergPartitionFieldProperty( field_id=123, name="name", source_id=123, transform="transform" )
Attributes
- field_id
-
- Type:
see
- name
-
- Type:
see
- source_id
-
- Type:
see
IcebergPartitionSpecProperty
- class CfnTablePropsMixin.IcebergPartitionSpecProperty(*, fields=None, spec_id=None)
Bases:
object- Parameters:
fields (
Union[IResolvable,Sequence[Union[IResolvable,IcebergPartitionFieldProperty,Dict[str,Any]]],None])spec_id (
Union[int,float,None])
- See:
- 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.cfn_property_mixins import aws_glue as glue iceberg_partition_spec_property = glue.CfnTablePropsMixin.IcebergPartitionSpecProperty( fields=[glue.CfnTablePropsMixin.IcebergPartitionFieldProperty( field_id=123, name="name", source_id=123, transform="transform" )], spec_id=123 )
Attributes
- fields
-
- Type:
see
IcebergSchemaProperty
- class CfnTablePropsMixin.IcebergSchemaProperty(*, fields=None, identifier_field_ids=None, schema_id=None, type=None)
Bases:
object- Parameters:
fields (
Union[IResolvable,Sequence[Union[IResolvable,IcebergStructFieldProperty,Dict[str,Any]]],None])identifier_field_ids (
Union[Sequence[Union[int,float]],IResolvable,None])schema_id (
Union[int,float,None])type (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_glue as glue iceberg_schema_property = glue.CfnTablePropsMixin.IcebergSchemaProperty( fields=[glue.CfnTablePropsMixin.IcebergStructFieldProperty( doc="doc", id=123, name="name", required=False, type="type" )], identifier_field_ids=[123], schema_id=123, type="type" )
Attributes
- fields
-
- Type:
see
- identifier_field_ids
-
- Type:
see
- schema_id
-
- Type:
see
IcebergSortFieldProperty
- class CfnTablePropsMixin.IcebergSortFieldProperty(*, direction=None, null_order=None, source_id=None, transform=None)
Bases:
object- Parameters:
direction (
Optional[str])null_order (
Optional[str])source_id (
Union[int,float,None])transform (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_glue as glue iceberg_sort_field_property = glue.CfnTablePropsMixin.IcebergSortFieldProperty( direction="direction", null_order="nullOrder", source_id=123, transform="transform" )
Attributes
- direction
-
- Type:
see
- null_order
-
- Type:
see
- source_id
-
- Type:
see
IcebergSortOrderProperty
- class CfnTablePropsMixin.IcebergSortOrderProperty(*, fields=None, order_id=None)
Bases:
object- Parameters:
fields (
Union[IResolvable,Sequence[Union[IResolvable,IcebergSortFieldProperty,Dict[str,Any]]],None])order_id (
Union[int,float,None])
- See:
- 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.cfn_property_mixins import aws_glue as glue iceberg_sort_order_property = glue.CfnTablePropsMixin.IcebergSortOrderProperty( fields=[glue.CfnTablePropsMixin.IcebergSortFieldProperty( direction="direction", null_order="nullOrder", source_id=123, transform="transform" )], order_id=123 )
Attributes
- fields
-
- Type:
see
IcebergStructFieldProperty
- class CfnTablePropsMixin.IcebergStructFieldProperty(*, doc=None, id=None, name=None, required=None, type=None)
Bases:
object- Parameters:
doc (
Optional[str])id (
Union[int,float,None])name (
Optional[str])required (
Union[bool,IResolvable,None])type (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_glue as glue iceberg_struct_field_property = glue.CfnTablePropsMixin.IcebergStructFieldProperty( doc="doc", id=123, name="name", required=False, type="type" )
Attributes
- doc
-
- Type:
see
- id
-
- Type:
see
- name
-
- Type:
see
- required
-
- Type:
see
IcebergTableInputProperty
- class CfnTablePropsMixin.IcebergTableInputProperty(*, location=None, partition_spec=None, properties=None, schema=None, write_order=None)
Bases:
object- Parameters:
location (
Optional[str])partition_spec (
Union[IResolvable,IcebergPartitionSpecProperty,Dict[str,Any],None])properties (
Any)schema (
Union[IResolvable,IcebergSchemaProperty,Dict[str,Any],None])write_order (
Union[IResolvable,IcebergSortOrderProperty,Dict[str,Any],None])
- See:
- 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.cfn_property_mixins import aws_glue as glue # properties: Any iceberg_table_input_property = glue.CfnTablePropsMixin.IcebergTableInputProperty( location="location", partition_spec=glue.CfnTablePropsMixin.IcebergPartitionSpecProperty( fields=[glue.CfnTablePropsMixin.IcebergPartitionFieldProperty( field_id=123, name="name", source_id=123, transform="transform" )], spec_id=123 ), properties=properties, schema=glue.CfnTablePropsMixin.IcebergSchemaProperty( fields=[glue.CfnTablePropsMixin.IcebergStructFieldProperty( doc="doc", id=123, name="name", required=False, type="type" )], identifier_field_ids=[123], schema_id=123, type="type" ), write_order=glue.CfnTablePropsMixin.IcebergSortOrderProperty( fields=[glue.CfnTablePropsMixin.IcebergSortFieldProperty( direction="direction", null_order="nullOrder", source_id=123, transform="transform" )], order_id=123 ) )
Attributes
- location
-
- Type:
see
- partition_spec
-
- Type:
see
- properties
-
- Type:
see
- schema
-
- Type:
see
OpenTableFormatInputProperty
- class CfnTablePropsMixin.OpenTableFormatInputProperty(*, iceberg_input=None)
Bases:
objectSpecifies an
OpenTableFormatInputstructure when creating an open format table.- Parameters:
iceberg_input (
Union[IResolvable,IcebergInputProperty,Dict[str,Any],None]) – Specifies anIcebergInputstructure that defines an Apache Iceberg metadata table.- See:
- 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.cfn_property_mixins import aws_glue as glue # properties: Any open_table_format_input_property = glue.CfnTablePropsMixin.OpenTableFormatInputProperty( iceberg_input=glue.CfnTablePropsMixin.IcebergInputProperty( iceberg_table_input=glue.CfnTablePropsMixin.IcebergTableInputProperty( location="location", partition_spec=glue.CfnTablePropsMixin.IcebergPartitionSpecProperty( fields=[glue.CfnTablePropsMixin.IcebergPartitionFieldProperty( field_id=123, name="name", source_id=123, transform="transform" )], spec_id=123 ), properties=properties, schema=glue.CfnTablePropsMixin.IcebergSchemaProperty( fields=[glue.CfnTablePropsMixin.IcebergStructFieldProperty( doc="doc", id=123, name="name", required=False, type="type" )], identifier_field_ids=[123], schema_id=123, type="type" ), write_order=glue.CfnTablePropsMixin.IcebergSortOrderProperty( fields=[glue.CfnTablePropsMixin.IcebergSortFieldProperty( direction="direction", null_order="nullOrder", source_id=123, transform="transform" )], order_id=123 ) ), metadata_operation="metadataOperation", version="version" ) )
Attributes
- iceberg_input
Specifies an
IcebergInputstructure that defines an Apache Iceberg metadata table.
OrderProperty
- class CfnTablePropsMixin.OrderProperty(*, column=None, sort_order=None)
Bases:
objectSpecifies 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-table-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.cfn_property_mixins import aws_glue as glue order_property = glue.CfnTablePropsMixin.OrderProperty( column="column", sort_order=123 )
Attributes
- column
The name of the column.
- sort_order
Indicates that the column is sorted in ascending order (
== 1), or in descending order (==0).
SchemaIdProperty
- class CfnTablePropsMixin.SchemaIdProperty(*, registry_name=None, schema_arn=None, schema_name=None)
Bases:
objectA structure that contains schema identity fields.
Either this or the
SchemaVersionIdhas 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 ofSchemaArnorSchemaNamehas to be provided.schema_name (
Optional[str]) – The name of the schema. One ofSchemaArnorSchemaNamehas to be provided.
- See:
- 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.cfn_property_mixins import aws_glue as glue schema_id_property = glue.CfnTablePropsMixin.SchemaIdProperty( registry_name="registryName", schema_arn="schemaArn", schema_name="schemaName" )
Attributes
- registry_name
The name of the schema registry that contains the schema.
- schema_arn
The Amazon Resource Name (ARN) of the schema.
One of
SchemaArnorSchemaNamehas to be provided.
- schema_name
The name of the schema.
One of
SchemaArnorSchemaNamehas to be provided.
SchemaReferenceProperty
- class CfnTablePropsMixin.SchemaReferenceProperty(*, schema_id=None, schema_version_id=None, schema_version_number=None)
Bases:
objectAn 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 theSchemaVersionIdhas to be provided.schema_version_id (
Optional[str]) – The unique ID assigned to a version of the schema. Either this or theSchemaIdhas to be provided.schema_version_number (
Union[int,float,None]) – The version number of the schema.
- See:
- 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.cfn_property_mixins import aws_glue as glue schema_reference_property = glue.CfnTablePropsMixin.SchemaReferenceProperty( schema_id=glue.CfnTablePropsMixin.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
SchemaVersionIdhas to be provided.
- schema_version_id
The unique ID assigned to a version of the schema.
Either this or the
SchemaIdhas to be provided.
- schema_version_number
The version number of the schema.
SerdeInfoProperty
- class CfnTablePropsMixin.SerdeInfoProperty(*, name=None, parameters=None, serialization_library=None)
Bases:
objectInformation 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 isorg.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
- See:
- 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.cfn_property_mixins import aws_glue as glue # parameters: Any serde_info_property = glue.CfnTablePropsMixin.SerdeInfoProperty( name="name", parameters=parameters, serialization_library="serializationLibrary" )
Attributes
- name
Name of the SerDe.
- parameters
These key-value pairs define initialization parameters for the SerDe.
- serialization_library
Usually the class that implements the SerDe.
An example is
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
SkewedInfoProperty
- class CfnTablePropsMixin.SkewedInfoProperty(*, skewed_column_names=None, skewed_column_value_location_maps=None, skewed_column_values=None)
Bases:
objectSpecifies 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:
- 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.cfn_property_mixins import aws_glue as glue # skewed_column_value_location_maps: Any skewed_info_property = glue.CfnTablePropsMixin.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.
- skewed_column_value_location_maps
A mapping of skewed values to the columns that contain them.
- skewed_column_values
A list of values that appear so frequently as to be considered skewed.
StorageDescriptorProperty
- class CfnTablePropsMixin.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:
objectDescribes 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 theColumnsin the table.compressed (
Union[bool,IResolvable,None]) –Trueif the data in the table is compressed, orFalseif not.input_format (
Optional[str]) – The input format:SequenceFileInputFormat(binary), orTextInputFormat, 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]) – Must be specified if the table contains any dimension columns.output_format (
Optional[str]) – The output format:SequenceFileOutputFormat(binary), orIgnoreKeyTextOutputFormat, 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]) –Trueif the table data is stored in subdirectories, orFalseif not.
- See:
- 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.cfn_property_mixins import aws_glue as glue # parameters: Any # skewed_column_value_location_maps: Any storage_descriptor_property = glue.CfnTablePropsMixin.StorageDescriptorProperty( bucket_columns=["bucketColumns"], columns=[glue.CfnTablePropsMixin.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.CfnTablePropsMixin.SchemaReferenceProperty( schema_id=glue.CfnTablePropsMixin.SchemaIdProperty( registry_name="registryName", schema_arn="schemaArn", schema_name="schemaName" ), schema_version_id="schemaVersionId", schema_version_number=123 ), serde_info=glue.CfnTablePropsMixin.SerdeInfoProperty( name="name", parameters=parameters, serialization_library="serializationLibrary" ), skewed_info=glue.CfnTablePropsMixin.SkewedInfoProperty( skewed_column_names=["skewedColumnNames"], skewed_column_value_location_maps=skewed_column_value_location_maps, skewed_column_values=["skewedColumnValues"] ), sort_columns=[glue.CfnTablePropsMixin.OrderProperty( column="column", sort_order=123 )], stored_as_sub_directories=False )
Attributes
- bucket_columns
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
- columns
A list of the
Columnsin the table.
- compressed
Trueif the data in the table is compressed, orFalseif not.
- input_format
SequenceFileInputFormat(binary), orTextInputFormat, or a custom format.
- location
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
Must be specified if the table contains any dimension columns.
- output_format
SequenceFileOutputFormat(binary), orIgnoreKeyTextOutputFormat, or a custom format.
- parameters
The user-supplied properties in key-value form.
- schema_reference
An object that references a schema stored in the AWS Glue Schema Registry.
- serde_info
The serialization/deserialization (SerDe) information.
- skewed_info
The information about values that appear frequently in a column (skewed values).
- sort_columns
A list specifying the sort order of each bucket in the table.
- stored_as_sub_directories
Trueif the table data is stored in subdirectories, orFalseif not.
TableIdentifierProperty
- class CfnTablePropsMixin.TableIdentifierProperty(*, catalog_id=None, database_name=None, name=None, region=None)
Bases:
objectA structure that describes a target table for resource linking.
- Parameters:
catalog_id (
Optional[str]) – The ID of the Data Catalog in which the table resides.database_name (
Optional[str]) – The name of the catalog database that contains the target table.name (
Optional[str]) – The name of the target table.region (
Optional[str]) – The Region of the table.
- See:
- 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.cfn_property_mixins import aws_glue as glue table_identifier_property = glue.CfnTablePropsMixin.TableIdentifierProperty( catalog_id="catalogId", database_name="databaseName", name="name", region="region" )
Attributes
- catalog_id
The ID of the Data Catalog in which the table resides.
- database_name
The name of the catalog database that contains the target table.
- name
The name of the target table.
- region
The Region of the table.
TableInputProperty
- class CfnTablePropsMixin.TableInputProperty(*, description=None, name=None, owner=None, parameters=None, partition_keys=None, retention=None, storage_descriptor=None, table_type=None, target_table=None, view_definition=None, view_expanded_text=None, view_original_text=None)
Bases:
objectA structure used to define a table.
- Parameters:
description (
Optional[str]) – A description of the table.name (
Optional[str]) – The table name. For Hive compatibility, this is folded to lowercase when it is stored.owner (
Optional[str]) – The table owner. Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.parameters (
Any) – These key-value pairs define properties associated with the table.partition_keys (
Union[IResolvable,Sequence[Union[IResolvable,ColumnProperty,Dict[str,Any]]],None]) – A list of columns by which the table is partitioned. Only primitive types are supported as partition keys. When you create a table used by Amazon Athena, and you do not specify anypartitionKeys, you must at least set the value ofpartitionKeysto an empty list. For example:"PartitionKeys": []retention (
Union[int,float,None]) – The retention time for this table.storage_descriptor (
Union[IResolvable,StorageDescriptorProperty,Dict[str,Any],None]) – A storage descriptor containing information about the physical storage of this table.table_type (
Optional[str]) – The type of this table. AWS Glue will create tables with theEXTERNAL_TABLEtype. Other services, such as Athena, may create tables with additional table types. AWS Glue related table types: - EXTERNAL_TABLE - Hive compatible attribute - indicates a non-Hive managed table. - GOVERNED - Used by AWS Lake Formation . The AWS Glue Data Catalog understandsGOVERNED.target_table (
Union[IResolvable,TableIdentifierProperty,Dict[str,Any],None]) – ATableIdentifierstructure that describes a target table for resource linking.view_definition (
Union[IResolvable,ViewDefinitionProperty,Dict[str,Any],None])view_expanded_text (
Optional[str]) – Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.view_original_text (
Optional[str]) – Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations. If the table is aVIRTUAL_VIEW, certain Athena configuration encoded in base64.
- See:
- 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.cfn_property_mixins import aws_glue as glue # parameters: Any # skewed_column_value_location_maps: Any table_input_property = glue.CfnTablePropsMixin.TableInputProperty( description="description", name="name", owner="owner", parameters=parameters, partition_keys=[glue.CfnTablePropsMixin.ColumnProperty( comment="comment", name="name", type="type" )], retention=123, storage_descriptor=glue.CfnTablePropsMixin.StorageDescriptorProperty( bucket_columns=["bucketColumns"], columns=[glue.CfnTablePropsMixin.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.CfnTablePropsMixin.SchemaReferenceProperty( schema_id=glue.CfnTablePropsMixin.SchemaIdProperty( registry_name="registryName", schema_arn="schemaArn", schema_name="schemaName" ), schema_version_id="schemaVersionId", schema_version_number=123 ), serde_info=glue.CfnTablePropsMixin.SerdeInfoProperty( name="name", parameters=parameters, serialization_library="serializationLibrary" ), skewed_info=glue.CfnTablePropsMixin.SkewedInfoProperty( skewed_column_names=["skewedColumnNames"], skewed_column_value_location_maps=skewed_column_value_location_maps, skewed_column_values=["skewedColumnValues"] ), sort_columns=[glue.CfnTablePropsMixin.OrderProperty( column="column", sort_order=123 )], stored_as_sub_directories=False ), table_type="tableType", target_table=glue.CfnTablePropsMixin.TableIdentifierProperty( catalog_id="catalogId", database_name="databaseName", name="name", region="region" ), view_definition=glue.CfnTablePropsMixin.ViewDefinitionProperty( definer="definer", is_protected=False, representations=[glue.CfnTablePropsMixin.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
- description
A description of the table.
- name
The table name.
For Hive compatibility, this is folded to lowercase when it is stored.
- owner
The table owner.
Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.
- parameters
These key-value pairs define properties associated with the table.
- partition_keys
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys, you must at least set the value ofpartitionKeysto an empty list. For example:"PartitionKeys": []
- retention
The retention time for this table.
- storage_descriptor
A storage descriptor containing information about the physical storage of this table.
- table_type
The type of this table.
AWS Glue will create tables with the
EXTERNAL_TABLEtype. Other services, such as Athena, may create tables with additional table types.AWS Glue related table types:
EXTERNAL_TABLE - Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED - Used by AWS Lake Formation . The AWS Glue Data Catalog understands
GOVERNED.
- target_table
A
TableIdentifierstructure that describes a target table for resource linking.
- view_definition
-
- Type:
see
- view_expanded_text
Included for Apache Hive compatibility.
Not used in the normal course of AWS Glue operations.
- view_original_text
Included for Apache Hive compatibility.
Not used in the normal course of AWS Glue operations. If the table is a
VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewDefinitionProperty
- class CfnTablePropsMixin.ViewDefinitionProperty(*, definer=None, is_protected=None, representations=None, sub_objects=None)
Bases:
object- Parameters:
definer (
Optional[str])is_protected (
Union[bool,IResolvable,None])representations (
Union[IResolvable,Sequence[Union[IResolvable,ViewRepresentationProperty,Dict[str,Any]]],None])sub_objects (
Optional[Sequence[str]])
- See:
- 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.cfn_property_mixins import aws_glue as glue view_definition_property = glue.CfnTablePropsMixin.ViewDefinitionProperty( definer="definer", is_protected=False, representations=[glue.CfnTablePropsMixin.ViewRepresentationProperty( dialect="dialect", dialect_version="dialectVersion", validation_connection="validationConnection", view_expanded_text="viewExpandedText", view_original_text="viewOriginalText" )], sub_objects=["subObjects"] )
Attributes
- definer
-
- Type:
see
- is_protected
-
- Type:
see
- representations
-
- Type:
see
ViewRepresentationProperty
- class CfnTablePropsMixin.ViewRepresentationProperty(*, dialect=None, dialect_version=None, validation_connection=None, view_expanded_text=None, view_original_text=None)
Bases:
object- Parameters:
dialect (
Optional[str])dialect_version (
Optional[str])validation_connection (
Optional[str])view_expanded_text (
Optional[str])view_original_text (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_glue as glue view_representation_property = glue.CfnTablePropsMixin.ViewRepresentationProperty( dialect="dialect", dialect_version="dialectVersion", validation_connection="validationConnection", view_expanded_text="viewExpandedText", view_original_text="viewOriginalText" )
Attributes
- dialect
-
- Type:
see
- dialect_version
-
- Type:
see
- validation_connection
-
- Type:
see
- view_expanded_text
-
- Type:
see