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

Fields

get (all properties)

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
▶configured_table_association_analysis_rules	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
configured_table_association_identifier	string
membership_identifier	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	configured_table_associations	INSERT	ConfiguredTableIdentifier, Name, RoleArn, MembershipIdentifier, region
delete_resource	configured_table_associations	DELETE	Identifier, region
update_resource	configured_table_associations	UPDATE	Identifier, PatchDocument, region
list_resources	configured_table_associations_list_only	SELECT	region
get_resource	configured_table_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  configured_table_association_analysis_rules
FROM awscc.cleanrooms.configured_table_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ configured_table_association_identifier }}|{{ membership_identifier }}';

list (identifiers only)

Lists all configured_table_associations in a region.

SELECT
  region,
  configured_table_association_identifier,
  membership_identifier
FROM awscc.cleanrooms.configured_table_associations_list_only
WHERE
  region = '{{ region }}';

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 awscc.cleanrooms.configured_table_associations (
  ConfiguredTableIdentifier,
  MembershipIdentifier,
  Name,
  RoleArn,
  region
)
SELECT
  '{{ configured_table_identifier }}',
  '{{ membership_identifier }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cleanrooms.configured_table_associations (
  Tags,
  ConfiguredTableIdentifier,
  Description,
  MembershipIdentifier,
  Name,
  RoleArn,
  ConfiguredTableAssociationAnalysisRules,
  region
)
SELECT
  '{{ tags }}',
  '{{ configured_table_identifier }}',
  '{{ description }}',
  '{{ membership_identifier }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ configured_table_association_analysis_rules }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: configured_table_identifier
      value: '{{ configured_table_identifier }}'
    - name: description
      value: '{{ description }}'
    - name: membership_identifier
      value: '{{ membership_identifier }}'
    - name: name
      value: '{{ name }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: configured_table_association_analysis_rules
      value:
        - type: '{{ type }}'
          policy:
            v1: null

UPDATE example

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

/*+ update */
UPDATE awscc.cleanrooms.configured_table_associations
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Description": description,
    "RoleArn": role_arn,
    "ConfiguredTableAssociationAnalysisRules": configured_table_association_analysis_rules
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ configured_table_association_identifier }}|{{ membership_identifier }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cleanrooms.configured_table_associations
WHERE
  Identifier = '{{ configured_table_association_identifier }}|{{ membership_identifier }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
cleanrooms:DeleteConfiguredTableAssociation,
cleanrooms:DeleteConfiguredTableAssociationAnalysisRule,
cleanrooms:CreateConfiguredTableAssociationAnalysisRule,
cleanrooms:GetConfiguredTableAssociationAnalysisRule

Read

cleanrooms:GetConfiguredTableAssociation,
cleanrooms:ListTagsForResource,
cleanrooms:GetConfiguredTableAssociationAnalysisRule

Update

cleanrooms:UpdateConfiguredTableAssociation,
cleanrooms:GetConfiguredTableAssociation,
iam:PassRole,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource,
cleanrooms:DeleteConfiguredTableAssociationAnalysisRule,
cleanrooms:CreateConfiguredTableAssociationAnalysisRule,
cleanrooms:GetConfiguredTableAssociationAnalysisRule,
cleanrooms:UpdateConfiguredTableAssociationAnalysisRule

Delete

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

List

cleanrooms:ListConfiguredTableAssociations