id_namespace_associations

Creates, updates, deletes or gets an id_namespace_association resource or lists id_namespace_associations in a region

Overview

Name	id_namespace_associations
Type	Resource
Description	Represents an association between an ID namespace and a collaboration
Id	awscc.cleanrooms.id_namespace_associations

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
id_namespace_association_identifier	string
name	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual id_namespace_association.

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

list (identifiers only)

Lists all id_namespace_associations in a region.

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

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

UPDATE example

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

/*+ update */
UPDATE awscc.cleanrooms.id_namespace_associations
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Name": name,
    "Description": description,
    "IdMappingConfig": id_mapping_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id_namespace_association_identifier }}|{{ membership_identifier }}';

DELETE example

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

Permissions

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

Create

cleanrooms:CreateIdNamespaceAssociation,
cleanrooms:GetIdNamespaceAssociation,
cleanrooms:ListIdNamespaceAssociations,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration,
entityresolution:GetIdNamespace,
entityresolution:AddPolicyStatement

Read

cleanrooms:GetIdNamespaceAssociation,
cleanrooms:ListTagsForResource,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration,
entityresolution:GetIdNamespace

Update

cleanrooms:UpdateIdNamespaceAssociation,
cleanrooms:GetIdNamespaceAssociation,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource,
entityresolution:GetIdNamespace,
entityresolution:AddPolicyStatement

Delete

cleanrooms:DeleteIdNamespaceAssociation,
cleanrooms:GetIdNamespaceAssociation,
cleanrooms:ListIdNamespaceAssociations,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource,
entityresolution:GetIdNamespace,
entityresolution:DeletePolicyStatement

List

cleanrooms:ListIdNamespaceAssociations,
cleanrooms:GetMembership,
cleanrooms:GetCollaboration