Data Source: awsGlueCatalogTable
This data source can be used to fetch information about an AWS Glue Data Catalog Table.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsGlueCatalogTable.DataAwsGlueCatalogTable(this, "example", {
databaseName: "MyCatalogDatabase",
name: "MyCatalogTable",
});
Argument Reference
The following arguments are supported:
name
- (Required) Name of the table.databaseName
- (Required) Name of the metadata database where the table metadata resides.catalogId
- (Optional) ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.queryAsOfTime
- (Optional) The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along withtransactionId
. Specified in RFC 3339 format, e.g.20060102T15:04:05Z07:00
.transactionId
- (Optional) The transaction ID at which to read the table contents.
Attributes Reference
id
- Catalog ID, Database name and of the name table.arn
- The ARN of the Glue Table.description
- Description of the table.owner
- Owner of the table.parameters
- Properties associated with this table, as a list of key-value pairs.partitionIndex
- Configuration block for a maximum of 3 partition indexes. SeepartitionIndex
below.partitionKeys
- Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. SeepartitionKeys
below.retention
- Retention time for this table.storageDescriptor
- Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. SeestorageDescriptor
below.tableType
- Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such asalterTable
andshowCreateTable
will fail if this argument is empty.targetTable
- Configuration block of a target table for resource linking. SeetargetTable
below.viewExpandedText
- If the table is a view, the expanded text of the view; otherwise null.viewOriginalText
- If the table is a view, the original text of the view; otherwise null.
partitionIndex
indexName
- Name of the partition index.keys
- Keys for the partition index.
partitionKeys
comment
- Free-form text comment.name
- Name of the Partition Key.type
- Datatype of data in the Partition Key.
storageDescriptor
bucketColumns
- List of reducer grouping columns, clustering columns, and bucketing columns in the table.columns
- Configuration block for columns in the table. Seecolumns
below.compressed
- Whether the data in the table is compressed.inputFormat
- Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.location
- 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.numberOfBuckets
- Is if the table contains any dimension columns.outputFormat
- Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.parameters
- User-supplied properties in key-value form.schemaReference
- Object that references a schema stored in the AWS Glue Schema Registry. SeeschemaReference
below.serDeInfo
- Configuration block for serialization and deserialization ("SerDe") information. SeeserDeInfo
below.skewedInfo
- Configuration block with information about values that appear very frequently in a column (skewed values). SeeskewedInfo
below.sortColumns
- Configuration block for the sort order of each bucket in the table. SeesortColumns
below.storedAsSubDirectories
- Whether the table data is stored in subdirectories.
columns
comment
- Free-form text comment.name
- Name of the Column.parameters
- Key-value pairs defining properties associated with the column.type
- Datatype of data in the Column.
schemaReference
schemaId
- Configuration block that contains schema identity fields. SeeschemaId
below.schemaVersionId
- Unique ID assigned to a version of the schema.schemaVersionNumber
- Version number of the schema.
schemaId
registryName
- Name of the schema registry that contains the schema.schemaArn
- ARN of the schema.schemaName
- Name of the schema.
serDeInfo
name
- Name of the SerDe.parameters
- Map of initialization parameters for the SerDe, in key-value form.serializationLibrary
- Usually the class that implements the SerDe. An example isorgApacheHadoopHiveSerde2ColumnarColumnarSerDe
.
sortColumns
column
- Name of the column.sortOrder
- Whether the column is sorted in ascending (1
) or descending order (0
).
skewedInfo
skewedColumnNames
- List of names of columns that contain skewed values.skewedColumnValueLocationMaps
- List of values that appear so frequently as to be considered skewed.skewedColumnValues
- Map of skewed values to the columns that contain them.
targetTable
catalogId
- ID of the Data Catalog in which the table resides.databaseName
- Name of the catalog database that contains the target table.name
- Name of the target table.