CatalogTable

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var awsGlueCatalogTable = new Aws.Glue.CatalogTable("awsGlueCatalogTable", new Aws.Glue.CatalogTableArgs
        {
            DatabaseName = "MyCatalogDatabase",
            Name = "MyCatalogTable",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/glue"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := glue.NewCatalogTable(ctx, "awsGlueCatalogTable", &glue.CatalogTableArgs{
            DatabaseName: pulumi.String("MyCatalogDatabase"),
            Name:         pulumi.String("MyCatalogTable"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

aws_glue_catalog_table = aws.glue.CatalogTable("awsGlueCatalogTable",
    database_name="MyCatalogDatabase",
    name="MyCatalogTable")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
    databaseName: "MyCatalogDatabase",
    name: "MyCatalogTable",
});

Parquet Table for Athena

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var awsGlueCatalogTable = new Aws.Glue.CatalogTable("awsGlueCatalogTable", new Aws.Glue.CatalogTableArgs
        {
            DatabaseName = "MyCatalogDatabase",
            Name = "MyCatalogTable",
            Parameters = 
            {
                { "EXTERNAL", "TRUE" },
                { "parquet.compression", "SNAPPY" },
            },
            StorageDescriptor = new Aws.Glue.Inputs.CatalogTableStorageDescriptorArgs
            {
                Columns = 
                {
                    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
                    {
                        Comment = "",
                        Name = "my_date",
                        Type = "date",
                    },
                    new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
                    {
                        Comment = "",
                        Name = "my_bigint",
                        Type = "bigint",
                    },
                    new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
                    {
                        Comment = "",
                        Name = "my_struct",
                        Type = "struct<my_nested_string:string>",
                    },
                },
                InputFormat = "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
                Location = "s3://my-bucket/event-streams/my-stream",
                OutputFormat = "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
                SerDeInfo = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSerDeInfoArgs
                {
                    Name = "my-stream",
                    Parameters = 
                    {
                        { "serialization.format", "1" },
                    },
                    SerializationLibrary = "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
                },
            },
            TableType = "EXTERNAL_TABLE",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/glue"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := glue.NewCatalogTable(ctx, "awsGlueCatalogTable", &glue.CatalogTableArgs{
            DatabaseName: pulumi.String("MyCatalogDatabase"),
            Name:         pulumi.String("MyCatalogTable"),
            Parameters: pulumi.StringMap{
                "EXTERNAL":            pulumi.String("TRUE"),
                "parquet.compression": pulumi.String("SNAPPY"),
            },
            StorageDescriptor: &glue.CatalogTableStorageDescriptorArgs{
                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{
                        Comment: pulumi.String(""),
                        Name:    pulumi.String("my_date"),
                        Type:    pulumi.String("date"),
                    },
                    &glue.CatalogTableStorageDescriptorColumnArgs{
                        Comment: pulumi.String(""),
                        Name:    pulumi.String("my_bigint"),
                        Type:    pulumi.String("bigint"),
                    },
                    &glue.CatalogTableStorageDescriptorColumnArgs{
                        Comment: pulumi.String(""),
                        Name:    pulumi.String("my_struct"),
                        Type:    pulumi.String("struct<my_nested_string:string>"),
                    },
                },
                InputFormat:  pulumi.String("org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat"),
                Location:     pulumi.String("s3://my-bucket/event-streams/my-stream"),
                OutputFormat: pulumi.String("org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat"),
                SerDeInfo: &glue.CatalogTableStorageDescriptorSerDeInfoArgs{
                    Name: pulumi.String("my-stream"),
                    Parameters: pulumi.StringMap{
                        "serialization.format": pulumi.String("1"),
                    },
                    SerializationLibrary: pulumi.String("org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe"),
                },
            },
            TableType: pulumi.String("EXTERNAL_TABLE"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

aws_glue_catalog_table = aws.glue.CatalogTable("awsGlueCatalogTable",
    database_name="MyCatalogDatabase",
    name="MyCatalogTable",
    parameters={
        "EXTERNAL": "TRUE",
        "parquet.compression": "SNAPPY",
    },
    storage_descriptor={
        "columns": [
            {
                "name": "my_string",
                "type": "string",
            },
            {
                "name": "my_double",
                "type": "double",
            },
            {
                "comment": "",
                "name": "my_date",
                "type": "date",
            },
            {
                "comment": "",
                "name": "my_bigint",
                "type": "bigint",
            },
            {
                "comment": "",
                "name": "my_struct",
                "type": "struct<my_nested_string:string>",
            },
        ],
        "inputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
        "location": "s3://my-bucket/event-streams/my-stream",
        "outputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
        "serDeInfo": {
            "name": "my-stream",
            "parameters": {
                "serialization.format": 1,
            },
            "serializationLibrary": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
        },
    },
    table_type="EXTERNAL_TABLE")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
    databaseName: "MyCatalogDatabase",
    name: "MyCatalogTable",
    parameters: {
        EXTERNAL: "TRUE",
        "parquet.compression": "SNAPPY",
    },
    storageDescriptor: {
        columns: [
            {
                name: "my_string",
                type: "string",
            },
            {
                name: "my_double",
                type: "double",
            },
            {
                comment: "",
                name: "my_date",
                type: "date",
            },
            {
                comment: "",
                name: "my_bigint",
                type: "bigint",
            },
            {
                comment: "",
                name: "my_struct",
                type: "struct<my_nested_string:string>",
            },
        ],
        inputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
        location: "s3://my-bucket/event-streams/my-stream",
        outputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
        serDeInfo: {
            name: "my-stream",
            parameters: {
                "serialization.format": 1,
            },
            serializationLibrary: "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
        },
    },
    tableType: "EXTERNAL_TABLE",
});

Create a CatalogTable Resource

new CatalogTable(name: string, args: CatalogTableArgs, opts?: CustomResourceOptions);

def CatalogTable(resource_name, opts=None, catalog_id=None, database_name=None, description=None, name=None, owner=None, parameters=None, partition_keys=None, retention=None, storage_descriptor=None, table_type=None, view_expanded_text=None, view_original_text=None, __props__=None);

func NewCatalogTable(ctx *Context, name string, args CatalogTableArgs, opts ...ResourceOption) (*CatalogTable, error)

public CatalogTable(string name, CatalogTableArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

CatalogTable Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The CatalogTable resource accepts the following input properties:

DatabaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
CatalogId 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 SerDe.
Owner string: Owner of the table.
Parameters Dictionary<string, string>: A map of initialization parameters for the SerDe, in key-value form.
PartitionKeys List<CatalogTablePartitionKeyArgs>: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
Retention int: Retention time for this table.
StorageDescriptor CatalogTableStorageDescriptorArgs: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
TableType string: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
ViewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
ViewOriginalText string: If the table is a view, the original text of the view; otherwise null.

DatabaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
CatalogId 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 SerDe.
Owner string: Owner of the table.
Parameters map[string]string: A map of initialization parameters for the SerDe, in key-value form.
PartitionKeys []CatalogTablePartitionKey: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
Retention int: Retention time for this table.
StorageDescriptor CatalogTableStorageDescriptor: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
TableType string: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
ViewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
ViewOriginalText string: If the table is a view, the original text of the view; otherwise null.

databaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
catalogId 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 SerDe.
owner string: Owner of the table.
parameters {[key: string]: string}: A map of initialization parameters for the SerDe, in key-value form.
partitionKeys CatalogTablePartitionKey[]: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
retention number: Retention time for this table.
storageDescriptor CatalogTableStorageDescriptor: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
tableType string: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
viewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
viewOriginalText string: 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.
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 SerDe.
owner str: Owner of the table.
parameters Dict[str, str]: A map of initialization parameters for the SerDe, in key-value form.
partition_keys List[CatalogTablePartitionKey]: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
retention float: Retention time for this table.
storage_descriptor Dict[CatalogTableStorageDescriptor]: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
table_type str: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
view_expanded_text str: If the table is a view, the expanded text of the view; otherwise null.
view_original_text str: 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:

Arn string: The ARN of the Glue Table.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The ARN of the Glue Table.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the Glue Table.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the Glue Table.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, arn=None, catalog_id=None, database_name=None, description=None, name=None, owner=None, parameters=None, partition_keys=None, retention=None, storage_descriptor=None, table_type=None, view_expanded_text=None, view_original_text=None, __props__=None);

func 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)

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.

