configured_tables

Creates, updates, deletes or gets a configured_table resource or lists configured_tables in a region

Overview

Name	configured_tables
Type	Resource
Description	Represents a table that can be associated with collaborations
Id	aws.cleanrooms.configured_tables

Fields

Name	Datatype	Description
arn	string
tags	array	An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
allowed_columns	array
analysis_method	string
configured_table_identifier	string
description	string
name	string
analysis_rules	array
table_reference	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AllowedColumns, AnalysisMethod, Name, TableReference, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configured_tables in a region.

SELECT
region,
arn,
tags,
allowed_columns,
analysis_method,
configured_table_identifier,
description,
name,
analysis_rules,
table_reference
FROM aws.cleanrooms.configured_tables
WHERE region = 'us-east-1';

Gets all properties from an individual configured_table.

SELECT
region,
arn,
tags,
allowed_columns,
analysis_method,
configured_table_identifier,
description,
name,
analysis_rules,
table_reference
FROM aws.cleanrooms.configured_tables
WHERE region = 'us-east-1' AND data__Identifier = '<ConfiguredTableIdentifier>';

INSERT example

Use the following StackQL query and manifest file to create a new configured_table resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cleanrooms.configured_tables (
 AllowedColumns,
 AnalysisMethod,
 Name,
 TableReference,
 region
)
SELECT 
'{{ AllowedColumns }}',
 '{{ AnalysisMethod }}',
 '{{ Name }}',
 '{{ TableReference }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cleanrooms.configured_tables (
 Tags,
 AllowedColumns,
 AnalysisMethod,
 Description,
 Name,
 AnalysisRules,
 TableReference,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ AllowedColumns }}',
 '{{ AnalysisMethod }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ AnalysisRules }}',
 '{{ TableReference }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configured_table
    props:
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: AllowedColumns
        value:
          - '{{ AllowedColumns[0] }}'
      - name: AnalysisMethod
        value: '{{ AnalysisMethod }}'
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: AnalysisRules
        value:
          - Type: '{{ Type }}'
            Policy:
              V1: null
      - name: TableReference
        value:
          Glue:
            TableName: '{{ TableName }}'
            DatabaseName: '{{ DatabaseName }}'

DELETE example

/*+ delete */
DELETE FROM aws.cleanrooms.configured_tables
WHERE data__Identifier = '<ConfiguredTableIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the configured_tables resource, the following permissions are required:

Create

cleanrooms:CreateConfiguredTable,
cleanrooms:DeleteConfiguredTable,
cleanrooms:DeleteConfiguredTableAnalysisRule,
cleanrooms:CreateConfiguredTableAnalysisRule,
cleanrooms:GetConfiguredTable,
cleanrooms:GetConfiguredTableAnalysisRule,
glue:GetDatabase,
glue:GetDatabases,
glue:GetTable,
glue:GetTables,
glue:GetPartition,
glue:GetPartitions,
glue:BatchGetPartition,
glue:GetSchemaVersion,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:ListConfiguredTables

Read

cleanrooms:GetConfiguredTable,
cleanrooms:GetConfiguredTableAnalysisRule,
cleanrooms:ListTagsForResource

Update

cleanrooms:UpdateConfiguredTable,
cleanrooms:GetConfiguredTable,
cleanrooms:CreateConfiguredTableAnalysisRule,
cleanrooms:UpdateConfiguredTableAnalysisRule,
cleanrooms:GetConfiguredTableAnalysisRule,
cleanrooms:DeleteConfiguredTableAnalysisRule,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource,
glue:GetDatabase,
glue:GetDatabases,
glue:GetTable,
glue:GetTables,
glue:GetPartition,
glue:GetPartitions,
glue:BatchGetPartition,
glue:GetSchemaVersion

Delete

cleanrooms:DeleteConfiguredTable,
cleanrooms:GetConfiguredTable,
cleanrooms:ListConfiguredTables,
cleanrooms:GetConfiguredTableAnalysisRule,
cleanrooms:DeleteConfiguredTableAnalysisRule,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource,
glue:GetDatabase,
glue:GetDatabases,
glue:GetTable,
glue:GetTables,
glue:GetPartition,
glue:GetPartitions,
glue:BatchGetPartition,
glue:GetSchemaVersion

List

cleanrooms:ListConfiguredTables