AWS v6.77.0, Apr 9 25

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.glue.PartitionIndex

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = new aws.glue.CatalogDatabase("example", {name: "example"});
const exampleCatalogTable = new aws.glue.CatalogTable("example", {
    name: "example",
    databaseName: example.name,
    owner: "my_owner",
    retention: 1,
    tableType: "VIRTUAL_VIEW",
    viewExpandedText: "view_expanded_text_1",
    viewOriginalText: "view_original_text_1",
    storageDescriptor: {
        bucketColumns: ["bucket_column_1"],
        compressed: false,
        inputFormat: "SequenceFileInputFormat",
        location: "my_location",
        numberOfBuckets: 1,
        outputFormat: "SequenceFileInputFormat",
        storedAsSubDirectories: false,
        parameters: {
            param1: "param1_val",
        },
        columns: [
            {
                name: "my_column_1",
                type: "int",
                comment: "my_column1_comment",
            },
            {
                name: "my_column_2",
                type: "string",
                comment: "my_column2_comment",
            },
        ],
        serDeInfo: {
            name: "ser_de_name",
            parameters: {
                param1: "param_val_1",
            },
            serializationLibrary: "org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe",
        },
        sortColumns: [{
            column: "my_column_1",
            sortOrder: 1,
        }],
        skewedInfo: {
            skewedColumnNames: ["my_column_1"],
            skewedColumnValueLocationMaps: {
                my_column_1: "my_column_1_val_loc_map",
            },
            skewedColumnValues: ["skewed_val_1"],
        },
    },
    partitionKeys: [
        {
            name: "my_column_1",
            type: "int",
            comment: "my_column_1_comment",
        },
        {
            name: "my_column_2",
            type: "string",
            comment: "my_column_2_comment",
        },
    ],
    parameters: {
        param1: "param1_val",
    },
});
const examplePartitionIndex = new aws.glue.PartitionIndex("example", {
    databaseName: example.name,
    tableName: exampleCatalogTable.name,
    partitionIndex: {
        indexName: "example",
        keys: [
            "my_column_1",
            "my_column_2",
        ],
    },
});

import pulumi
import pulumi_aws as aws

example = aws.glue.CatalogDatabase("example", name="example")
example_catalog_table = aws.glue.CatalogTable("example",
    name="example",
    database_name=example.name,
    owner="my_owner",
    retention=1,
    table_type="VIRTUAL_VIEW",
    view_expanded_text="view_expanded_text_1",
    view_original_text="view_original_text_1",
    storage_descriptor={
        "bucket_columns": ["bucket_column_1"],
        "compressed": False,
        "input_format": "SequenceFileInputFormat",
        "location": "my_location",
        "number_of_buckets": 1,
        "output_format": "SequenceFileInputFormat",
        "stored_as_sub_directories": False,
        "parameters": {
            "param1": "param1_val",
        },
        "columns": [
            {
                "name": "my_column_1",
                "type": "int",
                "comment": "my_column1_comment",
            },
            {
                "name": "my_column_2",
                "type": "string",
                "comment": "my_column2_comment",
            },
        ],
        "ser_de_info": {
            "name": "ser_de_name",
            "parameters": {
                "param1": "param_val_1",
            },
            "serialization_library": "org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe",
        },
        "sort_columns": [{
            "column": "my_column_1",
            "sort_order": 1,
        }],
        "skewed_info": {
            "skewed_column_names": ["my_column_1"],
            "skewed_column_value_location_maps": {
                "my_column_1": "my_column_1_val_loc_map",
            },
            "skewed_column_values": ["skewed_val_1"],
        },
    },
    partition_keys=[
        {
            "name": "my_column_1",
            "type": "int",
            "comment": "my_column_1_comment",
        },
        {
            "name": "my_column_2",
            "type": "string",
            "comment": "my_column_2_comment",
        },
    ],
    parameters={
        "param1": "param1_val",
    })
