configured_table_associations

Creates, updates, deletes or gets a configured_table_association resource or lists configured_table_associations in a region

Overview

Name	configured_table_associations
Type	Resource
Description	Represents a table that can be queried within a collaboration
Id	aws.cleanrooms.configured_table_associations

Fields

Name	Datatype	Description
arn	string
tags	array	An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
configured_table_association_identifier	string
configured_table_identifier	string
description	string
membership_identifier	string
name	string
role_arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ConfiguredTableIdentifier, Name, RoleArn, MembershipIdentifier, 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_table_associations in a region.

SELECT
region,
arn,
tags,
configured_table_association_identifier,
configured_table_identifier,
description,
membership_identifier,
name,
role_arn
FROM aws.cleanrooms.configured_table_associations
WHERE region = 'us-east-1';

Gets all properties from an individual configured_table_association.

SELECT
region,
arn,
tags,
configured_table_association_identifier,
configured_table_identifier,
description,
membership_identifier,
name,
role_arn
FROM aws.cleanrooms.configured_table_associations
WHERE region = 'us-east-1' AND data__Identifier = '<ConfiguredTableAssociationIdentifier>|<MembershipIdentifier>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cleanrooms.configured_table_associations (
 ConfiguredTableIdentifier,
 MembershipIdentifier,
 Name,
 RoleArn,
 region
)
SELECT 
'{{ ConfiguredTableIdentifier }}',
 '{{ MembershipIdentifier }}',
 '{{ Name }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cleanrooms.configured_table_associations (
 Tags,
 ConfiguredTableIdentifier,
 Description,
 MembershipIdentifier,
 Name,
 RoleArn,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ ConfiguredTableIdentifier }}',
 '{{ Description }}',
 '{{ MembershipIdentifier }}',
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configured_table_association
    props:
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: ConfiguredTableIdentifier
        value: '{{ ConfiguredTableIdentifier }}'
      - name: Description
        value: '{{ Description }}'
      - name: MembershipIdentifier
        value: '{{ MembershipIdentifier }}'
      - name: Name
        value: '{{ Name }}'
      - name: RoleArn
        value: '{{ RoleArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.cleanrooms.configured_table_associations
WHERE data__Identifier = '<ConfiguredTableAssociationIdentifier|MembershipIdentifier>'
AND region = 'us-east-1';

Permissions

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

Create

cleanrooms:CreateConfiguredTableAssociation,
iam:PassRole,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:GetConfiguredTableAssociation,
cleanrooms:ListConfiguredTableAssociations

Read

cleanrooms:GetConfiguredTableAssociation,
cleanrooms:ListTagsForResource

Update

cleanrooms:UpdateConfiguredTableAssociation,
cleanrooms:GetConfiguredTableAssociation,
iam:PassRole,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource

Delete

cleanrooms:DeleteConfiguredTableAssociation,
cleanrooms:GetConfiguredTableAssociation,
cleanrooms:ListConfiguredTableAssociations,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource

List

cleanrooms:ListConfiguredTableAssociations