The following state arguments are supported:

Arn string: The ARN of the Glue Table.
CatalogId 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.
DatabaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description string: Description of the table.
Name string: Name of the SerDe.
Owner string: Owner of the table.
Parameters Dictionary<string, string>: A map of initialization parameters for the SerDe, in key-value form.
PartitionKeys List<CatalogTablePartitionKeyArgs>: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
Retention int: Retention time for this table.
StorageDescriptor CatalogTableStorageDescriptorArgs: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
TableType string: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
ViewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
ViewOriginalText string: If the table is a view, the original text of the view; otherwise null.

Arn string: The ARN of the Glue Table.
CatalogId 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.
DatabaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description string: Description of the table.
Name string: Name of the SerDe.
Owner string: Owner of the table.
Parameters map[string]string: A map of initialization parameters for the SerDe, in key-value form.
PartitionKeys []CatalogTablePartitionKey: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
Retention int: Retention time for this table.
StorageDescriptor CatalogTableStorageDescriptor: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
TableType string: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
ViewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
ViewOriginalText string: If the table is a view, the original text of the view; otherwise null.

arn string: The ARN of the Glue Table.
catalogId 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.
databaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
description string: Description of the table.
name string: Name of the SerDe.
owner string: Owner of the table.
parameters {[key: string]: string}: A map of initialization parameters for the SerDe, in key-value form.
partitionKeys CatalogTablePartitionKey[]: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
retention number: Retention time for this table.
storageDescriptor CatalogTableStorageDescriptor: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
tableType string: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
viewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
viewOriginalText string: 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.
description str: Description of the table.
name str: Name of the SerDe.
owner str: Owner of the table.
parameters Dict[str, str]: A map of initialization parameters for the SerDe, in key-value form.
partition_keys List[CatalogTablePartitionKey]: A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
retention float: Retention time for this table.
storage_descriptor Dict[CatalogTableStorageDescriptor]: A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.
table_type str: The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
view_expanded_text str: If the table is a view, the expanded text of the view; otherwise null.
view_original_text str: If the table is a view, the original text of the view; otherwise null.

Supporting Types

CatalogTablePartitionKey

See the input and output API doc for this type.

Name string: Name of the SerDe.
Comment string: Free-form text comment.
Type string: The datatype of data in the Column.

Name string: Name of the SerDe.
Comment string: Free-form text comment.
Type string: The datatype of data in the Column.

name string: Name of the SerDe.
comment string: Free-form text comment.
type string: The datatype of data in the Column.

name str: Name of the SerDe.
comment str: Free-form text comment.
type str: The datatype of data in the Column.

CatalogTableStorageDescriptor

See the input and output API doc for this type.

BucketColumns List<string>: A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
Columns List<CatalogTableStorageDescriptorColumnArgs>: A list of the Columns in the table.
Compressed bool: True if the data in the table is compressed, or False if not.
InputFormat string: The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
Location string: 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.
NumberOfBuckets int: Must be specified if the table contains any dimension columns.
OutputFormat string: The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Parameters Dictionary<string, string>: A map of initialization parameters for the SerDe, in key-value form.
SerDeInfo CatalogTableStorageDescriptorSerDeInfoArgs: Serialization/deserialization (SerDe) information.
SkewedInfo CatalogTableStorageDescriptorSkewedInfoArgs: Information about values that appear very frequently in a column (skewed values).
SortColumns List<CatalogTableStorageDescriptorSortColumnArgs>: A list of Order objects specifying the sort order of each bucket in the table.
StoredAsSubDirectories bool: True if the table data is stored in subdirectories, or False if not.

BucketColumns []string: A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
Columns []CatalogTableStorageDescriptorColumn: A list of the Columns in the table.
Compressed bool: True if the data in the table is compressed, or False if not.
InputFormat string: The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
Location string: 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.
NumberOfBuckets int: Must be specified if the table contains any dimension columns.
OutputFormat string: The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Parameters map[string]string: A map of initialization parameters for the SerDe, in key-value form.
SerDeInfo CatalogTableStorageDescriptorSerDeInfo: Serialization/deserialization (SerDe) information.
SkewedInfo CatalogTableStorageDescriptorSkewedInfo: Information about values that appear very frequently in a column (skewed values).
SortColumns []CatalogTableStorageDescriptorSortColumn: A list of Order objects specifying the sort order of each bucket in the table.
StoredAsSubDirectories bool: True if the table data is stored in subdirectories, or False if not.