example_partition_index = aws.glue.PartitionIndex("example",
    database_name=example.name,
    table_name=example_catalog_table.name,
    partition_index={
        "index_name": "example",
        "keys": [
            "my_column_1",
            "my_column_2",
        ],
    })

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 {
		example, err := glue.NewCatalogDatabase(ctx, "example", &glue.CatalogDatabaseArgs{
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleCatalogTable, err := glue.NewCatalogTable(ctx, "example", &glue.CatalogTableArgs{
			Name:             pulumi.String("example"),
			DatabaseName:     example.Name,
			Owner:            pulumi.String("my_owner"),
			Retention:        pulumi.Int(1),
			TableType:        pulumi.String("VIRTUAL_VIEW"),
			ViewExpandedText: pulumi.String("view_expanded_text_1"),
			ViewOriginalText: pulumi.String("view_original_text_1"),
			StorageDescriptor: &glue.CatalogTableStorageDescriptorArgs{
				BucketColumns: pulumi.StringArray{
					pulumi.String("bucket_column_1"),
				},
				Compressed:             pulumi.Bool(false),
				InputFormat:            pulumi.String("SequenceFileInputFormat"),
				Location:               pulumi.String("my_location"),
				NumberOfBuckets:        pulumi.Int(1),
				OutputFormat:           pulumi.String("SequenceFileInputFormat"),
				StoredAsSubDirectories: pulumi.Bool(false),
				Parameters: pulumi.StringMap{
					"param1": pulumi.String("param1_val"),
				},
				Columns: glue.CatalogTableStorageDescriptorColumnArray{
					&glue.CatalogTableStorageDescriptorColumnArgs{
						Name:    pulumi.String("my_column_1"),
						Type:    pulumi.String("int"),
						Comment: pulumi.String("my_column1_comment"),
					},
					&glue.CatalogTableStorageDescriptorColumnArgs{
						Name:    pulumi.String("my_column_2"),
						Type:    pulumi.String("string"),
						Comment: pulumi.String("my_column2_comment"),
					},
				},
				SerDeInfo: &glue.CatalogTableStorageDescriptorSerDeInfoArgs{
					Name: pulumi.String("ser_de_name"),
					Parameters: pulumi.StringMap{
						"param1": pulumi.String("param_val_1"),
					},
					SerializationLibrary: pulumi.String("org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe"),
				},
				SortColumns: glue.CatalogTableStorageDescriptorSortColumnArray{
					&glue.CatalogTableStorageDescriptorSortColumnArgs{
						Column:    pulumi.String("my_column_1"),
						SortOrder: pulumi.Int(1),
					},
				},
				SkewedInfo: &glue.CatalogTableStorageDescriptorSkewedInfoArgs{
					SkewedColumnNames: pulumi.StringArray{
						pulumi.String("my_column_1"),
					},
					SkewedColumnValueLocationMaps: pulumi.StringMap{
						"my_column_1": pulumi.String("my_column_1_val_loc_map"),
					},
					SkewedColumnValues: pulumi.StringArray{
						pulumi.String("skewed_val_1"),
					},
				},
			},
			PartitionKeys: glue.CatalogTablePartitionKeyArray{
				&glue.CatalogTablePartitionKeyArgs{
					Name:    pulumi.String("my_column_1"),
					Type:    pulumi.String("int"),
					Comment: pulumi.String("my_column_1_comment"),
				},
				&glue.CatalogTablePartitionKeyArgs{
					Name:    pulumi.String("my_column_2"),
					Type:    pulumi.String("string"),
					Comment: pulumi.String("my_column_2_comment"),
				},
			},
			Parameters: pulumi.StringMap{
				"param1": pulumi.String("param1_val"),
			},
		})
		if err != nil {
			return err
		}
		_, err = glue.NewPartitionIndex(ctx, "example", &glue.PartitionIndexArgs{
			DatabaseName: example.Name,
			TableName:    exampleCatalogTable.Name,
			PartitionIndex: &glue.PartitionIndexPartitionIndexArgs{
				IndexName: pulumi.String("example"),
				Keys: pulumi.StringArray{
					pulumi.String("my_column_1"),
					pulumi.String("my_column_2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Glue.CatalogDatabase("example", new()
    {
        Name = "example",
    });

    var exampleCatalogTable = new Aws.Glue.CatalogTable("example", new()
    {
        Name = "example",
        DatabaseName = example.Name,
        Owner = "my_owner",
        Retention = 1,
        TableType = "VIRTUAL_VIEW",
        ViewExpandedText = "view_expanded_text_1",
        ViewOriginalText = "view_original_text_1",
        StorageDescriptor = new Aws.Glue.Inputs.CatalogTableStorageDescriptorArgs
        {
            BucketColumns = new[]
            {
                "bucket_column_1",
            },
            Compressed = false,
            InputFormat = "SequenceFileInputFormat",
            Location = "my_location",
            NumberOfBuckets = 1,
            OutputFormat = "SequenceFileInputFormat",
            StoredAsSubDirectories = false,
            Parameters = 
            {
                { "param1", "param1_val" },
            },
            Columns = new[]
            {
                new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
                {
                    Name = "my_column_1",
                    Type = "int",
                    Comment = "my_column1_comment",
                },
                new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
                {
                    Name = "my_column_2",
                    Type = "string",
                    Comment = "my_column2_comment",
                },
            },
            SerDeInfo = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSerDeInfoArgs
            {
                Name = "ser_de_name",
                Parameters = 
                {
                    { "param1", "param_val_1" },
                },
                SerializationLibrary = "org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe",
            },
            SortColumns = new[]
            {
                new Aws.Glue.Inputs.CatalogTableStorageDescriptorSortColumnArgs
                {
                    Column = "my_column_1",
                    SortOrder = 1,
                },
            },
            SkewedInfo = new Aws.Glue.Inputs.CatalogTableStorageDescriptorSkewedInfoArgs
            {
                SkewedColumnNames = new[]
                {
                    "my_column_1",
                },
                SkewedColumnValueLocationMaps = 
                {
                    { "my_column_1", "my_column_1_val_loc_map" },
                },
                SkewedColumnValues = new[]
                {
                    "skewed_val_1",
                },
            },
        },
        PartitionKeys = new[]
        {
            new Aws.Glue.Inputs.CatalogTablePartitionKeyArgs
            {
                Name = "my_column_1",
                Type = "int",
                Comment = "my_column_1_comment",
            },
            new Aws.Glue.Inputs.CatalogTablePartitionKeyArgs
            {
                Name = "my_column_2",
                Type = "string",
                Comment = "my_column_2_comment",
            },
        },
        Parameters = 
        {
            { "param1", "param1_val" },
        },
    });

    var examplePartitionIndex = new Aws.Glue.PartitionIndex("example", new()
    {
        DatabaseName = example.Name,
        TableName = exampleCatalogTable.Name,
        PartitionIndexConfig = new Aws.Glue.Inputs.PartitionIndexPartitionIndexArgs
        {
            IndexName = "example",
            Keys = new[]
            {
                "my_column_1",
                "my_column_2",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.CatalogDatabase;
import com.pulumi.aws.glue.CatalogDatabaseArgs;
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 com.pulumi.aws.glue.inputs.CatalogTableStorageDescriptorSkewedInfoArgs;
import com.pulumi.aws.glue.inputs.CatalogTablePartitionKeyArgs;
import com.pulumi.aws.glue.PartitionIndex;
import com.pulumi.aws.glue.PartitionIndexArgs;
import com.pulumi.aws.glue.inputs.PartitionIndexPartitionIndexArgs;
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 example = new CatalogDatabase("example", CatalogDatabaseArgs.builder()
            .name("example")
            .build());

        var exampleCatalogTable = new CatalogTable("exampleCatalogTable", CatalogTableArgs.builder()
            .name("example")
            .databaseName(example.name())
            .owner("my_owner")
            .retention(1)
            .tableType("VIRTUAL_VIEW")
            .viewExpandedText("view_expanded_text_1")
            .viewOriginalText("view_original_text_1")
            .storageDescriptor(CatalogTableStorageDescriptorArgs.builder()
                .bucketColumns("bucket_column_1")
                .compressed(false)
                .inputFormat("SequenceFileInputFormat")
                .location("my_location")
                .numberOfBuckets(1)
                .outputFormat("SequenceFileInputFormat")
                .storedAsSubDirectories(false)
                .parameters(Map.of("param1", "param1_val"))
                .columns(                
                    CatalogTableStorageDescriptorColumnArgs.builder()
                        .name("my_column_1")
                        .type("int")
                        .comment("my_column1_comment")
                        .build(),
                    CatalogTableStorageDescriptorColumnArgs.builder()
                        .name("my_column_2")
                        .type("string")
                        .comment("my_column2_comment")
                        .build())
                .serDeInfo(CatalogTableStorageDescriptorSerDeInfoArgs.builder()
                    .name("ser_de_name")
                    .parameters(Map.of("param1", "param_val_1"))
                    .serializationLibrary("org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe")
                    .build())
                .sortColumns(CatalogTableStorageDescriptorSortColumnArgs.builder()
                    .column("my_column_1")
                    .sortOrder(1)
                    .build())
                .skewedInfo(CatalogTableStorageDescriptorSkewedInfoArgs.builder()
                    .skewedColumnNames("my_column_1")
                    .skewedColumnValueLocationMaps(Map.of("my_column_1", "my_column_1_val_loc_map"))
                    .skewedColumnValues("skewed_val_1")
                    .build())
                .build())
            .partitionKeys(            
                CatalogTablePartitionKeyArgs.builder()
                    .name("my_column_1")
                    .type("int")
                    .comment("my_column_1_comment")
                    .build(),
                CatalogTablePartitionKeyArgs.builder()
                    .name("my_column_2")
                    .type("string")
                    .comment("my_column_2_comment")
                    .build())
            .parameters(Map.of("param1", "param1_val"))
            .build());

        var examplePartitionIndex = new PartitionIndex("examplePartitionIndex", PartitionIndexArgs.builder()
            .databaseName(example.name())
            .tableName(exampleCatalogTable.name())
            .partitionIndex(PartitionIndexPartitionIndexArgs.builder()
                .indexName("example")
                .keys(                
                    "my_column_1",
                    "my_column_2")
                .build())
            .build());

    }
}

resources:
  example:
    type: aws:glue:CatalogDatabase
    properties:
      name: example
  exampleCatalogTable:
    type: aws:glue:CatalogTable
    name: example
    properties:
      name: example
      databaseName: ${example.name}
      owner: my_owner
      retention: 1
      tableType: VIRTUAL_VIEW
      viewExpandedText: view_expanded_text_1
      viewOriginalText: view_original_text_1
      storageDescriptor:
        bucketColumns:
          - bucket_column_1
        compressed: false
        inputFormat: SequenceFileInputFormat
        location: my_location
        numberOfBuckets: 1
        outputFormat: SequenceFileInputFormat
        storedAsSubDirectories: false
        parameters:
          param1: param1_val
        columns:
          - name: my_column_1
            type: int
            comment: my_column1_comment
          - name: my_column_2
            type: string
            comment: my_column2_comment
        serDeInfo:
          name: ser_de_name
          parameters:
            param1: param_val_1
          serializationLibrary: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe
        sortColumns:
          - column: my_column_1
            sortOrder: 1
        skewedInfo:
          skewedColumnNames:
            - my_column_1
          skewedColumnValueLocationMaps:
            my_column_1: my_column_1_val_loc_map
          skewedColumnValues:
            - skewed_val_1
      partitionKeys:
        - name: my_column_1
          type: int
          comment: my_column_1_comment
        - name: my_column_2
          type: string
          comment: my_column_2_comment
      parameters:
        param1: param1_val
  examplePartitionIndex:
    type: aws:glue:PartitionIndex
    name: example
    properties:
      databaseName: ${example.name}
      tableName: ${exampleCatalogTable.name}
      partitionIndex:
        indexName: example
        keys:
          - my_column_1
          - my_column_2

Create PartitionIndex Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

new PartitionIndex(name: string, args: PartitionIndexArgs, opts?: CustomResourceOptions);

@overload
def PartitionIndex(resource_name: str,
                   args: PartitionIndexArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def PartitionIndex(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   database_name: Optional[str] = None,
                   partition_index: Optional[PartitionIndexPartitionIndexArgs] = None,
                   table_name: Optional[str] = None,
                   catalog_id: Optional[str] = None)

func NewPartitionIndex(ctx *Context, name string, args PartitionIndexArgs, opts ...ResourceOption) (*PartitionIndex, error)

public PartitionIndex(string name, PartitionIndexArgs args, CustomResourceOptions? opts = null)

public PartitionIndex(String name, PartitionIndexArgs args)
public PartitionIndex(String name, PartitionIndexArgs args, CustomResourceOptions options)

type: aws:glue:PartitionIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args PartitionIndexArgs: 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 PartitionIndexArgs: 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 PartitionIndexArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PartitionIndexArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PartitionIndexArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var partitionIndexResource = new Aws.Glue.PartitionIndex("partitionIndexResource", new()
{
    DatabaseName = "string",
    PartitionIndexConfig = new Aws.Glue.Inputs.PartitionIndexPartitionIndexArgs
    {
        IndexName = "string",
        IndexStatus = "string",
        Keys = new[]
        {
            "string",
        },
    },
    TableName = "string",
    CatalogId = "string",
});

example, err := glue.NewPartitionIndex(ctx, "partitionIndexResource", &glue.PartitionIndexArgs{
	DatabaseName: pulumi.String("string"),
	PartitionIndex: &glue.PartitionIndexPartitionIndexArgs{
		IndexName:   pulumi.String("string"),
		IndexStatus: pulumi.String("string"),
		Keys: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	TableName: pulumi.String("string"),
	CatalogId: pulumi.String("string"),
})

var partitionIndexResource = new PartitionIndex("partitionIndexResource", PartitionIndexArgs.builder()
    .databaseName("string")
    .partitionIndex(PartitionIndexPartitionIndexArgs.builder()
        .indexName("string")
        .indexStatus("string")
        .keys("string")
        .build())
    .tableName("string")
    .catalogId("string")
    .build());

partition_index_resource = aws.glue.PartitionIndex("partitionIndexResource",
    database_name="string",
    partition_index={
        "index_name": "string",
        "index_status": "string",
        "keys": ["string"],
    },
    table_name="string",
    catalog_id="string")

const partitionIndexResource = new aws.glue.PartitionIndex("partitionIndexResource", {
    databaseName: "string",
    partitionIndex: {
        indexName: "string",
        indexStatus: "string",
        keys: ["string"],
    },
    tableName: "string",
    catalogId: "string",
});

type: aws:glue:PartitionIndex
properties:
    catalogId: string
    databaseName: string
    partitionIndex:
        indexName: string
        indexStatus: string
        keys:
            - string
    tableName: string

PartitionIndex Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PartitionIndex 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.
PartitionIndexConfig PartitionIndexPartitionIndex: Configuration block for a partition index. See partition_index below.
TableName string: Name of the table. For Hive compatibility, this must be entirely lowercase.
CatalogId string: The catalog ID where the table resides.

DatabaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
PartitionIndex PartitionIndexPartitionIndexArgs: Configuration block for a partition index. See partition_index below.
TableName string: Name of the table. For Hive compatibility, this must be entirely lowercase.
CatalogId string: The catalog ID where the table resides.

databaseName String: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partitionIndex PartitionIndexPartitionIndex: Configuration block for a partition index. See partition_index below.
tableName String: Name of the table. For Hive compatibility, this must be entirely lowercase.
catalogId String: The catalog ID where the table resides.

databaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partitionIndex PartitionIndexPartitionIndex: Configuration block for a partition index. See partition_index below.
tableName string: Name of the table. For Hive compatibility, this must be entirely lowercase.
catalogId string: The catalog ID where the table resides.

database_name str: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partition_index PartitionIndexPartitionIndexArgs: Configuration block for a partition index. See partition_index below.
table_name str: Name of the table. For Hive compatibility, this must be entirely lowercase.
catalog_id str: The catalog ID where the table resides.

databaseName String: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partitionIndex Property Map: Configuration block for a partition index. See partition_index below.
tableName String: Name of the table. For Hive compatibility, this must be entirely lowercase.
catalogId String: The catalog ID where the table resides.

Outputs

All input properties are implicitly available as output properties. Additionally, the PartitionIndex resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing PartitionIndex Resource

Get an existing PartitionIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: PartitionIndexState, opts?: CustomResourceOptions): PartitionIndex

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_id: Optional[str] = None,
        database_name: Optional[str] = None,
        partition_index: Optional[PartitionIndexPartitionIndexArgs] = None,
        table_name: Optional[str] = None) -> PartitionIndex

func GetPartitionIndex(ctx *Context, name string, id IDInput, state *PartitionIndexState, opts ...ResourceOption) (*PartitionIndex, error)

public static PartitionIndex Get(string name, Input<string> id, PartitionIndexState? state, CustomResourceOptions? opts = null)

public static PartitionIndex get(String name, Output<String> id, PartitionIndexState state, CustomResourceOptions options)

resources:  _:    type: aws:glue:PartitionIndex    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CatalogId string: The catalog ID where the table resides.
DatabaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
PartitionIndexConfig PartitionIndexPartitionIndex: Configuration block for a partition index. See partition_index below.
TableName string: Name of the table. For Hive compatibility, this must be entirely lowercase.

CatalogId string: The catalog ID where the table resides.
DatabaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
PartitionIndex PartitionIndexPartitionIndexArgs: Configuration block for a partition index. See partition_index below.
TableName string: Name of the table. For Hive compatibility, this must be entirely lowercase.

catalogId String: The catalog ID where the table resides.
databaseName String: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partitionIndex PartitionIndexPartitionIndex: Configuration block for a partition index. See partition_index below.
tableName String: Name of the table. For Hive compatibility, this must be entirely lowercase.

catalogId string: The catalog ID where the table resides.
databaseName string: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partitionIndex PartitionIndexPartitionIndex: Configuration block for a partition index. See partition_index below.
tableName string: Name of the table. For Hive compatibility, this must be entirely lowercase.

catalog_id str: The catalog ID where the table resides.
database_name str: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partition_index PartitionIndexPartitionIndexArgs: Configuration block for a partition index. See partition_index below.
table_name str: Name of the table. For Hive compatibility, this must be entirely lowercase.

catalogId String: The catalog ID where the table resides.
databaseName String: Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
partitionIndex Property Map: Configuration block for a partition index. See partition_index below.
tableName String: Name of the table. For Hive compatibility, this must be entirely lowercase.

Supporting Types

PartitionIndexPartitionIndex
, PartitionIndexPartitionIndexArgs

IndexName string: Name of the partition index.
IndexStatus string
Keys List<string>: Keys for the partition index.

IndexName string: Name of the partition index.
IndexStatus string
Keys []string: Keys for the partition index.

indexName String: Name of the partition index.
indexStatus String
keys List<String>: Keys for the partition index.

indexName string: Name of the partition index.
indexStatus string
keys string[]: Keys for the partition index.

index_name str: Name of the partition index.
index_status str
keys Sequence[str]: Keys for the partition index.

indexName String: Name of the partition index.
indexStatus String
keys List<String>: Keys for the partition index.

Import

Using pulumi import, import Glue Partition Indexes using the catalog ID (usually AWS account ID), database name, table name, and index name. For example:

$ pulumi import aws:glue/partitionIndex:PartitionIndex example 123456789012:MyDatabase:MyTable:index-name

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-aws

aws.glue.PartitionIndex

On this page

On this page

Example Usage

Create PartitionIndex Resource

Constructor syntax

Parameters

Constructor example

PartitionIndex Resource Properties

Inputs

Outputs

Look up Existing PartitionIndex Resource

Supporting Types

PartitionIndexPartitionIndex
, PartitionIndexPartitionIndexArgs

Import

Package Details

On this page

On this page

aws.glue.PartitionIndex

On this page

On this page

Example Usage

Create PartitionIndex Resource

Constructor syntax

Parameters

Constructor example

PartitionIndex Resource Properties

Inputs

Outputs

Look up Existing PartitionIndex Resource

Supporting Types

PartitionIndexPartitionIndex, PartitionIndexPartitionIndexArgs

Import

Package Details

On this page

On this page

PartitionIndexPartitionIndex
, PartitionIndexPartitionIndexArgs