Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cleanrooms
  5. ConfiguredTable
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.cleanrooms.ConfiguredTable

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a AWS Clean Rooms configured table. Configured tables are used to represent references to existing tables in the AWS Glue Data Catalog.

    Example Usage

    Configured table with tags

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

const testConfiguredTable = new aws.cleanrooms.ConfiguredTable("test_configured_table", {
    name: "pulumi-example-table",
    description: "I made this table with Pulumi!",
    analysisMethod: "DIRECT_QUERY",
    allowedColumns: [
        "column1",
        "column2",
        "column3",
    ],
    tableReference: {
        databaseName: "example_database",
        tableName: "example_table",
    },
    tags: {
        Project: "Pulumi",
    },
});

    import pulumi
import pulumi_aws as aws

test_configured_table = aws.cleanrooms.ConfiguredTable("test_configured_table",
    name="pulumi-example-table",
    description="I made this table with Pulumi!",
    analysis_method="DIRECT_QUERY",
    allowed_columns=[
        "column1",
        "column2",
        "column3",
    ],
    table_reference={
        "database_name": "example_database",
        "table_name": "example_table",
    },
    tags={
        "Project": "Pulumi",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cleanrooms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cleanrooms.NewConfiguredTable(ctx, "test_configured_table", &cleanrooms.ConfiguredTableArgs{
			Name:           pulumi.String("pulumi-example-table"),
			Description:    pulumi.String("I made this table with Pulumi!"),
			AnalysisMethod: pulumi.String("DIRECT_QUERY"),
			AllowedColumns: pulumi.StringArray{
				pulumi.String("column1"),
				pulumi.String("column2"),
				pulumi.String("column3"),
			},
			TableReference: &cleanrooms.ConfiguredTableTableReferenceArgs{
				DatabaseName: pulumi.String("example_database"),
				TableName:    pulumi.String("example_table"),
			},
			Tags: pulumi.StringMap{
				"Project": pulumi.String("Pulumi"),
			},
		})
		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 testConfiguredTable = new Aws.CleanRooms.ConfiguredTable("test_configured_table", new()
    {
        Name = "pulumi-example-table",
        Description = "I made this table with Pulumi!",
        AnalysisMethod = "DIRECT_QUERY",
        AllowedColumns = new[]
        {
            "column1",
            "column2",
            "column3",
        },
        TableReference = new Aws.CleanRooms.Inputs.ConfiguredTableTableReferenceArgs
        {
            DatabaseName = "example_database",
            TableName = "example_table",
        },
        Tags = 
        {
            { "Project", "Pulumi" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cleanrooms.ConfiguredTable;
import com.pulumi.aws.cleanrooms.ConfiguredTableArgs;
import com.pulumi.aws.cleanrooms.inputs.ConfiguredTableTableReferenceArgs;
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 testConfiguredTable = new ConfiguredTable("testConfiguredTable", ConfiguredTableArgs.builder()
            .name("pulumi-example-table")
            .description("I made this table with Pulumi!")
            .analysisMethod("DIRECT_QUERY")
            .allowedColumns(            
                "column1",
                "column2",
                "column3")
            .tableReference(ConfiguredTableTableReferenceArgs.builder()
                .databaseName("example_database")
                .tableName("example_table")
                .build())
            .tags(Map.of("Project", "Pulumi"))
            .build());

    }
}

    resources:
  testConfiguredTable:
    type: aws:cleanrooms:ConfiguredTable
    name: test_configured_table
    properties:
      name: pulumi-example-table
      description: I made this table with Pulumi!
      analysisMethod: DIRECT_QUERY
      allowedColumns:
        - column1
        - column2
        - column3
      tableReference:
        databaseName: example_database
        tableName: example_table
      tags:
        Project: Pulumi

    Create ConfiguredTable Resource

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

    Constructor syntax

    new ConfiguredTable(name: string, args: ConfiguredTableArgs, opts?: CustomResourceOptions);
    @overload
def ConfiguredTable(resource_name: str,
                    args: ConfiguredTableArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ConfiguredTable(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    allowed_columns: Optional[Sequence[str]] = None,
                    analysis_method: Optional[str] = None,
                    table_reference: Optional[ConfiguredTableTableReferenceArgs] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewConfiguredTable(ctx *Context, name string, args ConfiguredTableArgs, opts ...ResourceOption) (*ConfiguredTable, error)
    public ConfiguredTable(string name, ConfiguredTableArgs args, CustomResourceOptions? opts = null)
    public ConfiguredTable(String name, ConfiguredTableArgs args)
public ConfiguredTable(String name, ConfiguredTableArgs args, CustomResourceOptions options)

    type: aws:cleanrooms:ConfiguredTable
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 ConfiguredTableArgs
    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 ConfiguredTableArgs
    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 ConfiguredTableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfiguredTableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfiguredTableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var configuredTableResource = new Aws.CleanRooms.ConfiguredTable("configuredTableResource", new()
{
    AllowedColumns = new[]
    {
        "string",
    },
    AnalysisMethod = "string",
    TableReference = new Aws.CleanRooms.Inputs.ConfiguredTableTableReferenceArgs
    {
        DatabaseName = "string",
        TableName = "string",
    },
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cleanrooms.NewConfiguredTable(ctx, "configuredTableResource", &cleanrooms.ConfiguredTableArgs{
	AllowedColumns: pulumi.StringArray{
		pulumi.String("string"),
	},
	AnalysisMethod: pulumi.String("string"),
	TableReference: &cleanrooms.ConfiguredTableTableReferenceArgs{
		DatabaseName: pulumi.String("string"),
		TableName:    pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var configuredTableResource = new ConfiguredTable("configuredTableResource", ConfiguredTableArgs.builder()
    .allowedColumns("string")
    .analysisMethod("string")
    .tableReference(ConfiguredTableTableReferenceArgs.builder()
        .databaseName("string")
        .tableName("string")
        .build())
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    configured_table_resource = aws.cleanrooms.ConfiguredTable("configuredTableResource",
    allowed_columns=["string"],
    analysis_method="string",
    table_reference={
        "database_name": "string",
        "table_name": "string",
    },
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const configuredTableResource = new aws.cleanrooms.ConfiguredTable("configuredTableResource", {
    allowedColumns: ["string"],
    analysisMethod: "string",
    tableReference: {
        databaseName: "string",
        tableName: "string",
    },
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:cleanrooms:ConfiguredTable
properties:
    allowedColumns:
        - string
    analysisMethod: string
    description: string
    name: string
    tableReference:
        databaseName: string
        tableName: string
    tags:
        string: string

    ConfiguredTable 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 ConfiguredTable resource accepts the following input properties:

    AllowedColumns List<string>
    The columns of the references table which will be included in the configured table.
    AnalysisMethod string
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    TableReference ConfiguredTableTableReference
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    Description string
    A description for the configured table.
    Name string
    The name of the configured table.
    Tags Dictionary<string, string>
    Key value pairs which tag the configured table.
    AllowedColumns []string
    The columns of the references table which will be included in the configured table.
    AnalysisMethod string
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    TableReference ConfiguredTableTableReferenceArgs
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    Description string
    A description for the configured table.
    Name string
    The name of the configured table.
    Tags map[string]string
    Key value pairs which tag the configured table.
    allowedColumns List<String>
    The columns of the references table which will be included in the configured table.
    analysisMethod String
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    tableReference ConfiguredTableTableReference
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    description String
    A description for the configured table.
    name String
    The name of the configured table.
    tags Map<String,String>
    Key value pairs which tag the configured table.
    allowedColumns string[]
    The columns of the references table which will be included in the configured table.
    analysisMethod string
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    tableReference ConfiguredTableTableReference
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    description string
    A description for the configured table.
    name string
    The name of the configured table.
    tags {[key: string]: string}
    Key value pairs which tag the configured table.
    allowed_columns Sequence[str]
    The columns of the references table which will be included in the configured table.
    analysis_method str
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    table_reference ConfiguredTableTableReferenceArgs
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    description str
    A description for the configured table.
    name str
    The name of the configured table.
    tags Mapping[str, str]
    Key value pairs which tag the configured table.
    allowedColumns List<String>
    The columns of the references table which will be included in the configured table.
    analysisMethod String
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    tableReference Property Map
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    description String
    A description for the configured table.
    name String
    The name of the configured table.
    tags Map<String>
    Key value pairs which tag the configured table.

    Outputs

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

    Arn string
    The ARN of the configured table.
    CreateTime string
    The date and time the configured table was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    UpdateTime string
    The date and time the configured table was last updated.
    Arn string
    The ARN of the configured table.
    CreateTime string
    The date and time the configured table was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    UpdateTime string
    The date and time the configured table was last updated.
    arn String
    The ARN of the configured table.
    createTime String
    The date and time the configured table was created.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    updateTime String
    The date and time the configured table was last updated.
    arn string
    The ARN of the configured table.
    createTime string
    The date and time the configured table was created.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    updateTime string
    The date and time the configured table was last updated.
    arn str
    The ARN of the configured table.
    create_time str
    The date and time the configured table was created.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    update_time str
    The date and time the configured table was last updated.
    arn String
    The ARN of the configured table.
    createTime String
    The date and time the configured table was created.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    updateTime String
    The date and time the configured table was last updated.

    Look up Existing ConfiguredTable Resource

    Get an existing ConfiguredTable 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?: ConfiguredTableState, opts?: CustomResourceOptions): ConfiguredTable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_columns: Optional[Sequence[str]] = None,
        analysis_method: Optional[str] = None,
        arn: Optional[str] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        table_reference: Optional[ConfiguredTableTableReferenceArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        update_time: Optional[str] = None) -> ConfiguredTable
    func GetConfiguredTable(ctx *Context, name string, id IDInput, state *ConfiguredTableState, opts ...ResourceOption) (*ConfiguredTable, error)
    public static ConfiguredTable Get(string name, Input<string> id, ConfiguredTableState? state, CustomResourceOptions? opts = null)
    public static ConfiguredTable get(String name, Output<String> id, ConfiguredTableState 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:
    AllowedColumns List<string>
    The columns of the references table which will be included in the configured table.
    AnalysisMethod string
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    Arn string
    The ARN of the configured table.
    CreateTime string
    The date and time the configured table was created.
    Description string
    A description for the configured table.
    Name string
    The name of the configured table.
    TableReference ConfiguredTableTableReference
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    Tags Dictionary<string, string>
    Key value pairs which tag the configured table.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    UpdateTime string
    The date and time the configured table was last updated.
    AllowedColumns []string
    The columns of the references table which will be included in the configured table.
    AnalysisMethod string
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    Arn string
    The ARN of the configured table.
    CreateTime string
    The date and time the configured table was created.
    Description string
    A description for the configured table.
    Name string
    The name of the configured table.
    TableReference ConfiguredTableTableReferenceArgs
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    Tags map[string]string
    Key value pairs which tag the configured table.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    UpdateTime string
    The date and time the configured table was last updated.
    allowedColumns List<String>
    The columns of the references table which will be included in the configured table.
    analysisMethod String
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    arn String
    The ARN of the configured table.
    createTime String
    The date and time the configured table was created.
    description String
    A description for the configured table.
    name String
    The name of the configured table.
    tableReference ConfiguredTableTableReference
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    tags Map<String,String>
    Key value pairs which tag the configured table.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    updateTime String
    The date and time the configured table was last updated.
    allowedColumns string[]
    The columns of the references table which will be included in the configured table.
    analysisMethod string
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    arn string
    The ARN of the configured table.
    createTime string
    The date and time the configured table was created.
    description string
    A description for the configured table.
    name string
    The name of the configured table.
    tableReference ConfiguredTableTableReference
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    tags {[key: string]: string}
    Key value pairs which tag the configured table.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    updateTime string
    The date and time the configured table was last updated.
    allowed_columns Sequence[str]
    The columns of the references table which will be included in the configured table.
    analysis_method str
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    arn str
    The ARN of the configured table.
    create_time str
    The date and time the configured table was created.
    description str
    A description for the configured table.
    name str
    The name of the configured table.
    table_reference ConfiguredTableTableReferenceArgs
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    tags Mapping[str, str]
    Key value pairs which tag the configured table.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    update_time str
    The date and time the configured table was last updated.
    allowedColumns List<String>
    The columns of the references table which will be included in the configured table.
    analysisMethod String
    The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.
    arn String
    The ARN of the configured table.
    createTime String
    The date and time the configured table was created.
    description String
    A description for the configured table.
    name String
    The name of the configured table.
    tableReference Property Map
    A reference to the AWS Glue table which will be used to create the configured table.

    • table_reference.database_name - (Required - Forces new resource) - The name of the AWS Glue database which contains the table.
    • table_reference.table_name - (Required - Forces new resource) - The name of the AWS Glue table which will be used to create the configured table.
    tags Map<String>
    Key value pairs which tag the configured table.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    updateTime String
    The date and time the configured table was last updated.

    Supporting Types

    ConfiguredTableTableReference, ConfiguredTableTableReferenceArgs

    DatabaseName string
    TableName string
    DatabaseName string
    TableName string
    databaseName String
    tableName String
    databaseName string
    tableName string
    databaseName String
    tableName String

    Import

    Using pulumi import, import aws_cleanrooms_configured_table using the id. For example:

    $ pulumi import aws:cleanrooms/configuredTable:ConfiguredTable table 1234abcd-12ab-34cd-56ef-1234567890ab

    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 logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws