configured_table_associations

Creates, updates, deletes, gets or lists a configured_table_associations resource.

Overview

Name	configured_table_associations
Type	Resource
Id	aws.cleanrooms.configured_table_associations

Fields

The following fields are returned by SELECT queries:

get_configured_table_association

Name	Datatype	Description
id	string	The unique ID for the configured table association. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data. (pattern: <code>[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?</code>)
analysis_rule_types	array	The analysis rule types for the configured table association.
arn	string	The unique ARN for the configured table association. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtableassociation/[\d\w-]+/[\d\w-]+</code>)
child_resources	array	The child resources that depend on this configured table association.
configured_table_arn	string	The unique ARN for the configured table that the association refers to. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtable/[\d\w-]+</code>)
configured_table_id	string	The unique ID for the configured table that the association refers to. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time the configured table association was created.
description	string	A description of the configured table association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
membership_arn	string	The unique ARN for the membership this configured table association belongs to. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The unique ID for the membership this configured table association belongs to. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
role_arn	string	The service will assume this role to access catalog metadata and query the table. (pattern: <code>arn:aws:iam::[\w]+:role/[\w+=./@-]+</code>)
update_time	string (date-time)	The time the configured table association was last updated.

list_configured_table_associations

Name	Datatype	Description
id	string	The unique ID for the configured table association. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data. (pattern: <code>[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?</code>)
analysis_rule_types	array	The analysis rule types that are associated with the configured table associations in this summary.
arn	string	The unique ARN for the configured table association. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtableassociation/[\d\w-]+/[\d\w-]+</code>)
configured_table_id	string	The unique configured table ID that this configured table association refers to. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time the configured table association was created.
membership_arn	string	The unique ARN for the membership that the configured table association belongs to. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The unique ID for the membership that the configured table association belongs to. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_time	string (date-time)	The time the configured table association was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configured_table_association	select	configured_table_association_identifier, membership_identifier, region		Retrieves a configured table association.
list_configured_table_associations	select	membership_identifier, region	nextToken, maxResults	Lists configured table associations for a membership.
create_configured_table_association	insert	membership_identifier, region, name, configuredTableIdentifier, roleArn		Creates a configured table association. A configured table association links a configured table with a collaboration.
update_configured_table_association	update	configured_table_association_identifier, membership_identifier, region		Updates a configured table association.
delete_configured_table_association	delete	configured_table_association_identifier, membership_identifier, region		Deletes a configured table association.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
configured_table_association_identifier	string	The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
membership_identifier	string	A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

get_configured_table_association

Retrieves a configured table association.

SELECT
id,
name,
analysis_rule_types,
arn,
child_resources,
configured_table_arn,
configured_table_id,
create_time,
description,
membership_arn,
membership_id,
role_arn,
update_time
FROM aws.cleanrooms.configured_table_associations
WHERE configured_table_association_identifier = '{{ configured_table_association_identifier }}' -- required
AND membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_configured_table_associations

Lists configured table associations for a membership.

SELECT
id,
name,
analysis_rule_types,
arn,
configured_table_id,
create_time,
membership_arn,
membership_id,
update_time
FROM aws.cleanrooms.configured_table_associations
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_configured_table_association

Creates a configured table association. A configured table association links a configured table with a collaboration.

INSERT INTO aws.cleanrooms.configured_table_associations (
name,
description,
configuredTableIdentifier,
roleArn,
tags,
membership_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ configuredTableIdentifier }}' /* required */,
'{{ roleArn }}' /* required */,
'{{ tags }}',
'{{ membership_identifier }}',
'{{ region }}'
RETURNING
configured_table_association
;

Manifest

# Description fields are for documentation purposes
- name: configured_table_associations
props:
  - name: membership_identifier
    value: "{{ membership_identifier }}"
    description: Required parameter for the configured_table_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configured_table_associations resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: configuredTableIdentifier
    value: "{{ configuredTableIdentifier }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags assigned to a resource

UPDATE examples

update_configured_table_association

Updates a configured table association.

UPDATE aws.cleanrooms.configured_table_associations
SET 
description = '{{ description }}',
roleArn = '{{ roleArn }}'
WHERE 
configured_table_association_identifier = '{{ configured_table_association_identifier }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
configured_table_association;

DELETE examples

delete_configured_table_association

Deletes a configured table association.

DELETE FROM aws.cleanrooms.configured_table_associations
WHERE configured_table_association_identifier = '{{ configured_table_association_identifier }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
;