ConfiguredTable class
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", {
tableReference: {
databaseName: "example_database",
tableName: "example_table",
},
name: "pulumi-example-table",
description: "I made this table with Pulumi!",
analysisMethod: "DIRECT_QUERY",
allowedColumns: [
"column1",
"column2",
"column3",
],
tags: {
Project: "Pulumi",
},
});
import pulumi
import pulumi_aws as aws
test_configured_table = aws.cleanrooms.ConfiguredTable("test_configured_table",
table_reference={
"database_name": "example_database",
"table_name": "example_table",
},
name="pulumi-example-table",
description="I made this table with Pulumi!",
analysis_method="DIRECT_QUERY",
allowed_columns=[
"column1",
"column2",
"column3",
],
tags={
"Project": "Pulumi",
})
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()
{
TableReference = new Aws.CleanRooms.Inputs.ConfiguredTableTableReferenceArgs
{
DatabaseName = "example_database",
TableName = "example_table",
},
Name = "pulumi-example-table",
Description = "I made this table with Pulumi!",
AnalysisMethod = "DIRECT_QUERY",
AllowedColumns = new[]
{
"column1",
"column2",
"column3",
},
Tags =
{
{ "Project", "Pulumi" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
TableReference: &cleanrooms.ConfiguredTableTableReferenceArgs{
DatabaseName: pulumi.String("example_database"),
TableName: pulumi.String("example_table"),
},
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"),
},
Tags: pulumi.StringMap{
"Project": pulumi.String("Pulumi"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cleanrooms_configuredtable" "test_configured_table" {
table_reference = {
database_name = "example_database"
table_name = "example_table"
}
name = "pulumi-example-table"
description = "I made this table with Pulumi!"
analysis_method = "DIRECT_QUERY"
allowed_columns = ["column1", "column2", "column3"]
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.ArrayList;
import java.util.Arrays;
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()
.tableReference(ConfiguredTableTableReferenceArgs.builder()
.databaseName("example_database")
.tableName("example_table")
.build())
.name("pulumi-example-table")
.description("I made this table with Pulumi!")
.analysisMethod("DIRECT_QUERY")
.allowedColumns(
"column1",
"column2",
"column3")
.tags(Map.of("Project", "Pulumi"))
.build());
}
}
resources:
testConfiguredTable:
type: aws:cleanrooms:ConfiguredTable
name: test_configured_table
properties:
tableReference:
databaseName: example_database
tableName: example_table
name: pulumi-example-table
description: I made this table with Pulumi!
analysisMethod: DIRECT_QUERY
allowedColumns:
- column1
- column2
- column3
tags:
Project: Pulumi
Import
Identity Schema
Required
id- (String) ID of the cleanrooms configured table.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import aws.cleanrooms.ConfiguredTable using the id. For example:
$ pulumi import aws:cleanrooms/configuredTable:ConfiguredTable table 1234abcd-12ab-34cd-56ef-1234567890ab
Constructors
- ConfiguredTable(String name, {ConfiguredTableArgs? args, CustomResourceOptions? options})
-
Creates a new ConfiguredTable.
nameThe Pulumi resource name.argsArguments used to configure this ConfiguredTable. The set of arguments for ConfiguredTable.optionsResource options controlling this resource's behavior. - ConfiguredTable.reference(String urn)
- Creates a typed reference to an existing ConfiguredTable resource.
Properties
-
allowedColumns
↔ Output<
List< String> > -
The columns of the references table which will be included in the configured table.
latefinal
-
analysisMethod
↔ Output<
String> -
The analysis method for the configured table. The only valid value is currently
DIRECT_QUERY.latefinal -
arn
↔ Output<
String> -
The ARN of the configured table.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createTime
↔ Output<
String> -
The date and time the configured table was created.
latefinal
-
description
↔ Output<
String?> -
A description for the configured table.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The name of the configured table.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
tableReference
↔ Output<
ConfiguredTableTableReference> -
A reference to the AWS Glue table which will be used to create the configured table.
latefinal
-
Key value pairs which tag the configured table.
latefinal
-
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
updateTime
↔ Output<
String> -
The date and time the configured table was last updated.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ConfiguredTableState? state, CustomResourceOptions? options}) → ConfiguredTable -
Gets an existing ConfiguredTable resource's state with the given
nameandid.