AWS::CleanRooms::ConfiguredTable
Creates a new configured table resource.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::CleanRooms::ConfiguredTable", "Properties" : { "AllowedColumns" :
[ String, ... ]
, "AnalysisMethod" :String
, "AnalysisRules" :[ AnalysisRule, ... ]
, "Description" :String
, "Name" :String
, "TableReference" :TableReference
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::CleanRooms::ConfiguredTable Properties: AllowedColumns:
- String
AnalysisMethod:String
AnalysisRules:- AnalysisRule
Description:String
Name:String
TableReference:TableReference
Tags:- Tag
Properties
AllowedColumns
-
The columns within the underlying AWS Glue table that can be utilized within collaborations.
Required: Yes
Type: Array of String
Minimum:
1
Maximum:
128 | 100
Update requires: Replacement
AnalysisMethod
-
The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.
Required: Yes
Type: String
Allowed values:
DIRECT_QUERY
Update requires: Replacement
AnalysisRules
-
The analysis rule that was created for the configured table.
Required: No
Type: Array of AnalysisRule
Minimum:
1
Maximum:
1
Update requires: No interruption
Description
-
A description for the configured table.
Required: No
Type: String
Pattern:
^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$
Maximum:
255
Update requires: No interruption
Name
-
A name for the configured table.
Required: Yes
Type: String
Pattern:
^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$
Minimum:
1
Maximum:
100
Update requires: No interruption
TableReference
-
The table that this configured table represents.
Required: Yes
Type: TableReference
Update requires: Replacement
-
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Required: No
Type: Array of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource name. For example:
{"Ref": "MyConfiguredTable"}
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
Arn
-
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
ConfiguredTableIdentifier
-
Returns the unique identifier of the specified configured table.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
Examples
A configured table using a list analysis rule
The following is an example of a configured table with a list analysis rule applied.
JSON
"ListConfiguredTable": { { "Type" : "AWS::CleanRooms::ConfiguredTable", "Properties" : { "Name" : "List Table", "Description" : "Example configured table with list AR", "AllowedColumns" : ["column1", "column2", "column4"], "AnalysisMethod" : "DIRECT_QUERY", "AnalysisRules" : [ "Type": "LIST", "Policy": { "V1": { "List": { "JoinColumns": [ "column1" ], "ListColumns": [ "column2" ] } } } ], "TableReference" : { "Glue": { "DatabaseName": "ExampleDB", "TableName": "ExampleTable" } } } } }
YAML
ListConfiguredTable: Type: AWS::CleanRooms::ConfiguredTable Properties: Name: List Table Description: Example configured table with list AR AllowedColumns: - column1 - column2 - column4 AnalysisMethod: DIRECT_QUERY AnalysisRules: - Type: LIST Policy: V1: List: JoinColumns: - column1 ListColumns: - column2 TableReference: Glue: DatabaseName: ExampleDB TableName: ExampleTable