Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. glue
  5. CatalogTable

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

aws.glue.CatalogTable

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

    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 System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var awsGlueCatalogTable = new Aws.Glue.CatalogTable("awsGlueCatalogTable", new()
    {
        DatabaseName = "MyCatalogDatabase",
        Name = "MyCatalogTable",
    });

});

    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, "awsGlueCatalogTable", &glue.CatalogTableArgs{
			DatabaseName: pulumi.String("MyCatalogDatabase"),
			Name:         pulumi.String("MyCatalogTable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()        
            .databaseName("MyCatalogDatabase")
            .name("MyCatalogTable")
            .build());

    }
}

    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("awsGlueCatalogTable", {
    databaseName: "MyCatalogDatabase",
    name: "MyCatalogTable",
});

    resources:
  awsGlueCatalogTable:
    type: aws:glue:CatalogTable
    properties:
      databaseName: MyCatalogDatabase
      name: MyCatalogTable

    Parquet Table for Athena

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var awsGlueCatalogTable = new Aws.Glue.CatalogTable("awsGlueCatalogTable", new()
    {
        DatabaseName = "MyCatalogDatabase",
        Name = "MyCatalogTable",
        Parameters = 
        {
            { "EXTERNAL", "TRUE" },
            { "parquet.compression", "SNAPPY" },
        },
        StorageDescriptor = new Aws.Glue.Inputs.CatalogTableStorageDescriptorArgs
        {
            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
                {
                    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/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, "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
	})
}

    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()        
            .databaseName("MyCatalogDatabase")
            .name("MyCatalogTable")
            .parameters(Map.ofEntries(
                Map.entry("EXTERNAL", "TRUE"),
                Map.entry("parquet.compression", "SNAPPY")
            ))
            .storageDescriptor(CatalogTableStorageDescriptorArgs.builder()
                .columns(                
                    CatalogTableStorageDescriptorColumnArgs.builder()
                        .name("my_string")
                        .type("string")
                        .build(),
                    CatalogTableStorageDescriptorColumnArgs.builder()
                        .name("my_double")
                        .type("double")
                        .build(),
                    CatalogTableStorageDescriptorColumnArgs.builder()
                        .comment("")
                        .name("my_date")
                        .type("date")
                        .build(),
                    CatalogTableStorageDescriptorColumnArgs.builder()
                        .comment("")
                        .name("my_bigint")
                        .type("bigint")
                        .build(),
                    CatalogTableStorageDescriptorColumnArgs.builder()
                        .comment("")
                        .name("my_struct")
                        .type("struct<my_nested_string:string>")
                        .build())
                .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(CatalogTableStorageDescriptorSerDeInfoArgs.builder()
                    .name("my-stream")
                    .parameters(Map.of("serialization.format", 1))
                    .serializationLibrary("org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe")
                    .build())
                .build())
            .tableType("EXTERNAL_TABLE")
            .build());

    }
}

    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=aws.glue.CatalogTableStorageDescriptorArgs(
        columns=[
            aws.glue.CatalogTableStorageDescriptorColumnArgs(
                name="my_string",
                type="string",
            ),
            aws.glue.CatalogTableStorageDescriptorColumnArgs(
                name="my_double",
                type="double",
            ),
            aws.glue.CatalogTableStorageDescriptorColumnArgs(
                comment="",
                name="my_date",
                type="date",
            ),
            aws.glue.CatalogTableStorageDescriptorColumnArgs(
                comment="",
                name="my_bigint",
                type="bigint",
            ),
            aws.glue.CatalogTableStorageDescriptorColumnArgs(
                comment="",
                name="my_struct",
                type="struct<my_nested_string:string>",
            ),
        ],
        input_format="org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
        location="s3://my-bucket/event-streams/my-stream",
        output_format="org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
        ser_de_info=aws.glue.CatalogTableStorageDescriptorSerDeInfoArgs(
            name="my-stream",
            parameters={
                "serialization.format": "1",
            },
            serialization_library="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("awsGlueCatalogTable", {
    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",
});

    resources:
  awsGlueCatalogTable:
    type: aws:glue:CatalogTable
    properties:
      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 CatalogTable Resource

    new CatalogTable(name: string, args: CatalogTableArgs, opts?: CustomResourceOptions);
    @overload
