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	awscc.cleanrooms.configured_tables

Fields

get (all properties)

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
selected_analysis_methods	array
configured_table_identifier	string
description	string
name	string
▶analysis_rules	array
table_reference	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
configured_table_identifier	string
region	string	AWS region.

For more information, see AWS::CleanRooms::ConfiguredTable.

Methods

Name	Resource	Accessible by	Required Params
create_resource	configured_tables	INSERT	AllowedColumns, AnalysisMethod, Name, TableReference, region
delete_resource	configured_tables	DELETE	Identifier, region
update_resource	configured_tables	UPDATE	Identifier, PatchDocument, region
list_resources	configured_tables_list_only	SELECT	region
get_resource	configured_tables	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual configured_table.

SELECT
  region,
  arn,
  tags,
  allowed_columns,
  analysis_method,
  selected_analysis_methods,
  configured_table_identifier,
  description,
  name,
  analysis_rules,
  table_reference
FROM awscc.cleanrooms.configured_tables
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ configured_table_identifier }}';

list (identifiers only)

Lists all configured_tables in a region.

SELECT
  region,
  configured_table_identifier
FROM awscc.cleanrooms.configured_tables_list_only
WHERE
  region = 'us-east-1';

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 awscc.cleanrooms.configured_tables (
  AllowedColumns,
  AnalysisMethod,
  Name,
  TableReference,
  region
)
SELECT
  '{{ allowed_columns }}',
  '{{ analysis_method }}',
  '{{ name }}',
  '{{ table_reference }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cleanrooms.configured_tables (
  Tags,
  AllowedColumns,
  AnalysisMethod,
  SelectedAnalysisMethods,
  Description,
  Name,
  AnalysisRules,
  TableReference,
  region
)
SELECT
  '{{ tags }}',
  '{{ allowed_columns }}',
  '{{ analysis_method }}',
  '{{ selected_analysis_methods }}',
  '{{ description }}',
  '{{ name }}',
  '{{ analysis_rules }}',
  '{{ table_reference }}',
  '{{ 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: allowed_columns
        value:
          - '{{ allowed_columns[0] }}'
      - name: analysis_method
        value: '{{ analysis_method }}'
      - name: selected_analysis_methods
        value:
          - '{{ selected_analysis_methods[0] }}'
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: analysis_rules
        value:
          - type: '{{ type }}'
            policy:
              v1: null
      - name: table_reference
        value: null

UPDATE example

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

/*+ update */
UPDATE awscc.cleanrooms.configured_tables
SET PatchDocument = string('{{ {
    "Tags": tags,
    "AllowedColumns": allowed_columns,
    "AnalysisMethod": analysis_method,
    "SelectedAnalysisMethods": selected_analysis_methods,
    "Description": description,
    "Name": name,
    "AnalysisRules": analysis_rules,
    "TableReference": table_reference
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ configured_table_identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cleanrooms.configured_tables
WHERE
  Identifier = '{{ configured_table_identifier }}' 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,
athena:GetTableMetadata

Read

cleanrooms:GetConfiguredTable,
cleanrooms:GetConfiguredTableAnalysisRule,
cleanrooms:ListTagsForResource

Update

cleanrooms:UpdateConfiguredTable,
cleanrooms:UpdateConfiguredTableReference,
cleanrooms:UpdateConfiguredTableAllowedColumns,
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