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	aws.cleanrooms.id_mapping_tables

Fields

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

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

Methods

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

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 aws.cleanrooms.id_mapping_tables
WHERE region = 'us-east-1';

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 aws.cleanrooms.id_mapping_tables
WHERE region = 'us-east-1' AND data__Identifier = '<IdMappingTableIdentifier>|<MembershipIdentifier>';

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 aws.cleanrooms.id_mapping_tables (
 InputReferenceConfig,
 MembershipIdentifier,
 Name,
 region
)
SELECT 
'{{ InputReferenceConfig }}',
 '{{ MembershipIdentifier }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cleanrooms.id_mapping_tables (
 InputReferenceConfig,
 MembershipIdentifier,
 Description,
 Name,
 KmsKeyArn,
 Tags,
 region
)
SELECT 
 '{{ InputReferenceConfig }}',
 '{{ MembershipIdentifier }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ KmsKeyArn }}',
 '{{ 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: InputReferenceConfig
        value:
          InputReferenceArn: '{{ InputReferenceArn }}'
          ManageResourcePolicies: '{{ ManageResourcePolicies }}'
      - name: MembershipIdentifier
        value: '{{ MembershipIdentifier }}'
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: KmsKeyArn
        value: '{{ KmsKeyArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.cleanrooms.id_mapping_tables
WHERE data__Identifier = '<IdMappingTableIdentifier|MembershipIdentifier>'
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