def CatalogTable(resource_name: str,
                 opts: Optional[ResourceOptions] = 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)
@overload
def CatalogTable(resource_name: str,
                 args: CatalogTableArgs,
                 opts: Optional[ResourceOptions] = 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.
    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.

    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

    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.

    The follow arguments are optional:

    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 table. For Hive compatibility, this must be entirely lowercase.

    OpenTableFormatInput CatalogTableOpenTableFormatInput

    Configuration block for open table formats. See open_table_format_input below.

    Owner string

    Owner of the table.

    Parameters Dictionary<string, string>

    Properties associated with this table, as a list of key-value pairs.

    PartitionIndices List<CatalogTablePartitionIndex>

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    PartitionKeys List<CatalogTablePartitionKey>

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    Retention int

    Retention time for this table.

    StorageDescriptor CatalogTableStorageDescriptor

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    TableType string

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    TargetTable CatalogTableTargetTable

    Configuration block of a target table for resource linking. See target_table below.

    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.

    The follow arguments are optional:

    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 table. For Hive compatibility, this must be entirely lowercase.

    OpenTableFormatInput CatalogTableOpenTableFormatInputArgs

    Configuration block for open table formats. See open_table_format_input below.

    Owner string

    Owner of the table.

    Parameters map[string]string

    Properties associated with this table, as a list of key-value pairs.

    PartitionIndices []CatalogTablePartitionIndexArgs

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    PartitionKeys []CatalogTablePartitionKeyArgs

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    Retention int

    Retention time for this table.

    StorageDescriptor CatalogTableStorageDescriptorArgs

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    TableType string

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    TargetTable CatalogTableTargetTableArgs

    Configuration block of a target table for resource linking. See target_table below.

    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.

    The follow arguments are optional:

    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 table. For Hive compatibility, this must be entirely lowercase.

    openTableFormatInput CatalogTableOpenTableFormatInput

    Configuration block for open table formats. See open_table_format_input below.

    owner String

    Owner of the table.

    parameters Map<String,String>

    Properties associated with this table, as a list of key-value pairs.

    partitionIndices List<CatalogTablePartitionIndex>

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partitionKeys List<CatalogTablePartitionKey>

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention Integer

    Retention time for this table.

    storageDescriptor CatalogTableStorageDescriptor

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    tableType String

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    targetTable CatalogTableTargetTable

    Configuration block of a target table for resource linking. See target_table below.

    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.

    The follow arguments are optional:

    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 table. For Hive compatibility, this must be entirely lowercase.

    openTableFormatInput CatalogTableOpenTableFormatInput

    Configuration block for open table formats. See open_table_format_input below.

    owner string

    Owner of the table.

    parameters {[key: string]: string}

    Properties associated with this table, as a list of key-value pairs.

    partitionIndices CatalogTablePartitionIndex[]

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partitionKeys CatalogTablePartitionKey[]

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention number

    Retention time for this table.

    storageDescriptor CatalogTableStorageDescriptor

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    tableType string

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    targetTable CatalogTableTargetTable

    Configuration block of a target table for resource linking. See target_table below.

    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.

    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_format_input CatalogTableOpenTableFormatInputArgs

    Configuration block for open table formats. See open_table_format_input below.

    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[CatalogTablePartitionIndexArgs]

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partition_keys Sequence[CatalogTablePartitionKeyArgs]

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention int

    Retention time for this table.

    storage_descriptor CatalogTableStorageDescriptorArgs

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    table_type str

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    target_table CatalogTableTargetTableArgs

    Configuration block of a target table for resource linking. See target_table below.

    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.

    databaseName String

    Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

    The follow arguments are optional:

    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 table. For Hive compatibility, this must be entirely lowercase.

    openTableFormatInput Property Map

    Configuration block for open table formats. See open_table_format_input below.

    owner String

    Owner of the table.

    parameters Map<String>

    Properties associated with this table, as a list of key-value pairs.

    partitionIndices List<Property Map>

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partitionKeys List<Property Map>

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention Number

    Retention time for this table.

    storageDescriptor Property Map

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    tableType String

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    targetTable Property Map

    Configuration block of a target table for resource linking. See target_table below.

    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.

    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 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.

    arn String

    The ARN of the Glue Table.

    id String

    The provider-assigned unique ID for this managed resource.

    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) -> CatalogTable
    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)
    public static CatalogTable get(String name, Output<String> id, CatalogTableState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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.

    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.

    OpenTableFormatInput CatalogTableOpenTableFormatInput

    Configuration block for open table formats. See open_table_format_input below.

    Owner string

    Owner of the table.

    Parameters Dictionary<string, string>

    Properties associated with this table, as a list of key-value pairs.

    PartitionIndices List<CatalogTablePartitionIndex>

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    PartitionKeys List<CatalogTablePartitionKey>

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    Retention int

    Retention time for this table.

    StorageDescriptor CatalogTableStorageDescriptor

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    TableType string

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    TargetTable CatalogTableTargetTable

    Configuration block of a target table for resource linking. See target_table below.

    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.

    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.

    OpenTableFormatInput CatalogTableOpenTableFormatInputArgs

    Configuration block for open table formats. See open_table_format_input below.

    Owner string

    Owner of the table.

    Parameters map[string]string

    Properties associated with this table, as a list of key-value pairs.

    PartitionIndices []CatalogTablePartitionIndexArgs

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    PartitionKeys []CatalogTablePartitionKeyArgs

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    Retention int

    Retention time for this table.

    StorageDescriptor CatalogTableStorageDescriptorArgs

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    TableType string

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    TargetTable CatalogTableTargetTableArgs

    Configuration block of a target table for resource linking. See target_table below.

    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.

    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.

    openTableFormatInput CatalogTableOpenTableFormatInput

    Configuration block for open table formats. See open_table_format_input below.

    owner String

    Owner of the table.

    parameters Map<String,String>

    Properties associated with this table, as a list of key-value pairs.

    partitionIndices List<CatalogTablePartitionIndex>

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partitionKeys List<CatalogTablePartitionKey>

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention Integer

    Retention time for this table.

    storageDescriptor CatalogTableStorageDescriptor

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    tableType String

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    targetTable CatalogTableTargetTable

    Configuration block of a target table for resource linking. See target_table below.

    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.

    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.

    openTableFormatInput CatalogTableOpenTableFormatInput

    Configuration block for open table formats. See open_table_format_input below.

    owner string

    Owner of the table.

    parameters {[key: string]: string}

    Properties associated with this table, as a list of key-value pairs.

    partitionIndices CatalogTablePartitionIndex[]

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partitionKeys CatalogTablePartitionKey[]

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention number

    Retention time for this table.

    storageDescriptor CatalogTableStorageDescriptor

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    tableType string

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    targetTable CatalogTableTargetTable

    Configuration block of a target table for resource linking. See target_table below.

    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.

    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_format_input CatalogTableOpenTableFormatInputArgs

    Configuration block for open table formats. See open_table_format_input below.

    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[CatalogTablePartitionIndexArgs]

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partition_keys Sequence[CatalogTablePartitionKeyArgs]

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention int

    Retention time for this table.

    storage_descriptor CatalogTableStorageDescriptorArgs

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    table_type str

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    target_table CatalogTableTargetTableArgs

    Configuration block of a target table for resource linking. See target_table below.

    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.

    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.

    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.

    openTableFormatInput Property Map

    Configuration block for open table formats. See open_table_format_input below.

    owner String

    Owner of the table.

    parameters Map<String>

    Properties associated with this table, as a list of key-value pairs.

    partitionIndices List<Property Map>

    Configuration block for a maximum of 3 partition indexes. See partition_index below.

    partitionKeys List<Property Map>

    Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.

    retention Number

    Retention time for this table.

    storageDescriptor Property Map

    Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.

    tableType String

    Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.

    targetTable Property Map

    Configuration block of a target table for resource linking. See target_table below.

    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.

    Supporting Types

    CatalogTableOpenTableFormatInput, CatalogTableOpenTableFormatInputArgs

    IcebergInput CatalogTableOpenTableFormatInputIcebergInput

    Configuration block for iceberg table config. See iceberg_input below.

    IcebergInput CatalogTableOpenTableFormatInputIcebergInput

    Configuration block for iceberg table config. See iceberg_input below.

    icebergInput CatalogTableOpenTableFormatInputIcebergInput

    Configuration block for iceberg table config. See iceberg_input below.

    icebergInput CatalogTableOpenTableFormatInputIcebergInput

    Configuration block for iceberg table config. See iceberg_input below.

    iceberg_input CatalogTableOpenTableFormatInputIcebergInput

    Configuration block for iceberg table config. See iceberg_input below.

    icebergInput Property Map

    Configuration block for iceberg table config. See iceberg_input below.

    CatalogTableOpenTableFormatInputIcebergInput, CatalogTableOpenTableFormatInputIcebergInputArgs

    MetadataOperation string

    A required metadata operation. Can only be set to CREATE.

    Version string

    The table version for the Iceberg table. Defaults to 2.

    MetadataOperation string

    A required metadata operation. Can only be set to CREATE.

    Version string

    The table version for the Iceberg table. Defaults to 2.

    metadataOperation String

    A required metadata operation. Can only be set to CREATE.

    version String

    The table version for the Iceberg table. Defaults to 2.

    metadataOperation 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.

    metadataOperation 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

    IndexName string

    Name of the partition index.

    Keys List<string>

    Keys for the partition index.

    IndexStatus string
    IndexName string

    Name of the partition index.

    Keys []string

    Keys for the partition index.

    IndexStatus string
    indexName String

    Name of the partition index.

    keys List<String>

    Keys for the partition index.

    indexStatus String
    indexName string

    Name of the partition index.

    keys string[]

    Keys for the partition index.

    indexStatus string
    index_name str

    Name of the partition index.

    keys Sequence[str]

    Keys for the partition index.

    index_status str
    indexName String

    Name of the partition index.

    keys List<String>

    Keys for the partition index.

    indexStatus String

    CatalogTablePartitionKey, CatalogTablePartitionKeyArgs

    Name string

    Name of the Partition Key.

    Comment string

    Free-form text comment.

    Type string

    Datatype of data in the Partition Key.

    Name string

    Name of the Partition Key.

    Comment string

    Free-form text comment.

    Type string

    Datatype of data in the Partition Key.

    name String

    Name of the Partition Key.

    comment String

    Free-form text comment.

    type String

    Datatype of data in the Partition Key.

    name string

    Name of the Partition Key.

    comment string

    Free-form text comment.

    type string

    Datatype of data in the Partition Key.

    name str

    Name of the Partition Key.

    comment str

    Free-form text comment.

    type str

    Datatype of data in the Partition Key.

    name String

    Name of the Partition Key.

    comment String

    Free-form text comment.

    type String

    Datatype of data in the Partition Key.

    CatalogTableStorageDescriptor, CatalogTableStorageDescriptorArgs

    BucketColumns List<string>

    List of reducer grouping columns, clustering columns, and bucketing columns in the table.

    Columns List<CatalogTableStorageDescriptorColumn>

    Configuration block for columns in the table. See columns below.

    Compressed bool

    Whether the data in the table is compressed.

    InputFormat 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.

    NumberOfBuckets int

    Must be specified if the table contains any dimension columns.

    OutputFormat string

    Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

    Parameters Dictionary<string, string>

    User-supplied properties in key-value form.

    SchemaReference CatalogTableStorageDescriptorSchemaReference

    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.

    SerDeInfo CatalogTableStorageDescriptorSerDeInfo

    Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.

    SkewedInfo CatalogTableStorageDescriptorSkewedInfo

    Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.

    SortColumns List<CatalogTableStorageDescriptorSortColumn>

    Configuration block for the sort order of each bucket in the table. See sort_columns below.

    StoredAsSubDirectories bool

    Whether the table data is stored in subdirectories.

    BucketColumns []string

    List of reducer grouping columns, clustering columns, and bucketing columns in the table.

    Columns []CatalogTableStorageDescriptorColumn

    Configuration block for columns in the table. See columns below.

    Compressed bool

    Whether the data in the table is compressed.

    InputFormat 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.

    NumberOfBuckets int

    Must be specified if the table contains any dimension columns.

    OutputFormat string

    Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

    Parameters map[string]string

    User-supplied properties in key-value form.

    SchemaReference CatalogTableStorageDescriptorSchemaReference

    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.

    SerDeInfo CatalogTableStorageDescriptorSerDeInfo

    Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.

    SkewedInfo CatalogTableStorageDescriptorSkewedInfo

    Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.

    SortColumns []CatalogTableStorageDescriptorSortColumn

    Configuration block for the sort order of each bucket in the table. See sort_columns below.

    StoredAsSubDirectories bool

    Whether the table data is stored in subdirectories.

    bucketColumns List<String>

    List of reducer grouping columns, clustering columns, and bucketing columns in the table.

    columns List<CatalogTableStorageDescriptorColumn>

    Configuration block for columns in the table. See columns below.

    compressed Boolean

    Whether the data in the table is compressed.

    inputFormat 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.

    numberOfBuckets Integer

    Must be specified if the table contains any dimension columns.

    outputFormat String

    Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

    parameters Map<String,String>

    User-supplied properties in key-value form.

    schemaReference CatalogTableStorageDescriptorSchemaReference

    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.

    serDeInfo CatalogTableStorageDescriptorSerDeInfo

    Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.

    skewedInfo CatalogTableStorageDescriptorSkewedInfo

    Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.

    sortColumns List<CatalogTableStorageDescriptorSortColumn>

    Configuration block for the sort order of each bucket in the table. See sort_columns below.

    storedAsSubDirectories Boolean

    Whether the table data is stored in subdirectories.

    bucketColumns string[]

    List of reducer grouping columns, clustering columns, and bucketing columns in the table.

    columns CatalogTableStorageDescriptorColumn[]

    Configuration block for columns in the table. See columns below.

    compressed boolean

    Whether the data in the table is compressed.

    inputFormat 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.

    numberOfBuckets number

    Must be specified if the table contains any dimension columns.

    outputFormat string

    Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

    parameters {[key: string]: string}

    User-supplied properties in key-value form.

    schemaReference CatalogTableStorageDescriptorSchemaReference

    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.

    serDeInfo CatalogTableStorageDescriptorSerDeInfo

    Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.

    skewedInfo CatalogTableStorageDescriptorSkewedInfo

    Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.

    sortColumns CatalogTableStorageDescriptorSortColumn[]

    Configuration block for the sort order of each bucket in the table. See sort_columns below.

    storedAsSubDirectories boolean

    Whether the table data is stored in subdirectories.

    bucket_columns Sequence[str]

    List of reducer grouping columns, clustering columns, and bucketing columns in the table.

    columns Sequence[CatalogTableStorageDescriptorColumn]

    Configuration block for columns in the table. See columns below.

    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_buckets int

    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 CatalogTableStorageDescriptorSchemaReference

    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_info CatalogTableStorageDescriptorSerDeInfo

    Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.

    skewed_info CatalogTableStorageDescriptorSkewedInfo

    Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.

    sort_columns Sequence[CatalogTableStorageDescriptorSortColumn]

    Configuration block for the sort order of each bucket in the table. See sort_columns below.

    stored_as_sub_directories bool

    Whether the table data is stored in subdirectories.

    bucketColumns 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 columns below.

    compressed Boolean

    Whether the data in the table is compressed.

    inputFormat 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.

    numberOfBuckets Number

    Must be specified if the table contains any dimension columns.

    outputFormat String

    Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

    parameters Map<String>

    User-supplied properties in key-value form.

    schemaReference 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.

    serDeInfo Property Map

    Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.

    skewedInfo Property Map

    Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.

    sortColumns List<Property Map>

    Configuration block for the sort order of each bucket in the table. See sort_columns below.

    storedAsSubDirectories Boolean

    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

    SchemaVersionNumber int

    Version number of the schema.

    SchemaId CatalogTableStorageDescriptorSchemaReferenceSchemaId

    Configuration block that contains schema identity fields. Either this or the schema_version_id has to be provided. See schema_id below.

    SchemaVersionId string

    Unique ID assigned to a version of the schema. Either this or the schema_id has to be provided.

    SchemaVersionNumber int

    Version number of the schema.

    SchemaId CatalogTableStorageDescriptorSchemaReferenceSchemaId

    Configuration block that contains schema identity fields. Either this or the schema_version_id has to be provided. See schema_id below.

    SchemaVersionId string

    Unique ID assigned to a version of the schema. Either this or the schema_id has to be provided.

    schemaVersionNumber Integer

    Version number of the schema.

    schemaId CatalogTableStorageDescriptorSchemaReferenceSchemaId

    Configuration block that contains schema identity fields. Either this or the schema_version_id has to be provided. See schema_id below.

    schemaVersionId String

    Unique ID assigned to a version of the schema. Either this or the schema_id has to be provided.

    schemaVersionNumber number

    Version number of the schema.

    schemaId CatalogTableStorageDescriptorSchemaReferenceSchemaId

    Configuration block that contains schema identity fields. Either this or the schema_version_id has to be provided. See schema_id below.

    schemaVersionId string

    Unique ID assigned to a version of the schema. Either this or the schema_id has to be provided.

    schema_version_number int

    Version number of the schema.

    schema_id CatalogTableStorageDescriptorSchemaReferenceSchemaId

    Configuration block that contains schema identity fields. Either this or the schema_version_id has to be provided. See schema_id below.

    schema_version_id str

    Unique ID assigned to a version of the schema. Either this or the schema_id has to be provided.

    schemaVersionNumber Number

    Version number of the schema.

    schemaId Property Map

    Configuration block that contains schema identity fields. Either this or the schema_version_id has to be provided. See schema_id below.

    schemaVersionId String

    Unique ID assigned to a version of the schema. Either this or the schema_id has to be provided.

    CatalogTableStorageDescriptorSchemaReferenceSchemaId, CatalogTableStorageDescriptorSchemaReferenceSchemaIdArgs

    RegistryName string

    Name of the schema registry that contains the schema. Must be provided when schema_name is specified and conflicts with schema_arn.

    SchemaArn string

    ARN of the schema. One of schema_arn or schema_name has to be provided.

    SchemaName string

    Name of the schema. One of schema_arn or schema_name has to be provided.

    RegistryName string

    Name of the schema registry that contains the schema. Must be provided when schema_name is specified and conflicts with schema_arn.

    SchemaArn string

    ARN of the schema. One of schema_arn or schema_name has to be provided.

    SchemaName string

    Name of the schema. One of schema_arn or schema_name has to be provided.

    registryName String

    Name of the schema registry that contains the schema. Must be provided when schema_name is specified and conflicts with schema_arn.

    schemaArn String

    ARN of the schema. One of schema_arn or schema_name has to be provided.

    schemaName String

    Name of the schema. One of schema_arn or schema_name has to be provided.

    registryName string

    Name of the schema registry that contains the schema. Must be provided when schema_name is specified and conflicts with schema_arn.

    schemaArn string

    ARN of the schema. One of schema_arn or schema_name has to be provided.

    schemaName string

    Name of the schema. One of schema_arn or schema_name has to be provided.

    registry_name str

    Name of the schema registry that contains the schema. Must be provided when schema_name is specified and conflicts with schema_arn.

    schema_arn str

    ARN of the schema. One of schema_arn or schema_name has to be provided.

    schema_name str

    Name of the schema. One of schema_arn or schema_name has to be provided.

    registryName String

    Name of the schema registry that contains the schema. Must be provided when schema_name is specified and conflicts with schema_arn.

    schemaArn String

    ARN of the schema. One of schema_arn or schema_name has to be provided.

    schemaName String

    Name of the schema. One of schema_arn or schema_name has 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.

    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

    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>

    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}

    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 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.

    serializationLibrary String

    Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

    CatalogTableStorageDescriptorSkewedInfo, CatalogTableStorageDescriptorSkewedInfoArgs

    SkewedColumnNames List<string>

    List of names of columns that contain skewed values.

    SkewedColumnValueLocationMaps Dictionary<string, string>

    List of values that appear so frequently as to be considered skewed.

    SkewedColumnValues List<string>

    Map of skewed values to the columns that contain them.

    SkewedColumnNames []string

    List of names of columns that contain skewed values.

    SkewedColumnValueLocationMaps map[string]string

    List of values that appear so frequently as to be considered skewed.

    SkewedColumnValues []string

    Map of skewed values to the columns that contain them.

    skewedColumnNames List<String>

    List of names of columns that contain skewed values.

    skewedColumnValueLocationMaps Map<String,String>

    List of values that appear so frequently as to be considered skewed.

    skewedColumnValues List<String>

    Map of skewed values to the columns that contain them.

    skewedColumnNames string[]

    List of names of columns that contain skewed values.

    skewedColumnValueLocationMaps {[key: string]: string}

    List of values that appear so frequently as to be considered skewed.

    skewedColumnValues string[]

    Map of skewed values to the columns that contain them.

    skewed_column_names Sequence[str]

    List of names of columns that contain skewed values.

    skewed_column_value_location_maps Mapping[str, str]

    List of values that appear so frequently as to be considered skewed.

    skewed_column_values Sequence[str]

    Map of skewed values to the columns that contain them.

    skewedColumnNames List<String>

    List of names of columns that contain skewed values.

    skewedColumnValueLocationMaps Map<String>

    List of values that appear so frequently as to be considered skewed.

    skewedColumnValues List<String>

    Map of skewed values to the columns that contain them.

    CatalogTableStorageDescriptorSortColumn, CatalogTableStorageDescriptorSortColumnArgs

    Column string

    Name of the column.

    SortOrder int

    Whether the column is sorted in ascending (1) or descending order (0).

    Column string

    Name of the column.

    SortOrder int

    Whether the column is sorted in ascending (1) or descending order (0).

    column String

    Name of the column.

    sortOrder Integer

    Whether the column is sorted in ascending (1) or descending order (0).

    column string

    Name of the column.

    sortOrder number

    Whether the column is sorted in ascending (1) or descending order (0).

    column str

    Name of the column.

    sort_order int

    Whether the column is sorted in ascending (1) or descending order (0).

    column String

    Name of the column.

    sortOrder Number

    Whether the column is sorted in ascending (1) or descending order (0).

    CatalogTableTargetTable, CatalogTableTargetTableArgs

    CatalogId string

    ID of the Data Catalog in which the table resides.

    DatabaseName string

    Name of the catalog database that contains the target table.

    Name string

    Name of the target table.

    CatalogId string

    ID of the Data Catalog in which the table resides.

    DatabaseName string

    Name of the catalog database that contains the target table.

    Name string

    Name of the target table.

    catalogId String

    ID of the Data Catalog in which the table resides.

    databaseName String

    Name of the catalog database that contains the target table.

    name String

    Name of the target table.

    catalogId string

    ID of the Data Catalog in which the table resides.

    databaseName string

    Name of the catalog database that contains the target table.

    name string

    Name 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.

    catalogId String

    ID of the Data Catalog in which the table resides.

    databaseName String

    Name of the catalog database that contains the target table.

    name String

    Name 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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
    pulumi/pulumi-aws