collaborations

Creates, updates, deletes or gets a collaboration resource or lists collaborations in a region

Overview

Name	collaborations
Type	Resource
Description	Represents a collaboration between AWS accounts that allows for secure data collaboration
Id	aws.cleanrooms.collaborations

Fields

Name	Datatype	Description
arn	string
tags	array	An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
collaboration_identifier	string
creator_display_name	string
creator_member_abilities	array
data_encryption_metadata	object
description	string
members	array
name	string
query_log_status	string
creator_payment_configuration	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	CreatorDisplayName, CreatorMemberAbilities, Members, Name, Description, QueryLogStatus, 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 collaborations in a region.

SELECT
region,
arn,
tags,
collaboration_identifier,
creator_display_name,
creator_member_abilities,
data_encryption_metadata,
description,
members,
name,
query_log_status,
creator_payment_configuration
FROM aws.cleanrooms.collaborations
WHERE region = 'us-east-1';

Gets all properties from an individual collaboration.

SELECT
region,
arn,
tags,
collaboration_identifier,
creator_display_name,
creator_member_abilities,
data_encryption_metadata,
description,
members,
name,
query_log_status,
creator_payment_configuration
FROM aws.cleanrooms.collaborations
WHERE region = 'us-east-1' AND data__Identifier = '<CollaborationIdentifier>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cleanrooms.collaborations (
 CreatorDisplayName,
 CreatorMemberAbilities,
 Description,
 Members,
 Name,
 QueryLogStatus,
 region
)
SELECT 
'{{ CreatorDisplayName }}',
 '{{ CreatorMemberAbilities }}',
 '{{ Description }}',
 '{{ Members }}',
 '{{ Name }}',
 '{{ QueryLogStatus }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cleanrooms.collaborations (
 Tags,
 CreatorDisplayName,
 CreatorMemberAbilities,
 DataEncryptionMetadata,
 Description,
 Members,
 Name,
 QueryLogStatus,
 CreatorPaymentConfiguration,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ CreatorDisplayName }}',
 '{{ CreatorMemberAbilities }}',
 '{{ DataEncryptionMetadata }}',
 '{{ Description }}',
 '{{ Members }}',
 '{{ Name }}',
 '{{ QueryLogStatus }}',
 '{{ CreatorPaymentConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: collaboration
    props:
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: CreatorDisplayName
        value: '{{ CreatorDisplayName }}'
      - name: CreatorMemberAbilities
        value:
          - '{{ CreatorMemberAbilities[0] }}'
      - name: DataEncryptionMetadata
        value:
          AllowCleartext: '{{ AllowCleartext }}'
          AllowDuplicates: '{{ AllowDuplicates }}'
          AllowJoinsOnColumnsWithDifferentNames: '{{ AllowJoinsOnColumnsWithDifferentNames }}'
          PreserveNulls: '{{ PreserveNulls }}'
      - name: Description
        value: '{{ Description }}'
      - name: Members
        value:
          - AccountId: '{{ AccountId }}'
            MemberAbilities: null
            DisplayName: null
            PaymentConfiguration:
              QueryCompute:
                IsResponsible: '{{ IsResponsible }}'
      - name: Name
        value: '{{ Name }}'
      - name: QueryLogStatus
        value: '{{ QueryLogStatus }}'
      - name: CreatorPaymentConfiguration
        value: null

DELETE example

/*+ delete */
DELETE FROM aws.cleanrooms.collaborations
WHERE data__Identifier = '<CollaborationIdentifier>'
AND region = 'us-east-1';

Permissions

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

Create

cleanrooms:CreateCollaboration,
cleanrooms:GetCollaboration,
cleanrooms:ListMembers,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:GetCollaboration,
cleanrooms:ListCollaborations

Read

cleanrooms:GetCollaboration,
cleanrooms:ListMembers,
cleanrooms:ListTagsForResource

Update

cleanrooms:UpdateCollaboration,
cleanrooms:GetCollaboration,
cleanrooms:ListMembers,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource

Delete

cleanrooms:DeleteCollaboration,
cleanrooms:GetCollaboration,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource,
cleanrooms:ListMembers,
cleanrooms:ListCollaborations

List

cleanrooms:ListCollaborations