Docs Home
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
aws.glue.CatalogTable
Explore with Pulumi AI
Provides a Glue Catalog Table Resource. You can refer to the Glue Developer Guide for a full explanation of the Glue Data Catalog functionality.
Example Usage
Basic Table
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
name: "MyCatalogTable",
databaseName: "MyCatalogDatabase",
});
import pulumi
import pulumi_aws as aws
aws_glue_catalog_table = aws.glue.CatalogTable("aws_glue_catalog_table",
name="MyCatalogTable",
database_name="MyCatalogDatabase")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := glue.NewCatalogTable(ctx, "aws_glue_catalog_table", &glue.CatalogTableArgs{
Name: pulumi.String("MyCatalogTable"),
DatabaseName: pulumi.String("MyCatalogDatabase"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var awsGlueCatalogTable = new Aws.Glue.CatalogTable("aws_glue_catalog_table", new()
{
Name = "MyCatalogTable",
DatabaseName = "MyCatalogDatabase",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.CatalogTable;
import com.pulumi.aws.glue.CatalogTableArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var awsGlueCatalogTable = new CatalogTable("awsGlueCatalogTable", CatalogTableArgs.builder()
.name("MyCatalogTable")
.databaseName("MyCatalogDatabase")
.build());
}
}
resources:
awsGlueCatalogTable:
type: aws:glue:CatalogTable
name: aws_glue_catalog_table
properties:
name: MyCatalogTable
databaseName: MyCatalogDatabase
Parquet Table for Athena
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
name: "MyCatalogTable",
databaseName: "MyCatalogDatabase",
tableType: "EXTERNAL_TABLE",
parameters: {
EXTERNAL: "TRUE",
"parquet.compression": "SNAPPY",
},
storageDescriptor: {
location: "s3://my-bucket/event-streams/my-stream",
inputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
outputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
serDeInfo: {
name: "my-stream",
serializationLibrary: "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
parameters: {
"serialization.format": "1",
},
},
columns: [
{
name: "my_string",
type: "string",
},
{
name: "my_double",
type: "double",
},
{
name: "my_date",
type: "date",
comment: "",
},
{
name: "my_bigint",
type: "bigint",
comment: "",
},
{
name: "my_struct",
type: "struct<my_nested_string:string>",
comment: "",
},
],
},
});
import pulumi
import pulumi_aws as aws
aws_glue_catalog_table = aws.glue.CatalogTable("aws_glue_catalog_table",
name="MyCatalogTable",
database_name="MyCatalogDatabase",
table_type="EXTERNAL_TABLE",
parameters={
"EXTERNAL": "TRUE",
"parquet.compression": "SNAPPY",
},
storage_descriptor={
"location": "s3://my-bucket/event-streams/my-stream",
"input_format": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
"output_format": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
"ser_de_info": {
"name": "my-stream",
"serialization_library": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
"parameters": {
"serialization.format": "1",
},
},
"columns": [
{
"name": "my_string",
"type": "string",
},
{
"name": "my_double",
"type": "double",
},
{
"name": "my_date",
"type": "date",
"comment": "",
},
{
"name": "my_bigint",
"type": "bigint",
"comment": "",
},
{
"name": "my_struct",
"type": "struct<my_nested_string:string>",
"comment": "",
},
],
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := glue.NewCatalogTable(ctx, "aws_glue_catalog_table", &glue.CatalogTableArgs{
Name: pulumi.String("MyCatalogTable"),
DatabaseName: pulumi.String("MyCatalogDatabase"),
TableType: pulumi.String("EXTERNAL_TABLE"),
Parameters: pulumi.StringMap{
"EXTERNAL": pulumi.String("TRUE"),
"parquet.compression": pulumi.String("SNAPPY"),
},
StorageDescriptor: &glue.CatalogTableStorageDescriptorArgs{
Location: pulumi.String("s3://my-bucket/event-streams/my-stream"),
InputFormat: pulumi.String("org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat"),
OutputFormat: pulumi.String("org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat"),
SerDeInfo: &glue.CatalogTableStorageDescriptorSerDeInfoArgs{
Name: pulumi.String("my-stream"),
SerializationLibrary: pulumi.String("org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe"),
Parameters: pulumi.StringMap{
"serialization.format": pulumi.String("1"),
},
},
Columns: glue.CatalogTableStorageDescriptorColumnArray{
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("my_string"),
Type: pulumi.String("string"),
},
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("my_double"),
Type: pulumi.String("double"),
},
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("my_date"),
Type: pulumi.String("date"),
Comment: pulumi.String(""),
},
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("my_bigint"),
Type: pulumi.String("bigint"),
Comment: pulumi.String(""),
},
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("my_struct"),
Type: pulumi.String("struct<my_nested_string:string>"),
Comment: pulumi.String(""),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var awsGlueCatalogTable = new Aws.Glue.CatalogTable("aws_glue_catalog_table", new()
{
Name = "MyCatalogTable",
DatabaseName = "MyCatalogDatabase",
TableType = "EXTERNAL_TABLE",
Parameters =
{
{ "EXTERNAL", "TRUE" },
{ "parquet.compression", "SNAPPY" },
},
StorageDescriptor = new Aws.Glue.Inputs.CatalogTableStorageDescriptorArgs
{
Location = "s3://my-bucket/event-streams/my-stream",
InputFormat = "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
OutputFormat = "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
SerDeInfo = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSerDeInfoArgs
{
Name = "my-stream",
SerializationLibrary = "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
Parameters =
{
{ "serialization.format", "1" },
},
},
Columns = new[]
{
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "my_string",
Type = "string",
},
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "my_double",
Type = "double",
},
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "my_date",
Type = "date",
Comment = "",
},
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "my_bigint",
Type = "bigint",
Comment = "",
},
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "my_struct",
Type = "struct<my_nested_string:string>",
Comment = "",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.CatalogTable;
import com.pulumi.aws.glue.CatalogTableArgs;
import com.pulumi.aws.glue.inputs.CatalogTableStorageDescriptorArgs;
import com.pulumi.aws.glue.inputs.CatalogTableStorageDescriptorSerDeInfoArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var awsGlueCatalogTable = new CatalogTable("awsGlueCatalogTable", CatalogTableArgs.builder()
.name("MyCatalogTable")
.databaseName("MyCatalogDatabase")
.tableType("EXTERNAL_TABLE")
.parameters(Map.ofEntries(
Map.entry("EXTERNAL", "TRUE"),
Map.entry("parquet.compression", "SNAPPY")
))
.storageDescriptor(CatalogTableStorageDescriptorArgs.builder()
.location("s3://my-bucket/event-streams/my-stream")
.inputFormat("org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat")
.outputFormat("org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat")
.serDeInfo(CatalogTableStorageDescriptorSerDeInfoArgs.builder()
.name("my-stream")
.serializationLibrary("org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe")
.parameters(Map.of("serialization.format", "1"))
.build())
.columns(
CatalogTableStorageDescriptorColumnArgs.builder()
.name("my_string")
.type("string")
.build(),
CatalogTableStorageDescriptorColumnArgs.builder()
.name("my_double")
.type("double")
.build(),
CatalogTableStorageDescriptorColumnArgs.builder()
.name("my_date")
.type("date")
.comment("")
.build(),
CatalogTableStorageDescriptorColumnArgs.builder()
.name("my_bigint")
.type("bigint")
.comment("")
.build(),
CatalogTableStorageDescriptorColumnArgs.builder()
.name("my_struct")
.type("struct<my_nested_string:string>")
.comment("")
.build())
.build())
.build());
}
}
resources:
awsGlueCatalogTable:
type: aws:glue:CatalogTable
name: aws_glue_catalog_table
properties:
name: MyCatalogTable
databaseName: MyCatalogDatabase
tableType: EXTERNAL_TABLE
parameters:
EXTERNAL: TRUE
parquet.compression: SNAPPY
storageDescriptor:
location: s3://my-bucket/event-streams/my-stream
inputFormat: org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat
outputFormat: org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat
serDeInfo:
name: my-stream
serializationLibrary: org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe
parameters:
serialization.format: 1
columns:
- name: my_string
type: string
- name: my_double
type: double
- name: my_date
type: date
comment: ""
- name: my_bigint
type: bigint
comment: ""
- name: my_struct
type: struct<my_nested_string:string>
comment: ""
Create CatalogTable Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CatalogTable(name: string, args: CatalogTableArgs, opts?: CustomResourceOptions);@overload
def CatalogTable(resource_name: str,
args: CatalogTableArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CatalogTable(resource_name: str,
opts: Optional[ResourceOptions] = None,
database_name: Optional[str] = None,
parameters: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
open_table_format_input: Optional[CatalogTableOpenTableFormatInputArgs] = None,
owner: Optional[str] = None,
catalog_id: Optional[str] = None,
partition_indices: Optional[Sequence[CatalogTablePartitionIndexArgs]] = None,
partition_keys: Optional[Sequence[CatalogTablePartitionKeyArgs]] = None,
retention: Optional[int] = None,
storage_descriptor: Optional[CatalogTableStorageDescriptorArgs] = None,
table_type: Optional[str] = None,
target_table: Optional[CatalogTableTargetTableArgs] = None,
view_expanded_text: Optional[str] = None,
view_original_text: Optional[str] = None)func NewCatalogTable(ctx *Context, name string, args CatalogTableArgs, opts ...ResourceOption) (*CatalogTable, error)public CatalogTable(string name, CatalogTableArgs args, CustomResourceOptions? opts = null)
public CatalogTable(String name, CatalogTableArgs args)
public CatalogTable(String name, CatalogTableArgs args, CustomResourceOptions options)
type: aws:glue:CatalogTable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CatalogTableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CatalogTableArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CatalogTableArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CatalogTableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CatalogTableArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var catalogTableResource = new Aws.Glue.CatalogTable("catalogTableResource", new()
{
DatabaseName = "string",
Parameters =
{
{ "string", "string" },
},
Description = "string",
Name = "string",
OpenTableFormatInput = new Aws.Glue.Inputs.CatalogTableOpenTableFormatInputArgs
{
IcebergInput = new Aws.Glue.Inputs.CatalogTableOpenTableFormatInputIcebergInputArgs
{
MetadataOperation = "string",
Version = "string",
},
},
Owner = "string",
CatalogId = "string",
PartitionIndices = new[]
{
new Aws.Glue.Inputs.CatalogTablePartitionIndexArgs
{
IndexName = "string",
Keys = new[]
{
"string",
},
IndexStatus = "string",
},
},
PartitionKeys = new[]
{
new Aws.Glue.Inputs.CatalogTablePartitionKeyArgs
{
Name = "string",
Comment = "string",
Type = "string",
},
},
Retention = 0,
StorageDescriptor = new Aws.Glue.Inputs.CatalogTableStorageDescriptorArgs
{
AdditionalLocations = new[]
{
"string",
},
BucketColumns = new[]
{
"string",
},
Columns = new[]
{
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "string",
Comment = "string",
Parameters =
{
{ "string", "string" },
},
Type = "string",
},
},
Compressed = false,
InputFormat = "string",
Location = "string",
NumberOfBuckets = 0,
OutputFormat = "string",
Parameters =
{
{ "string", "string" },
},
SchemaReference = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSchemaReferenceArgs
{
SchemaVersionNumber = 0,
SchemaId = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSchemaReferenceSchemaIdArgs
{
RegistryName = "string",
SchemaArn = "string",
SchemaName = "string",
},
SchemaVersionId = "string",
},
SerDeInfo = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSerDeInfoArgs
{
Name = "string",
Parameters =
{
{ "string", "string" },
},
SerializationLibrary = "string",
},
SkewedInfo = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSkewedInfoArgs
{
SkewedColumnNames = new[]
{
"string",
},
SkewedColumnValueLocationMaps =
{
{ "string", "string" },
},
SkewedColumnValues = new[]
{
"string",
},
},
SortColumns = new[]
{
new Aws.Glue.Inputs.CatalogTableStorageDescriptorSortColumnArgs
{
Column = "string",
SortOrder = 0,
},
},
StoredAsSubDirectories = false,
},
TableType = "string",
TargetTable = new Aws.Glue.Inputs.CatalogTableTargetTableArgs
{
CatalogId = "string",
DatabaseName = "string",
Name = "string",
Region = "string",
},
ViewExpandedText = "string",
ViewOriginalText = "string",
});
example, err := glue.NewCatalogTable(ctx, "catalogTableResource", &glue.CatalogTableArgs{
DatabaseName: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
OpenTableFormatInput: &glue.CatalogTableOpenTableFormatInputArgs{
IcebergInput: &glue.CatalogTableOpenTableFormatInputIcebergInputArgs{
MetadataOperation: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
Owner: pulumi.String("string"),
CatalogId: pulumi.String("string"),
PartitionIndices: glue.CatalogTablePartitionIndexArray{
&glue.CatalogTablePartitionIndexArgs{
IndexName: pulumi.String("string"),
Keys: pulumi.StringArray{
pulumi.String("string"),
},
IndexStatus: pulumi.String("string"),
},
},
PartitionKeys: glue.CatalogTablePartitionKeyArray{
&glue.CatalogTablePartitionKeyArgs{
Name: pulumi.String("string"),
Comment: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Retention: pulumi.Int(0),
StorageDescriptor: &glue.CatalogTableStorageDescriptorArgs{
AdditionalLocations: pulumi.StringArray{
pulumi.String("string"),
},
BucketColumns: pulumi.StringArray{
pulumi.String("string"),
},
Columns: glue.CatalogTableStorageDescriptorColumnArray{
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("string"),
Comment: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Type: pulumi.String("string"),
},
},
Compressed: pulumi.Bool(false),
InputFormat: pulumi.String("string"),
Location: pulumi.String("string"),
NumberOfBuckets: pulumi.Int(0),
OutputFormat: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
SchemaReference: &glue.CatalogTableStorageDescriptorSchemaReferenceArgs{
SchemaVersionNumber: pulumi.Int(0),
SchemaId: &glue.CatalogTableStorageDescriptorSchemaReferenceSchemaIdArgs{
RegistryName: pulumi.String("string"),
SchemaArn: pulumi.String("string"),
SchemaName: pulumi.String("string"),
},
SchemaVersionId: pulumi.String("string"),
},
SerDeInfo: &glue.CatalogTableStorageDescriptorSerDeInfoArgs{
Name: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
SerializationLibrary: pulumi.String("string"),
},
SkewedInfo: &glue.CatalogTableStorageDescriptorSkewedInfoArgs{
SkewedColumnNames: pulumi.StringArray{
pulumi.String("string"),
},
SkewedColumnValueLocationMaps: pulumi.StringMap{
"string": pulumi.String("string"),
},
SkewedColumnValues: pulumi.StringArray{
pulumi.String("string"),
},
},
SortColumns: glue.CatalogTableStorageDescriptorSortColumnArray{
&glue.CatalogTableStorageDescriptorSortColumnArgs{
Column: pulumi.String("string"),
SortOrder: pulumi.Int(0),
},
},
StoredAsSubDirectories: pulumi.Bool(false),
},
TableType: pulumi.String("string"),
TargetTable: &glue.CatalogTableTargetTableArgs{
CatalogId: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
},
ViewExpandedText: pulumi.String("string"),
ViewOriginalText: pulumi.String("string"),
})
var catalogTableResource = new CatalogTable("catalogTableResource", CatalogTableArgs.builder()
.databaseName("string")
.parameters(Map.of("string", "string"))
.description("string")
.name("string")
.openTableFormatInput(CatalogTableOpenTableFormatInputArgs.builder()
.icebergInput(CatalogTableOpenTableFormatInputIcebergInputArgs.builder()
.metadataOperation("string")
.version("string")
.build())
.build())
.owner("string")
.catalogId("string")
.partitionIndices(CatalogTablePartitionIndexArgs.builder()
.indexName("string")
.keys("string")
.indexStatus("string")
.build())
.partitionKeys(CatalogTablePartitionKeyArgs.builder()
.name("string")
.comment("string")
.type("string")
.build())
.retention(0)
.storageDescriptor(CatalogTableStorageDescriptorArgs.builder()
.additionalLocations("string")
.bucketColumns("string")
.columns(CatalogTableStorageDescriptorColumnArgs.builder()
.name("string")
.comment("string")
.parameters(Map.of("string", "string"))
.type("string")
.build())
.compressed(false)
.inputFormat("string")
.location("string")
.numberOfBuckets(0)
.outputFormat("string")
.parameters(Map.of("string", "string"))
.schemaReference(CatalogTableStorageDescriptorSchemaReferenceArgs.builder()
.schemaVersionNumber(0)
.schemaId(CatalogTableStorageDescriptorSchemaReferenceSchemaIdArgs.builder()
.registryName("string")
.schemaArn("string")
.schemaName("string")
.build())
.schemaVersionId("string")
.build())
.serDeInfo(CatalogTableStorageDescriptorSerDeInfoArgs.builder()
.name("string")
.parameters(Map.of("string", "string"))
.serializationLibrary("string")
.build())
.skewedInfo(CatalogTableStorageDescriptorSkewedInfoArgs.builder()
.skewedColumnNames("string")
.skewedColumnValueLocationMaps(Map.of("string", "string"))
.skewedColumnValues("string")
.build())
.sortColumns(CatalogTableStorageDescriptorSortColumnArgs.builder()
.column("string")
.sortOrder(0)
.build())
.storedAsSubDirectories(false)
.build())
.tableType("string")
.targetTable(CatalogTableTargetTableArgs.builder()
.catalogId("string")
.databaseName("string")
.name("string")
.region("string")
.build())
.viewExpandedText("string")
.viewOriginalText("string")
.build());
catalog_table_resource = aws.glue.CatalogTable("catalogTableResource",
database_name="string",
parameters={
"string": "string",
},
description="string",
name="string",
open_table_format_input={
"iceberg_input": {
"metadata_operation": "string",
"version": "string",
},
},
owner="string",
catalog_id="string",
partition_indices=[{
"index_name": "string",
"keys": ["string"],
"index_status": "string",
}],
partition_keys=[{
"name": "string",
"comment": "string",
"type": "string",
}],
retention=0,
storage_descriptor={
"additional_locations": ["string"],
"bucket_columns": ["string"],
"columns": [{
"name": "string",
"comment": "string",
"parameters": {
"string": "string",
},
"type": "string",
}],
"compressed": False,
"input_format": "string",
"location": "string",
"number_of_buckets": 0,
"output_format": "string",
"parameters": {
"string": "string",
},
"schema_reference": {
"schema_version_number": 0,
"schema_id": {
"registry_name": "string",
"schema_arn": "string",
"schema_name": "string",
},
"schema_version_id": "string",
},
"ser_de_info": {
"name": "string",
"parameters": {
"string": "string",
},
"serialization_library": "string",
},
"skewed_info": {
"skewed_column_names": ["string"],
"skewed_column_value_location_maps": {
"string": "string",
},
"skewed_column_values": ["string"],
},
"sort_columns": [{
"column": "string",
"sort_order": 0,
}],
"stored_as_sub_directories": False,
},
table_type="string",
target_table={
"catalog_id": "string",
"database_name": "string",
"name": "string",
"region": "string",
},
view_expanded_text="string",
view_original_text="string")
const catalogTableResource = new aws.glue.CatalogTable("catalogTableResource", {
databaseName: "string",
parameters: {
string: "string",
},
description: "string",
name: "string",
openTableFormatInput: {
icebergInput: {
metadataOperation: "string",
version: "string",
},
},
owner: "string",
catalogId: "string",
partitionIndices: [{
indexName: "string",
keys: ["string"],
indexStatus: "string",
}],
partitionKeys: [{
name: "string",
comment: "string",
type: "string",
}],
retention: 0,
storageDescriptor: {
additionalLocations: ["string"],
bucketColumns: ["string"],
columns: [{
name: "string",
comment: "string",
parameters: {
string: "string",
},
type: "string",
}],
compressed: false,
inputFormat: "string",
location: "string",
numberOfBuckets: 0,
outputFormat: "string",
parameters: {
string: "string",
},
schemaReference: {
schemaVersionNumber: 0,
schemaId: {
registryName: "string",
schemaArn: "string",
schemaName: "string",
},
schemaVersionId: "string",
},
serDeInfo: {
name: "string",
parameters: {
string: "string",
},
serializationLibrary: "string",
},
skewedInfo: {
skewedColumnNames: ["string"],
skewedColumnValueLocationMaps: {
string: "string",
},
skewedColumnValues: ["string"],
},
sortColumns: [{
column: "string",
sortOrder: 0,
}],
storedAsSubDirectories: false,
},
tableType: "string",
targetTable: {
catalogId: "string",
databaseName: "string",
name: "string",
region: "string",
},
viewExpandedText: "string",
viewOriginalText: "string",
});
type: aws:glue:CatalogTable
properties:
catalogId: string
databaseName: string
description: string
name: string
openTableFormatInput:
icebergInput:
metadataOperation: string
version: string
owner: string
parameters:
string: string
partitionIndices:
- indexName: string
indexStatus: string
keys:
- string
partitionKeys:
- comment: string
name: string
type: string
retention: 0
storageDescriptor:
additionalLocations:
- string
bucketColumns:
- string
columns:
- comment: string
name: string
parameters:
string: string
type: string
compressed: false
inputFormat: string
location: string
numberOfBuckets: 0
outputFormat: string
parameters:
string: string
schemaReference:
schemaId:
registryName: string
schemaArn: string
schemaName: string
schemaVersionId: string
schemaVersionNumber: 0
serDeInfo:
name: string
parameters:
string: string
serializationLibrary: string
skewedInfo:
skewedColumnNames:
- string
skewedColumnValueLocationMaps:
string: string
skewedColumnValues:
- string
sortColumns:
- column: string
sortOrder: 0
storedAsSubDirectories: false
tableType: string
targetTable:
catalogId: string
databaseName: string
name: string
region: string
viewExpandedText: string
viewOriginalText: string
CatalogTable Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CatalogTable resource accepts the following input properties:
- Database
Name string Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- Catalog
Id string - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- Description string
- Description of the table.
- Name string
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- Open
Table CatalogFormat Input Table Open Table Format Input - Configuration block for open table formats. See
open_table_format_inputbelow. - Owner string
- Owner of the table.
- Parameters Dictionary<string, string>
- Properties associated with this table, as a list of key-value pairs.
- Partition
Indices List<CatalogTable Partition Index> - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - Partition
Keys List<CatalogTable Partition Key> - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - Retention int
- Retention time for this table.
- Storage
Descriptor CatalogTable Storage Descriptor - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - Table
Type string - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - Target
Table CatalogTable Target Table - Configuration block of a target table for resource linking. See
target_tablebelow. - View
Expanded stringText - If the table is a view, the expanded text of the view; otherwise null.
- View
Original stringText - If the table is a view, the original text of the view; otherwise null.
- Database
Name string Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- Catalog
Id string - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- Description string
- Description of the table.
- Name string
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- Open
Table CatalogFormat Input Table Open Table Format Input Args - Configuration block for open table formats. See
open_table_format_inputbelow. - Owner string
- Owner of the table.
- Parameters map[string]string
- Properties associated with this table, as a list of key-value pairs.
- Partition
Indices []CatalogTable Partition Index Args - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - Partition
Keys []CatalogTable Partition Key Args - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - Retention int
- Retention time for this table.
- Storage
Descriptor CatalogTable Storage Descriptor Args - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - Table
Type string - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - Target
Table CatalogTable Target Table Args - Configuration block of a target table for resource linking. See
target_tablebelow. - View
Expanded stringText - If the table is a view, the expanded text of the view; otherwise null.
- View
Original stringText - If the table is a view, the original text of the view; otherwise null.
- database
Name String Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- catalog
Id String - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- description String
- Description of the table.
- name String
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open
Table CatalogFormat Input Table Open Table Format Input - Configuration block for open table formats. See
open_table_format_inputbelow. - owner String
- Owner of the table.
- parameters Map<String,String>
- Properties associated with this table, as a list of key-value pairs.
- partition
Indices List<CatalogTable Partition Index> - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition
Keys List<CatalogTable Partition Key> - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention Integer
- Retention time for this table.
- storage
Descriptor CatalogTable Storage Descriptor - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table
Type String - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target
Table CatalogTable Target Table - Configuration block of a target table for resource linking. See
target_tablebelow. - view
Expanded StringText - If the table is a view, the expanded text of the view; otherwise null.
- view
Original StringText - If the table is a view, the original text of the view; otherwise null.
- database
Name string Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- catalog
Id string - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- description string
- Description of the table.
- name string
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open
Table CatalogFormat Input Table Open Table Format Input - Configuration block for open table formats. See
open_table_format_inputbelow. - owner string
- Owner of the table.
- parameters {[key: string]: string}
- Properties associated with this table, as a list of key-value pairs.
- partition
Indices CatalogTable Partition Index[] - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition
Keys CatalogTable Partition Key[] - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention number
- Retention time for this table.
- storage
Descriptor CatalogTable Storage Descriptor - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table
Type string - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target
Table CatalogTable Target Table - Configuration block of a target table for resource linking. See
target_tablebelow. - view
Expanded stringText - If the table is a view, the expanded text of the view; otherwise null.
- view
Original stringText - If the table is a view, the original text of the view; otherwise null.
- database_
name str Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- catalog_
id str - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- description str
- Description of the table.
- name str
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open_
table_ Catalogformat_ input Table Open Table Format Input Args - Configuration block for open table formats. See
open_table_format_inputbelow. - owner str
- Owner of the table.
- parameters Mapping[str, str]
- Properties associated with this table, as a list of key-value pairs.
- partition_
indices Sequence[CatalogTable Partition Index Args] - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition_
keys Sequence[CatalogTable Partition Key Args] - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention int
- Retention time for this table.
- storage_
descriptor CatalogTable Storage Descriptor Args - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table_
type str - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target_
table CatalogTable Target Table Args - Configuration block of a target table for resource linking. See
target_tablebelow. - view_
expanded_ strtext - If the table is a view, the expanded text of the view; otherwise null.
- view_
original_ strtext - If the table is a view, the original text of the view; otherwise null.
- database
Name String Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- catalog
Id String - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- description String
- Description of the table.
- name String
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open
Table Property MapFormat Input - Configuration block for open table formats. See
open_table_format_inputbelow. - owner String
- Owner of the table.
- parameters Map<String>
- Properties associated with this table, as a list of key-value pairs.
- partition
Indices List<Property Map> - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition
Keys List<Property Map> - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention Number
- Retention time for this table.
- storage
Descriptor Property Map - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table
Type String - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target
Table Property Map - Configuration block of a target table for resource linking. See
target_tablebelow. - view
Expanded StringText - If the table is a view, the expanded text of the view; otherwise null.
- view
Original StringText - If the table is a view, the original text of the view; otherwise null.
Outputs
All input properties are implicitly available as output properties. Additionally, the CatalogTable resource produces the following output properties:
Look up Existing CatalogTable Resource
Get an existing CatalogTable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CatalogTableState, opts?: CustomResourceOptions): CatalogTable@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
catalog_id: Optional[str] = None,
database_name: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
open_table_format_input: Optional[CatalogTableOpenTableFormatInputArgs] = None,
owner: Optional[str] = None,
parameters: Optional[Mapping[str, str]] = None,
partition_indices: Optional[Sequence[CatalogTablePartitionIndexArgs]] = None,
partition_keys: Optional[Sequence[CatalogTablePartitionKeyArgs]] = None,
retention: Optional[int] = None,
storage_descriptor: Optional[CatalogTableStorageDescriptorArgs] = None,
table_type: Optional[str] = None,
target_table: Optional[CatalogTableTargetTableArgs] = None,
view_expanded_text: Optional[str] = None,
view_original_text: Optional[str] = None) -> CatalogTablefunc GetCatalogTable(ctx *Context, name string, id IDInput, state *CatalogTableState, opts ...ResourceOption) (*CatalogTable, error)public static CatalogTable Get(string name, Input<string> id, CatalogTableState? state, CustomResourceOptions? opts = null)public static CatalogTable get(String name, Output<String> id, CatalogTableState state, CustomResourceOptions options)resources: _: type: aws:glue:CatalogTable get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The ARN of the Glue Table.
- Catalog
Id string - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- Database
Name string Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- Description string
- Description of the table.
- Name string
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- Open
Table CatalogFormat Input Table Open Table Format Input - Configuration block for open table formats. See
open_table_format_inputbelow. - Owner string
- Owner of the table.
- Parameters Dictionary<string, string>
- Properties associated with this table, as a list of key-value pairs.
- Partition
Indices List<CatalogTable Partition Index> - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - Partition
Keys List<CatalogTable Partition Key> - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - Retention int
- Retention time for this table.
- Storage
Descriptor CatalogTable Storage Descriptor - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - Table
Type string - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - Target
Table CatalogTable Target Table - Configuration block of a target table for resource linking. See
target_tablebelow. - View
Expanded stringText - If the table is a view, the expanded text of the view; otherwise null.
- View
Original stringText - If the table is a view, the original text of the view; otherwise null.
- Arn string
- The ARN of the Glue Table.
- Catalog
Id string - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- Database
Name string Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- Description string
- Description of the table.
- Name string
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- Open
Table CatalogFormat Input Table Open Table Format Input Args - Configuration block for open table formats. See
open_table_format_inputbelow. - Owner string
- Owner of the table.
- Parameters map[string]string
- Properties associated with this table, as a list of key-value pairs.
- Partition
Indices []CatalogTable Partition Index Args - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - Partition
Keys []CatalogTable Partition Key Args - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - Retention int
- Retention time for this table.
- Storage
Descriptor CatalogTable Storage Descriptor Args - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - Table
Type string - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - Target
Table CatalogTable Target Table Args - Configuration block of a target table for resource linking. See
target_tablebelow. - View
Expanded stringText - If the table is a view, the expanded text of the view; otherwise null.
- View
Original stringText - If the table is a view, the original text of the view; otherwise null.
- arn String
- The ARN of the Glue Table.
- catalog
Id String - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- database
Name String Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- description String
- Description of the table.
- name String
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open
Table CatalogFormat Input Table Open Table Format Input - Configuration block for open table formats. See
open_table_format_inputbelow. - owner String
- Owner of the table.
- parameters Map<String,String>
- Properties associated with this table, as a list of key-value pairs.
- partition
Indices List<CatalogTable Partition Index> - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition
Keys List<CatalogTable Partition Key> - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention Integer
- Retention time for this table.
- storage
Descriptor CatalogTable Storage Descriptor - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table
Type String - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target
Table CatalogTable Target Table - Configuration block of a target table for resource linking. See
target_tablebelow. - view
Expanded StringText - If the table is a view, the expanded text of the view; otherwise null.
- view
Original StringText - If the table is a view, the original text of the view; otherwise null.
- arn string
- The ARN of the Glue Table.
- catalog
Id string - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- database
Name string Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- description string
- Description of the table.
- name string
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open
Table CatalogFormat Input Table Open Table Format Input - Configuration block for open table formats. See
open_table_format_inputbelow. - owner string
- Owner of the table.
- parameters {[key: string]: string}
- Properties associated with this table, as a list of key-value pairs.
- partition
Indices CatalogTable Partition Index[] - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition
Keys CatalogTable Partition Key[] - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention number
- Retention time for this table.
- storage
Descriptor CatalogTable Storage Descriptor - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table
Type string - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target
Table CatalogTable Target Table - Configuration block of a target table for resource linking. See
target_tablebelow. - view
Expanded stringText - If the table is a view, the expanded text of the view; otherwise null.
- view
Original stringText - If the table is a view, the original text of the view; otherwise null.
- arn str
- The ARN of the Glue Table.
- catalog_
id str - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- database_
name str Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- description str
- Description of the table.
- name str
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open_
table_ Catalogformat_ input Table Open Table Format Input Args - Configuration block for open table formats. See
open_table_format_inputbelow. - owner str
- Owner of the table.
- parameters Mapping[str, str]
- Properties associated with this table, as a list of key-value pairs.
- partition_
indices Sequence[CatalogTable Partition Index Args] - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition_
keys Sequence[CatalogTable Partition Key Args] - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention int
- Retention time for this table.
- storage_
descriptor CatalogTable Storage Descriptor Args - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table_
type str - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target_
table CatalogTable Target Table Args - Configuration block of a target table for resource linking. See
target_tablebelow. - view_
expanded_ strtext - If the table is a view, the expanded text of the view; otherwise null.
- view_
original_ strtext - If the table is a view, the original text of the view; otherwise null.
- arn String
- The ARN of the Glue Table.
- catalog
Id String - ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
- database
Name String Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
The follow arguments are optional:
- description String
- Description of the table.
- name String
- Name of the table. For Hive compatibility, this must be entirely lowercase.
- open
Table Property MapFormat Input - Configuration block for open table formats. See
open_table_format_inputbelow. - owner String
- Owner of the table.
- parameters Map<String>
- Properties associated with this table, as a list of key-value pairs.
- partition
Indices List<Property Map> - Configuration block for a maximum of 3 partition indexes. See
partition_indexbelow. - partition
Keys List<Property Map> - Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partition_keysbelow. - retention Number
- Retention time for this table.
- storage
Descriptor Property Map - Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storage_descriptorbelow. - table
Type String - Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty. - target
Table Property Map - Configuration block of a target table for resource linking. See
target_tablebelow. - view
Expanded StringText - If the table is a view, the expanded text of the view; otherwise null.
- view
Original StringText - If the table is a view, the original text of the view; otherwise null.
Supporting Types
CatalogTableOpenTableFormatInput, CatalogTableOpenTableFormatInputArgs
- Iceberg
Input CatalogTable Open Table Format Input Iceberg Input - Configuration block for iceberg table config. See
iceberg_inputbelow.
- Iceberg
Input CatalogTable Open Table Format Input Iceberg Input - Configuration block for iceberg table config. See
iceberg_inputbelow.
- iceberg
Input CatalogTable Open Table Format Input Iceberg Input - Configuration block for iceberg table config. See
iceberg_inputbelow.
- iceberg
Input CatalogTable Open Table Format Input Iceberg Input - Configuration block for iceberg table config. See
iceberg_inputbelow.
- iceberg_
input CatalogTable Open Table Format Input Iceberg Input - Configuration block for iceberg table config. See
iceberg_inputbelow.
- iceberg
Input Property Map - Configuration block for iceberg table config. See
iceberg_inputbelow.
CatalogTableOpenTableFormatInputIcebergInput, CatalogTableOpenTableFormatInputIcebergInputArgs
- Metadata
Operation string - A required metadata operation. Can only be set to CREATE.
- Version string
- The table version for the Iceberg table. Defaults to 2.
- Metadata
Operation string - A required metadata operation. Can only be set to CREATE.
- Version string
- The table version for the Iceberg table. Defaults to 2.
- metadata
Operation String - A required metadata operation. Can only be set to CREATE.
- version String
- The table version for the Iceberg table. Defaults to 2.
- metadata
Operation string - A required metadata operation. Can only be set to CREATE.
- version string
- The table version for the Iceberg table. Defaults to 2.
- metadata_
operation str - A required metadata operation. Can only be set to CREATE.
- version str
- The table version for the Iceberg table. Defaults to 2.
- metadata
Operation String - A required metadata operation. Can only be set to CREATE.
- version String
- The table version for the Iceberg table. Defaults to 2.
CatalogTablePartitionIndex, CatalogTablePartitionIndexArgs
- Index
Name string - Name of the partition index.
- Keys List<string>
- Keys for the partition index.
- Index
Status string
- Index
Name string - Name of the partition index.
- Keys []string
- Keys for the partition index.
- Index
Status string
- index
Name String - Name of the partition index.
- keys List<String>
- Keys for the partition index.
- index
Status String
- index
Name string - Name of the partition index.
- keys string[]
- Keys for the partition index.
- index
Status string
- index_
name str - Name of the partition index.
- keys Sequence[str]
- Keys for the partition index.
- index_
status str
- index
Name String - Name of the partition index.
- keys List<String>
- Keys for the partition index.
- index
Status String
CatalogTablePartitionKey, CatalogTablePartitionKeyArgs
CatalogTableStorageDescriptor, CatalogTableStorageDescriptorArgs
- Additional
Locations List<string> - List of locations that point to the path where a Delta table is located.
- Bucket
Columns List<string> - List of reducer grouping columns, clustering columns, and bucketing columns in the table.
- Columns
List<Catalog
Table Storage Descriptor Column> - Configuration block for columns in the table. See
columnsbelow. - Compressed bool
- Whether the data in the table is compressed.
- Input
Format string - Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
- Location string
- 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 intBuckets - Must be specified if the table contains any dimension columns.
- Output
Format string - Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
- Parameters Dictionary<string, string>
- User-supplied properties in key-value form.
- Schema
Reference CatalogTable Storage Descriptor Schema Reference - Object that references a schema stored in the AWS Glue Schema Registry. When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference. See Schema Reference below.
- Ser
De CatalogInfo Table Storage Descriptor Ser De Info - Configuration block for serialization and deserialization ("SerDe") information. See
ser_de_infobelow. - Skewed
Info CatalogTable Storage Descriptor Skewed Info - Configuration block with information about values that appear very frequently in a column (skewed values). See
skewed_infobelow. - Sort
Columns List<CatalogTable Storage Descriptor Sort Column> - Configuration block for the sort order of each bucket in the table. See
sort_columnsbelow. - Stored
As boolSub Directories - Whether the table data is stored in subdirectories.
- Additional
Locations []string - List of locations that point to the path where a Delta table is located.
- Bucket
Columns []string - List of reducer grouping columns, clustering columns, and bucketing columns in the table.
- Columns
[]Catalog
Table Storage Descriptor Column - Configuration block for columns in the table. See
columnsbelow. - Compressed bool
- Whether the data in the table is compressed.
- Input
Format string - Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
- Location string
- 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 intBuckets - Must be specified if the table contains any dimension columns.
- Output
Format string - Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
- Parameters map[string]string
- User-supplied properties in key-value form.
- Schema
Reference CatalogTable Storage Descriptor Schema Reference - Object that references a schema stored in the AWS Glue Schema Registry. When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference. See Schema Reference below.
- Ser
De CatalogInfo Table Storage Descriptor Ser De Info - Configuration block for serialization and deserialization ("SerDe") information. See
ser_de_infobelow. - Skewed
Info CatalogTable Storage Descriptor Skewed Info - Configuration block with information about values that appear very frequently in a column (skewed values). See
skewed_infobelow. - Sort
Columns []CatalogTable Storage Descriptor Sort Column - Configuration block for the sort order of each bucket in the table. See
sort_columnsbelow. - Stored
As boolSub Directories - Whether the table data is stored in subdirectories.
- additional
Locations List<String> - List of locations that point to the path where a Delta table is located.
- bucket
Columns List<String> - List of reducer grouping columns, clustering columns, and bucketing columns in the table.
- columns
List<Catalog
Table Storage Descriptor Column> - Configuration block for columns in the table. See
columnsbelow. - compressed Boolean
- Whether the data in the table is compressed.
- input
Format String - Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
- location String
- 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 IntegerBuckets - Must be specified if the table contains any dimension columns.
- output
Format String - Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
- parameters Map<String,String>
- User-supplied properties in key-value form.
- schema
Reference CatalogTable Storage Descriptor Schema Reference - Object that references a schema stored in the AWS Glue Schema Registry. When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference. See Schema Reference below.
- ser
De CatalogInfo Table Storage Descriptor Ser De Info - Configuration block for serialization and deserialization ("SerDe") information. See
ser_de_infobelow. - skewed
Info CatalogTable Storage Descriptor Skewed Info - Configuration block with information about values that appear very frequently in a column (skewed values). See
skewed_infobelow. - sort
Columns List<CatalogTable Storage Descriptor Sort Column> - Configuration block for the sort order of each bucket in the table. See
sort_columnsbelow. - stored
As BooleanSub Directories - Whether the table data is stored in subdirectories.
- additional
Locations string[] - List of locations that point to the path where a Delta table is located.
- bucket
Columns string[] - List of reducer grouping columns, clustering columns, and bucketing columns in the table.
- columns
Catalog
Table Storage Descriptor Column[] - Configuration block for columns in the table. See
columnsbelow. - compressed boolean
- Whether the data in the table is compressed.
- input
Format string - Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
- location string
- 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 numberBuckets - Must be specified if the table contains any dimension columns.
- output
Format string - Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
- parameters {[key: string]: string}
- User-supplied properties in key-value form.
- schema
Reference CatalogTable Storage Descriptor Schema Reference - Object that references a schema stored in the AWS Glue Schema Registry. When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference. See Schema Reference below.
- ser
De CatalogInfo Table Storage Descriptor Ser De Info - Configuration block for serialization and deserialization ("SerDe") information. See
ser_de_infobelow. - skewed
Info CatalogTable Storage Descriptor Skewed Info - Configuration block with information about values that appear very frequently in a column (skewed values). See
skewed_infobelow. - sort
Columns CatalogTable Storage Descriptor Sort Column[] - Configuration block for the sort order of each bucket in the table. See
sort_columnsbelow. - stored
As booleanSub Directories - Whether the table data is stored in subdirectories.
- additional_
locations Sequence[str] - List of locations that point to the path where a Delta table is located.
- bucket_
columns Sequence[str] - List of reducer grouping columns, clustering columns, and bucketing columns in the table.
- columns
Sequence[Catalog
Table Storage Descriptor Column] - Configuration block for columns in the table. See
columnsbelow. - compressed bool
- Whether the data in the table is compressed.
- input_
format str - Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
- location str
- 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_ intbuckets - Must be specified if the table contains any dimension columns.
- output_
format str - Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
- parameters Mapping[str, str]
- User-supplied properties in key-value form.
- schema_
reference CatalogTable Storage Descriptor Schema Reference - Object that references a schema stored in the AWS Glue Schema Registry. When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference. See Schema Reference below.
- ser_
de_ Cataloginfo Table Storage Descriptor Ser De Info - Configuration block for serialization and deserialization ("SerDe") information. See
ser_de_infobelow. - skewed_
info CatalogTable Storage Descriptor Skewed Info - Configuration block with information about values that appear very frequently in a column (skewed values). See
skewed_infobelow. - sort_
columns Sequence[CatalogTable Storage Descriptor Sort Column] - Configuration block for the sort order of each bucket in the table. See
sort_columnsbelow. - stored_
as_ boolsub_ directories - Whether the table data is stored in subdirectories.
- additional
Locations List<String> - List of locations that point to the path where a Delta table is located.
- bucket
Columns List<String> - List of reducer grouping columns, clustering columns, and bucketing columns in the table.
- columns List<Property Map>
- Configuration block for columns in the table. See
columnsbelow. - compressed Boolean
- Whether the data in the table is compressed.
- input
Format String - Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
- location String
- 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 NumberBuckets - Must be specified if the table contains any dimension columns.
- output
Format String - Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
- parameters Map<String>
- User-supplied properties in key-value form.
- schema
Reference Property Map - Object that references a schema stored in the AWS Glue Schema Registry. When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference. See Schema Reference below.
- ser
De Property MapInfo - Configuration block for serialization and deserialization ("SerDe") information. See
ser_de_infobelow. - skewed
Info Property Map - Configuration block with information about values that appear very frequently in a column (skewed values). See
skewed_infobelow. - sort
Columns List<Property Map> - Configuration block for the sort order of each bucket in the table. See
sort_columnsbelow. - stored
As BooleanSub Directories - Whether the table data is stored in subdirectories.
CatalogTableStorageDescriptorColumn, CatalogTableStorageDescriptorColumnArgs
- Name string
- Name of the Column.
- Comment string
- Free-form text comment.
- Parameters Dictionary<string, string>
- Key-value pairs defining properties associated with the column.
- Type string
- Datatype of data in the Column.
- Name string
- Name of the Column.
- Comment string
- Free-form text comment.
- Parameters map[string]string
- Key-value pairs defining properties associated with the column.
- Type string
- Datatype of data in the Column.
- name String
- Name of the Column.
- comment String
- Free-form text comment.
- parameters Map<String,String>
- Key-value pairs defining properties associated with the column.
- type String
- Datatype of data in the Column.
- name string
- Name of the Column.
- comment string
- Free-form text comment.
- parameters {[key: string]: string}
- Key-value pairs defining properties associated with the column.
- type string
- Datatype of data in the Column.
- name str
- Name of the Column.
- comment str
- Free-form text comment.
- parameters Mapping[str, str]
- Key-value pairs defining properties associated with the column.
- type str
- Datatype of data in the Column.
- name String
- Name of the Column.
- comment String
- Free-form text comment.
- parameters Map<String>
- Key-value pairs defining properties associated with the column.
- type String
- Datatype of data in the Column.
CatalogTableStorageDescriptorSchemaReference, CatalogTableStorageDescriptorSchemaReferenceArgs
- Schema
Version intNumber - Version number of the schema.
- Schema
Id CatalogTable Storage Descriptor Schema Reference Schema Id - Configuration block that contains schema identity fields. Either this or the
schema_version_idhas to be provided. Seeschema_idbelow. - Schema
Version stringId - Unique ID assigned to a version of the schema. Either this or the
schema_idhas to be provided.
- Schema
Version intNumber - Version number of the schema.
- Schema
Id CatalogTable Storage Descriptor Schema Reference Schema Id - Configuration block that contains schema identity fields. Either this or the
schema_version_idhas to be provided. Seeschema_idbelow. - Schema
Version stringId - Unique ID assigned to a version of the schema. Either this or the
schema_idhas to be provided.
- schema
Version IntegerNumber - Version number of the schema.
- schema
Id CatalogTable Storage Descriptor Schema Reference Schema Id - Configuration block that contains schema identity fields. Either this or the
schema_version_idhas to be provided. Seeschema_idbelow. - schema
Version StringId - Unique ID assigned to a version of the schema. Either this or the
schema_idhas to be provided.
- schema
Version numberNumber - Version number of the schema.
- schema
Id CatalogTable Storage Descriptor Schema Reference Schema Id - Configuration block that contains schema identity fields. Either this or the
schema_version_idhas to be provided. Seeschema_idbelow. - schema
Version stringId - Unique ID assigned to a version of the schema. Either this or the
schema_idhas to be provided.
- schema_
version_ intnumber - Version number of the schema.
- schema_
id CatalogTable Storage Descriptor Schema Reference Schema Id - Configuration block that contains schema identity fields. Either this or the
schema_version_idhas to be provided. Seeschema_idbelow. - schema_
version_ strid - Unique ID assigned to a version of the schema. Either this or the
schema_idhas to be provided.
- schema
Version NumberNumber - Version number of the schema.
- schema
Id Property Map - Configuration block that contains schema identity fields. Either this or the
schema_version_idhas to be provided. Seeschema_idbelow. - schema
Version StringId - Unique ID assigned to a version of the schema. Either this or the
schema_idhas to be provided.
CatalogTableStorageDescriptorSchemaReferenceSchemaId, CatalogTableStorageDescriptorSchemaReferenceSchemaIdArgs
- Registry
Name string - Name of the schema registry that contains the schema. Must be provided when
schema_nameis specified and conflicts withschema_arn. - Schema
Arn string - ARN of the schema. One of
schema_arnorschema_namehas to be provided. - Schema
Name string - Name of the schema. One of
schema_arnorschema_namehas to be provided.
- Registry
Name string - Name of the schema registry that contains the schema. Must be provided when
schema_nameis specified and conflicts withschema_arn. - Schema
Arn string - ARN of the schema. One of
schema_arnorschema_namehas to be provided. - Schema
Name string - Name of the schema. One of
schema_arnorschema_namehas to be provided.
- registry
Name String - Name of the schema registry that contains the schema. Must be provided when
schema_nameis specified and conflicts withschema_arn. - schema
Arn String - ARN of the schema. One of
schema_arnorschema_namehas to be provided. - schema
Name String - Name of the schema. One of
schema_arnorschema_namehas to be provided.
- registry
Name string - Name of the schema registry that contains the schema. Must be provided when
schema_nameis specified and conflicts withschema_arn. - schema
Arn string - ARN of the schema. One of
schema_arnorschema_namehas to be provided. - schema
Name string - Name of the schema. One of
schema_arnorschema_namehas to be provided.
- registry_
name str - Name of the schema registry that contains the schema. Must be provided when
schema_nameis specified and conflicts withschema_arn. - schema_
arn str - ARN of the schema. One of
schema_arnorschema_namehas to be provided. - schema_
name str - Name of the schema. One of
schema_arnorschema_namehas to be provided.
- registry
Name String - Name of the schema registry that contains the schema. Must be provided when
schema_nameis specified and conflicts withschema_arn. - schema
Arn String - ARN of the schema. One of
schema_arnorschema_namehas to be provided. - schema
Name String - Name of the schema. One of
schema_arnorschema_namehas to be provided.
CatalogTableStorageDescriptorSerDeInfo, CatalogTableStorageDescriptorSerDeInfoArgs
- Name string
- Name of the SerDe.
- Parameters Dictionary<string, string>
- Map of initialization parameters for the SerDe, in key-value form.
- Serialization
Library string - Usually the class that implements the SerDe. An example is
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
- Name string
- Name of the SerDe.
- Parameters map[string]string
- Map of initialization parameters for the SerDe, in key-value form.
- Serialization
Library string - Usually the class that implements the SerDe. An example is
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
- name String
- Name of the SerDe.
- parameters Map<String,String>
- Map of initialization parameters for the SerDe, in key-value form.
- serialization
Library String - Usually the class that implements the SerDe. An example is
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
- name string
- Name of the SerDe.
- parameters {[key: string]: string}
- Map of initialization parameters for the SerDe, in key-value form.
- serialization
Library string - Usually the class that implements the SerDe. An example is
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
- name str
- Name of the SerDe.
- parameters Mapping[str, str]
- Map of initialization parameters for the SerDe, in key-value form.
- serialization_
library str - Usually the class that implements the SerDe. An example is
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
- name String
- Name of the SerDe.
- parameters Map<String>
- Map of initialization parameters for the SerDe, in key-value form.
- serialization
Library String - Usually the class that implements the SerDe. An example is
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
CatalogTableStorageDescriptorSkewedInfo, CatalogTableStorageDescriptorSkewedInfoArgs
- Skewed
Column List<string>Names - List of names of columns that contain skewed values.
- Skewed
Column Dictionary<string, string>Value Location Maps - List of values that appear so frequently as to be considered skewed.
- Skewed
Column List<string>Values - Map of skewed values to the columns that contain them.
- Skewed
Column []stringNames - List of names of columns that contain skewed values.
- Skewed
Column map[string]stringValue Location Maps - List of values that appear so frequently as to be considered skewed.
- Skewed
Column []stringValues - Map of skewed values to the columns that contain them.
- skewed
Column List<String>Names - List of names of columns that contain skewed values.
- skewed
Column Map<String,String>Value Location Maps - List of values that appear so frequently as to be considered skewed.
- skewed
Column List<String>Values - Map of skewed values to the columns that contain them.
- skewed
Column string[]Names - List of names of columns that contain skewed values.
- skewed
Column {[key: string]: string}Value Location Maps - List of values that appear so frequently as to be considered skewed.
- skewed
Column string[]Values - Map of skewed values to the columns that contain them.
- skewed_
column_ Sequence[str]names - List of names of columns that contain skewed values.
- skewed_
column_ Mapping[str, str]value_ location_ maps - List of values that appear so frequently as to be considered skewed.
- skewed_
column_ Sequence[str]values - Map of skewed values to the columns that contain them.
- skewed
Column List<String>Names - List of names of columns that contain skewed values.
- skewed
Column Map<String>Value Location Maps - List of values that appear so frequently as to be considered skewed.
- skewed
Column List<String>Values - Map of skewed values to the columns that contain them.
CatalogTableStorageDescriptorSortColumn, CatalogTableStorageDescriptorSortColumnArgs
- column str
- Name of the column.
- sort_
order int - Whether the column is sorted in ascending (
1) or descending order (0).
CatalogTableTargetTable, CatalogTableTargetTableArgs
- Catalog
Id string - ID of the Data Catalog in which the table resides.
- Database
Name string - Name of the catalog database that contains the target table.
- Name string
- Name of the target table.
- Region string
- Region of the target table.
- Catalog
Id string - ID of the Data Catalog in which the table resides.
- Database
Name string - Name of the catalog database that contains the target table.
- Name string
- Name of the target table.
- Region string
- Region of the target table.
- catalog
Id String - ID of the Data Catalog in which the table resides.
- database
Name String - Name of the catalog database that contains the target table.
- name String
- Name of the target table.
- region String
- Region of the target table.
- catalog
Id string - ID of the Data Catalog in which the table resides.
- database
Name string - Name of the catalog database that contains the target table.
- name string
- Name of the target table.
- region string
- Region of the target table.
- catalog_
id str - ID of the Data Catalog in which the table resides.
- database_
name str - Name of the catalog database that contains the target table.
- name str
- Name of the target table.
- region str
- Region of the target table.
- catalog
Id String - ID of the Data Catalog in which the table resides.
- database
Name String - Name of the catalog database that contains the target table.
- name String
- Name of the target table.
- region String
- Region of the target table.
Import
Using pulumi import, import Glue Tables using the catalog ID (usually AWS account ID), database name, and table name. For example:
$ pulumi import aws:glue/catalogTable:CatalogTable MyTable 123456789012:MyDatabase:MyTable
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.