Docs Home
We recommend new projects start with resources from the AWS provider.
aws-native.cleanrooms.getConfiguredTable
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Represents a table that can be associated with collaborations
Using getConfiguredTable
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getConfiguredTable(args: GetConfiguredTableArgs, opts?: InvokeOptions): Promise<GetConfiguredTableResult>
function getConfiguredTableOutput(args: GetConfiguredTableOutputArgs, opts?: InvokeOptions): Output<GetConfiguredTableResult>def get_configured_table(configured_table_identifier: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetConfiguredTableResult
def get_configured_table_output(configured_table_identifier: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetConfiguredTableResult]func LookupConfiguredTable(ctx *Context, args *LookupConfiguredTableArgs, opts ...InvokeOption) (*LookupConfiguredTableResult, error)
func LookupConfiguredTableOutput(ctx *Context, args *LookupConfiguredTableOutputArgs, opts ...InvokeOption) LookupConfiguredTableResultOutput> Note: This function is named LookupConfiguredTable in the Go SDK.
public static class GetConfiguredTable
{
public static Task<GetConfiguredTableResult> InvokeAsync(GetConfiguredTableArgs args, InvokeOptions? opts = null)
public static Output<GetConfiguredTableResult> Invoke(GetConfiguredTableInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetConfiguredTableResult> getConfiguredTable(GetConfiguredTableArgs args, InvokeOptions options)
public static Output<GetConfiguredTableResult> getConfiguredTable(GetConfiguredTableArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:cleanrooms:getConfiguredTable
arguments:
# arguments dictionaryThe following arguments are supported:
- Configured
Table stringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
- Configured
Table stringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
- configured
Table StringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
- configured
Table stringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
- configured_
table_ stridentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
- configured
Table StringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
getConfiguredTable Result
The following output properties are available:
- Allowed
Columns List<string> - The columns within the underlying AWS Glue table that can be utilized within collaborations.
- Analysis
Method Pulumi.Aws Native. Clean Rooms. Configured Table Analysis Method The analysis method for the configured table.
DIRECT_QUERYallows SQL queries to be run directly on this table.DIRECT_JOBallows PySpark jobs to be run directly on this table.MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.- Analysis
Rules List<Pulumi.Aws Native. Clean Rooms. Outputs. Configured Table Analysis Rule> - The analysis rule that was created for the configured table.
- Arn string
Returns the Amazon Resource Name (ARN) of the specified configured table.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111- Configured
Table stringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333- Description string
- A description for the configured table.
- Name string
- A name for the configured table.
- Selected
Analysis List<Pulumi.Methods Aws Native. Clean Rooms. Configured Table Selected Analysis Method> - The selected analysis methods for the configured table.
- Table
Reference Pulumi.Aws | Pulumi.Native. Clean Rooms. Outputs. Configured Table Table Reference0Properties Aws | Pulumi.Native. Clean Rooms. Outputs. Configured Table Table Reference1Properties Aws Native. Clean Rooms. Outputs. Configured Table Table Reference2Properties - The table that this configured table represents.
-
List<Pulumi.
Aws Native. Outputs. Tag> - An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- Allowed
Columns []string - The columns within the underlying AWS Glue table that can be utilized within collaborations.
- Analysis
Method ConfiguredTable Analysis Method The analysis method for the configured table.
DIRECT_QUERYallows SQL queries to be run directly on this table.DIRECT_JOBallows PySpark jobs to be run directly on this table.MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.- Analysis
Rules []ConfiguredTable Analysis Rule - The analysis rule that was created for the configured table.
- Arn string
Returns the Amazon Resource Name (ARN) of the specified configured table.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111- Configured
Table stringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333- Description string
- A description for the configured table.
- Name string
- A name for the configured table.
- Selected
Analysis []ConfiguredMethods Table Selected Analysis Method - The selected analysis methods for the configured table.
- Table
Reference ConfiguredTable | ConfiguredTable Reference0Properties Table | ConfiguredTable Reference1Properties Table Table Reference2Properties - The table that this configured table represents.
- Tag
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- allowed
Columns List<String> - The columns within the underlying AWS Glue table that can be utilized within collaborations.
- analysis
Method ConfiguredTable Analysis Method The analysis method for the configured table.
DIRECT_QUERYallows SQL queries to be run directly on this table.DIRECT_JOBallows PySpark jobs to be run directly on this table.MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.- analysis
Rules List<ConfiguredTable Analysis Rule> - The analysis rule that was created for the configured table.
- arn String
Returns the Amazon Resource Name (ARN) of the specified configured table.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111- configured
Table StringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333- description String
- A description for the configured table.
- name String
- A name for the configured table.
- selected
Analysis List<ConfiguredMethods Table Selected Analysis Method> - The selected analysis methods for the configured table.
- table
Reference ConfiguredTable | ConfiguredTable Reference0Properties Table | ConfiguredTable Reference1Properties Table Table Reference2Properties - The table that this configured table represents.
- List<Tag>
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- allowed
Columns string[] - The columns within the underlying AWS Glue table that can be utilized within collaborations.
- analysis
Method ConfiguredTable Analysis Method The analysis method for the configured table.
DIRECT_QUERYallows SQL queries to be run directly on this table.DIRECT_JOBallows PySpark jobs to be run directly on this table.MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.- analysis
Rules ConfiguredTable Analysis Rule[] - The analysis rule that was created for the configured table.
- arn string
Returns the Amazon Resource Name (ARN) of the specified configured table.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111- configured
Table stringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333- description string
- A description for the configured table.
- name string
- A name for the configured table.
- selected
Analysis ConfiguredMethods Table Selected Analysis Method[] - The selected analysis methods for the configured table.
- table
Reference ConfiguredTable | ConfiguredTable Reference0Properties Table | ConfiguredTable Reference1Properties Table Table Reference2Properties - The table that this configured table represents.
- Tag[]
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- allowed_
columns Sequence[str] - The columns within the underlying AWS Glue table that can be utilized within collaborations.
- analysis_
method ConfiguredTable Analysis Method The analysis method for the configured table.
DIRECT_QUERYallows SQL queries to be run directly on this table.DIRECT_JOBallows PySpark jobs to be run directly on this table.MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.- analysis_
rules Sequence[ConfiguredTable Analysis Rule] - The analysis rule that was created for the configured table.
- arn str
Returns the Amazon Resource Name (ARN) of the specified configured table.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111- configured_
table_ stridentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333- description str
- A description for the configured table.
- name str
- A name for the configured table.
- selected_
analysis_ Sequence[Configuredmethods Table Selected Analysis Method] - The selected analysis methods for the configured table.
- table_
reference ConfiguredTable | ConfiguredTable Reference0Properties Table | ConfiguredTable Reference1Properties Table Table Reference2Properties - The table that this configured table represents.
- Sequence[root_Tag]
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- allowed
Columns List<String> - The columns within the underlying AWS Glue table that can be utilized within collaborations.
- analysis
Method "DIRECT_QUERY" | "DIRECT_JOB" | "MULTIPLE" The analysis method for the configured table.
DIRECT_QUERYallows SQL queries to be run directly on this table.DIRECT_JOBallows PySpark jobs to be run directly on this table.MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.- analysis
Rules List<Property Map> - The analysis rule that was created for the configured table.
- arn String
Returns the Amazon Resource Name (ARN) of the specified configured table.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111- configured
Table StringIdentifier Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333- description String
- A description for the configured table.
- name String
- A name for the configured table.
- selected
Analysis List<"DIRECT_QUERY" | "DIRECT_JOB">Methods - The selected analysis methods for the configured table.
- table
Reference Property Map | Property Map | Property Map - The table that this configured table represents.
- List<Property Map>
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
Supporting Types
ConfiguredTableAdditionalAnalyses
ConfiguredTableAggregateColumn
- column
Names List<String> - function
Configured
Table Aggregate Function Name
- column_
names Sequence[str] - function
Configured
Table Aggregate Function Name
ConfiguredTableAggregateFunctionName
ConfiguredTableAggregationConstraint
- Column
Name string - Minimum float64
- Type
Configured
Table Aggregation Type
- column
Name String - minimum Double
- type
Configured
Table Aggregation Type
- column
Name string - minimum number
- type
Configured
Table Aggregation Type
- column
Name String - minimum Number
- type "COUNT_DISTINCT"
ConfiguredTableAggregationType
ConfiguredTableAnalysisMethod
ConfiguredTableAnalysisRule
- Policy
Pulumi.
Aws Native. Clean Rooms. Inputs. Configured Table Analysis Rule Policy - A policy that describes the associated data usage limitations.
- Type
Pulumi.
Aws Native. Clean Rooms. Configured Table Analysis Rule Type - The type of analysis rule.
- Policy
Configured
Table Analysis Rule Policy - A policy that describes the associated data usage limitations.
- Type
Configured
Table Analysis Rule Type - The type of analysis rule.
- policy
Configured
Table Analysis Rule Policy - A policy that describes the associated data usage limitations.
- type
Configured
Table Analysis Rule Type - The type of analysis rule.
- policy
Configured
Table Analysis Rule Policy - A policy that describes the associated data usage limitations.
- type
Configured
Table Analysis Rule Type - The type of analysis rule.
- policy
Configured
Table Analysis Rule Policy - A policy that describes the associated data usage limitations.
- type
Configured
Table Analysis Rule Type - The type of analysis rule.
- policy Property Map
- A policy that describes the associated data usage limitations.
- type "AGGREGATION" | "LIST" | "CUSTOM"
- The type of analysis rule.
ConfiguredTableAnalysisRuleAggregation
- Aggregate
Columns List<Pulumi.Aws Native. Clean Rooms. Inputs. Configured Table Aggregate Column> - Dimension
Columns List<string> - Join
Columns List<string> - Output
Constraints List<Pulumi.Aws Native. Clean Rooms. Inputs. Configured Table Aggregation Constraint> - Scalar
Functions List<Pulumi.Aws Native. Clean Rooms. Configured Table Scalar Functions> - Additional
Analyses Pulumi.Aws Native. Clean Rooms. Configured Table Additional Analyses - Allowed
Join List<Pulumi.Operators Aws Native. Clean Rooms. Configured Table Join Operator> - Join
Required Pulumi.Aws Native. Clean Rooms. Configured Table Join Required Option
- Aggregate
Columns []ConfiguredTable Aggregate Column - Dimension
Columns []string - Join
Columns []string - Output
Constraints []ConfiguredTable Aggregation Constraint - Scalar
Functions []ConfiguredTable Scalar Functions - Additional
Analyses ConfiguredTable Additional Analyses - Allowed
Join []ConfiguredOperators Table Join Operator - Join
Required ConfiguredTable Join Required Option
- aggregate
Columns List<ConfiguredTable Aggregate Column> - dimension
Columns List<String> - join
Columns List<String> - output
Constraints List<ConfiguredTable Aggregation Constraint> - scalar
Functions List<ConfiguredTable Scalar Functions> - additional
Analyses ConfiguredTable Additional Analyses - allowed
Join List<ConfiguredOperators Table Join Operator> - join
Required ConfiguredTable Join Required Option
- aggregate
Columns ConfiguredTable Aggregate Column[] - dimension
Columns string[] - join
Columns string[] - output
Constraints ConfiguredTable Aggregation Constraint[] - scalar
Functions ConfiguredTable Scalar Functions[] - additional
Analyses ConfiguredTable Additional Analyses - allowed
Join ConfiguredOperators Table Join Operator[] - join
Required ConfiguredTable Join Required Option
- aggregate_
columns Sequence[ConfiguredTable Aggregate Column] - dimension_
columns Sequence[str] - join_
columns Sequence[str] - output_
constraints Sequence[ConfiguredTable Aggregation Constraint] - scalar_
functions Sequence[ConfiguredTable Scalar Functions] - additional_
analyses ConfiguredTable Additional Analyses - allowed_
join_ Sequence[Configuredoperators Table Join Operator] - join_
required ConfiguredTable Join Required Option
- aggregate
Columns List<Property Map> - dimension
Columns List<String> - join
Columns List<String> - output
Constraints List<Property Map> - scalar
Functions List<"TRUNC" | "ABS" | "CEILING" | "FLOOR" | "LN" | "LOG" | "ROUND" | "SQRT" | "CAST" | "LOWER" | "RTRIM" | "UPPER" | "COALESCE" | "CONVERT" | "CURRENT_DATE" | "DATEADD" | "EXTRACT" | "GETDATE" | "SUBSTRING" | "TO_CHAR" | "TO_DATE" | "TO_NUMBER" | "TO_TIMESTAMP" | "TRIM"> - additional
Analyses "ALLOWED" | "REQUIRED" | "NOT_ALLOWED" - allowed
Join List<"OR" | "AND">Operators - join
Required "QUERY_RUNNER"
ConfiguredTableAnalysisRuleCustom
- allowed_
analyses Sequence[str] - additional_
analyses ConfiguredTable Additional Analyses - allowed_
analysis_ Sequence[str]providers - differential_
privacy ConfiguredTable Differential Privacy - disallowed_
output_ Sequence[str]columns
- allowed
Analyses List<String> - additional
Analyses "ALLOWED" | "REQUIRED" | "NOT_ALLOWED" - allowed
Analysis List<String>Providers - differential
Privacy Property Map - disallowed
Output List<String>Columns
ConfiguredTableAnalysisRuleList
ConfiguredTableAnalysisRulePolicy
- V1
Pulumi.
Aws | Pulumi.Native. Clean Rooms. Inputs. Configured Table Analysis Rule Policy V10Properties Aws | Pulumi.Native. Clean Rooms. Inputs. Configured Table Analysis Rule Policy V11Properties Aws Native. Clean Rooms. Inputs. Configured Table Analysis Rule Policy V12Properties - Controls on the query specifications that can be run on a configured table.
- V1
Configured
Table | ConfiguredAnalysis Rule Policy V10Properties Table | ConfiguredAnalysis Rule Policy V11Properties Table Analysis Rule Policy V12Properties - Controls on the query specifications that can be run on a configured table.
- v1
Configured
Table | ConfiguredAnalysis Rule Policy V10Properties Table | ConfiguredAnalysis Rule Policy V11Properties Table Analysis Rule Policy V12Properties - Controls on the query specifications that can be run on a configured table.
- v1
Configured
Table | ConfiguredAnalysis Rule Policy V10Properties Table | ConfiguredAnalysis Rule Policy V11Properties Table Analysis Rule Policy V12Properties - Controls on the query specifications that can be run on a configured table.
- v1
Configured
Table | ConfiguredAnalysis Rule Policy V10Properties Table | ConfiguredAnalysis Rule Policy V11Properties Table Analysis Rule Policy V12Properties - Controls on the query specifications that can be run on a configured table.
- v1 Property Map | Property Map | Property Map
- Controls on the query specifications that can be run on a configured table.
ConfiguredTableAnalysisRulePolicyV10Properties
ConfiguredTableAnalysisRulePolicyV11Properties
ConfiguredTableAnalysisRulePolicyV12Properties
ConfiguredTableAnalysisRuleType
ConfiguredTableAthenaTableReference
- Database
Name string - Table
Name string - Work
Group string - Output
Location string
- Database
Name string - Table
Name string - Work
Group string - Output
Location string
- database
Name String - table
Name String - work
Group String - output
Location String
- database
Name string - table
Name string - work
Group string - output
Location string
- database_
name str - table_
name str - work_
group str - output_
location str
- database
Name String - table
Name String - work
Group String - output
Location String
ConfiguredTableDifferentialPrivacy
ConfiguredTableDifferentialPrivacyColumn
- Name string
- Name string
- name String
- name string
- name str
- name String
ConfiguredTableGlueTableReference
- Database
Name string - Table
Name string
- Database
Name string - Table
Name string
- database
Name String - table
Name String
- database
Name string - table
Name string
- database_
name str - table_
name str
- database
Name String - table
Name String
ConfiguredTableJoinOperator
ConfiguredTableJoinRequiredOption
ConfiguredTableScalarFunctions
ConfiguredTableSelectedAnalysisMethod
ConfiguredTableSnowflakeTableReference
- Account
Identifier string - Database
Name string - Schema
Name string - Secret
Arn string - Table
Name string - Table
Schema ConfiguredTable Snowflake Table Schema Properties
- account
Identifier String - database
Name String - schema
Name String - secret
Arn String - table
Name String - table
Schema ConfiguredTable Snowflake Table Schema Properties
- account
Identifier string - database
Name string - schema
Name string - secret
Arn string - table
Name string - table
Schema ConfiguredTable Snowflake Table Schema Properties
- account
Identifier String - database
Name String - schema
Name String - secret
Arn String - table
Name String - table
Schema Property Map
ConfiguredTableSnowflakeTableSchemaProperties
ConfiguredTableSnowflakeTableSchemaV1
- Column
Name string - Column
Type string
- Column
Name string - Column
Type string
- column
Name String - column
Type String
- column
Name string - column
Type string
- column_
name str - column_
type str
- column
Name String - column
Type String
ConfiguredTableTableReference0Properties
ConfiguredTableTableReference1Properties
ConfiguredTableTableReference2Properties
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.