bucketColumns string[]: A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
columns CatalogTableStorageDescriptorColumn[]: A list of the Columns in the table.
compressed boolean: True if the data in the table is compressed, or False if not.
inputFormat string: The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
location string: 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.
numberOfBuckets number: Must be specified if the table contains any dimension columns.
outputFormat string: The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
parameters {[key: string]: string}: A map of initialization parameters for the SerDe, in key-value form.
serDeInfo CatalogTableStorageDescriptorSerDeInfo: Serialization/deserialization (SerDe) information.
skewedInfo CatalogTableStorageDescriptorSkewedInfo: Information about values that appear very frequently in a column (skewed values).
sortColumns CatalogTableStorageDescriptorSortColumn[]: A list of Order objects specifying the sort order of each bucket in the table.
storedAsSubDirectories boolean: True if the table data is stored in subdirectories, or False if not.

bucketColumns List[str]: A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
columns List[CatalogTableStorageDescriptorColumn]: A list of the Columns in the table.
compressed bool: True if the data in the table is compressed, or False if not.
inputFormat str: The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
location 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.
numberOfBuckets float: Must be specified if the table contains any dimension columns.
outputFormat str: The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
parameters Dict[str, str]: A map of initialization parameters for the SerDe, in key-value form.
serDeInfo Dict[CatalogTableStorageDescriptorSerDeInfo]: Serialization/deserialization (SerDe) information.
skewedInfo Dict[CatalogTableStorageDescriptorSkewedInfo]: Information about values that appear very frequently in a column (skewed values).
sortColumns List[CatalogTableStorageDescriptorSortColumn]: A list of Order objects specifying the sort order of each bucket in the table.
storedAsSubDirectories bool: True if the table data is stored in subdirectories, or False if not.

CatalogTableStorageDescriptorColumn

See the input and output API doc for this type.

Name string: Name of the SerDe.
Comment string: Free-form text comment.
Type string: The datatype of data in the Column.

Name string: Name of the SerDe.
Comment string: Free-form text comment.
Type string: The datatype of data in the Column.

name string: Name of the SerDe.
comment string: Free-form text comment.
type string: The datatype of data in the Column.

name str: Name of the SerDe.
comment str: Free-form text comment.
type str: The datatype of data in the Column.

CatalogTableStorageDescriptorSerDeInfo

See the input and output API doc for this type.

Name string: Name of the SerDe.
Parameters Dictionary<string, string>: A map of initialization parameters for the SerDe, in key-value form.
SerializationLibrary 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: A map of initialization parameters for the SerDe, in key-value form.
SerializationLibrary 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}: A map of initialization parameters for the SerDe, in key-value form.
serializationLibrary 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 Dict[str, str]: A map of initialization parameters for the SerDe, in key-value form.
serializationLibrary str: Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

CatalogTableStorageDescriptorSkewedInfo

See the input and output API doc for this type.

SkewedColumnNames List<string>: A list of names of columns that contain skewed values.
SkewedColumnValueLocationMaps Dictionary<string, string>: A list of values that appear so frequently as to be considered skewed.
SkewedColumnValues List<string>: A map of skewed values to the columns that contain them.

SkewedColumnNames []string: A list of names of columns that contain skewed values.
SkewedColumnValueLocationMaps map[string]string: A list of values that appear so frequently as to be considered skewed.
SkewedColumnValues []string: A map of skewed values to the columns that contain them.

skewedColumnNames string[]: A list of names of columns that contain skewed values.
skewedColumnValueLocationMaps {[key: string]: string}: A list of values that appear so frequently as to be considered skewed.
skewedColumnValues string[]: A map of skewed values to the columns that contain them.

skewedColumnNames List[str]: A list of names of columns that contain skewed values.
skewedColumnValueLocationMaps Dict[str, str]: A list of values that appear so frequently as to be considered skewed.
skewedColumnValues List[str]: A map of skewed values to the columns that contain them.

CatalogTableStorageDescriptorSortColumn

See the input and output API doc for this type.

Column string: The name of the column.
SortOrder int: Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

Column string: The name of the column.
SortOrder int: Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

column string: The name of the column.
sortOrder number: Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

column str: The name of the column.
sortOrder float: Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

CatalogTable

Example Usage

Basic Table

Parquet Table for Athena

Create a CatalogTable Resource

CatalogTable Resource Properties

Inputs

Outputs

Look up an Existing CatalogTable Resource

Supporting Types

CatalogTablePartitionKey

CatalogTableStorageDescriptor

CatalogTableStorageDescriptorColumn

CatalogTableStorageDescriptorSerDeInfo

CatalogTableStorageDescriptorSkewedInfo

CatalogTableStorageDescriptorSortColumn

Package Details

On This Page