id_mapping_tables

Creates, updates, deletes or gets an id_mapping_table resource or lists id_mapping_tables in a region

Overview

Name	id_mapping_tables
Type	Resource
Description	Represents an association between an ID mapping workflow and a collaboration
Id	awscc.cleanrooms.id_mapping_tables

Fields

get (all properties)

Name	Datatype	Description
id_mapping_table_identifier	string
arn	string
▶input_reference_config	object
membership_arn	string
collaboration_arn	string
description	string
name	string
▶input_reference_properties	object
kms_key_arn	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id_mapping_table_identifier	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	id_mapping_tables	INSERT	MembershipIdentifier, Name, InputReferenceConfig, region
delete_resource	id_mapping_tables	DELETE	Identifier, region
update_resource	id_mapping_tables	UPDATE	Identifier, PatchDocument, region
list_resources	id_mapping_tables_list_only	SELECT	region
get_resource	id_mapping_tables	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual id_mapping_table.

SELECT
  region,
  id_mapping_table_identifier,
  arn,
  input_reference_config,
  membership_identifier,
  membership_arn,
  collaboration_identifier,
  collaboration_arn,
  description,
  name,
  input_reference_properties,
  kms_key_arn,
  tags
FROM awscc.cleanrooms.id_mapping_tables
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id_mapping_table_identifier }}|{{ membership_identifier }}';

list (identifiers only)

Lists all id_mapping_tables in a region.

SELECT
  region,
  id_mapping_table_identifier,
  membership_identifier
FROM awscc.cleanrooms.id_mapping_tables_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cleanrooms.id_mapping_tables (
  InputReferenceConfig,
  MembershipIdentifier,
  Name,
  region
)
SELECT
  '{{ input_reference_config }}',
  '{{ membership_identifier }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cleanrooms.id_mapping_tables (
  InputReferenceConfig,
  MembershipIdentifier,
  Description,
  Name,
  KmsKeyArn,
  Tags,
  region
)
SELECT
  '{{ input_reference_config }}',
  '{{ membership_identifier }}',
  '{{ description }}',
  '{{ name }}',
  '{{ kms_key_arn }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: id_mapping_table
    props:
      - name: input_reference_config
        value:
          input_reference_arn: '{{ input_reference_arn }}'
          manage_resource_policies: '{{ manage_resource_policies }}'
      - name: membership_identifier
        value: '{{ membership_identifier }}'
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: kms_key_arn
        value: '{{ kms_key_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cleanrooms.id_mapping_tables
SET PatchDocument = string('{{ {
    "Description": description,
    "KmsKeyArn": kms_key_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id_mapping_table_identifier }}|{{ membership_identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cleanrooms.id_mapping_tables
WHERE
  Identifier = '{{ id_mapping_table_identifier }}|{{ membership_identifier }}' AND
  region = 'us-east-1';

Permissions

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

Create

cleanrooms:CreateIdMappingTable,
cleanrooms:GetIdMappingTable,
cleanrooms:ListIdMappingTables,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration,
entityresolution:GetIdMappingWorkflow,
entityresolution:AddPolicyStatement

Read

cleanrooms:GetIdMappingTable,
cleanrooms:ListTagsForResource,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration

Update

cleanrooms:UpdateIdMappingTable,
cleanrooms:GetIdMappingTable,
cleanrooms:GetMembership,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource,
entityresolution:GetIdMappingWorkflow,
entityresolution:AddPolicyStatement

Delete

cleanrooms:DeleteIdMappingTable,
cleanrooms:GetIdMappingTable,
cleanrooms:ListIdMappingTables,
cleanrooms:GetMembership,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource,
entityresolution:GetIdMappingWorkflow,
entityresolution:AddPolicyStatement,
entityresolution:DeletePolicyStatement

List

cleanrooms:ListIdMappingTables,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration