com.pulumi.aws.glue.kotlin.PartitionIndex.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.glue.kotlin
import com.pulumi.aws.glue.kotlin.outputs.PartitionIndexPartitionIndex
import com.pulumi.aws.glue.kotlin.outputs.PartitionIndexPartitionIndex.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [PartitionIndex].
*/
@PulumiTagMarker
public class PartitionIndexResourceBuilder internal constructor() {
public var name: String? = null
public var args: PartitionIndexArgs = PartitionIndexArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend PartitionIndexArgsBuilder.() -> Unit) {
val builder = PartitionIndexArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): PartitionIndex {
val builtJavaResource = com.pulumi.aws.glue.PartitionIndex(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PartitionIndex(builtJavaResource)
}
}
/**
* ## Example Usage
*
* ```typescript
* 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",
* ],
* },
* });
* ```
* ```python
* 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",
* ],
* })
* ```
* ```csharp
* 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",
* },
* },
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## 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:
* ```sh
* $ pulumi import aws:glue/partitionIndex:PartitionIndex example 123456789012:MyDatabase:MyTable:index-name
* ```
*/
public class PartitionIndex internal constructor(
override val javaResource: com.pulumi.aws.glue.PartitionIndex,
) : KotlinCustomResource(javaResource, PartitionIndexMapper) {
/**
* The catalog ID where the table resides.
*/
public val catalogId: Output
get() = javaResource.catalogId().applyValue({ args0 -> args0 })
/**
* Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
*/
public val databaseName: Output
get() = javaResource.databaseName().applyValue({ args0 -> args0 })
/**
* Configuration block for a partition index. See `partition_index` below.
*/
public val partitionIndex: Output
get() = javaResource.partitionIndex().applyValue({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
})
/**
* Name of the table. For Hive compatibility, this must be entirely lowercase.
*/
public val tableName: Output
get() = javaResource.tableName().applyValue({ args0 -> args0 })
}
public object PartitionIndexMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.glue.PartitionIndex::class == javaResource::class
override fun map(javaResource: Resource): PartitionIndex = PartitionIndex(
javaResource as
com.pulumi.aws.glue.PartitionIndex,
)
}
/**
* @see [PartitionIndex].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PartitionIndex].
*/
public suspend fun partitionIndex(
name: String,
block: suspend PartitionIndexResourceBuilder.() -> Unit,
): PartitionIndex {
val builder = PartitionIndexResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PartitionIndex].
* @param name The _unique_ name of the resulting resource.
*/
public fun partitionIndex(name: String): PartitionIndex {
val builder = PartitionIndexResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy