memberships
Creates, updates, deletes or gets a membership
resource or lists memberships
in a region
Overview
Name | memberships |
Type | Resource |
Description | Represents an AWS account that is a part of a collaboration |
Id | aws.cleanrooms.memberships |
Fields
Name | Datatype | Description |
---|---|---|
arn | string | |
tags | array | An arbitrary set of tags (key-value pairs) for this cleanrooms membership. |
collaboration_arn | string | |
collaboration_creator_account_id | string | |
collaboration_identifier | string | |
membership_identifier | string | |
query_log_status | string | |
default_result_configuration | object | |
payment_configuration | object | |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
create_resource | INSERT | CollaborationIdentifier, 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 memberships
in a region.
SELECT
region,
arn,
tags,
collaboration_arn,
collaboration_creator_account_id,
collaboration_identifier,
membership_identifier,
query_log_status,
default_result_configuration,
payment_configuration
FROM aws.cleanrooms.memberships
WHERE region = 'us-east-1';
Gets all properties from an individual membership
.
SELECT
region,
arn,
tags,
collaboration_arn,
collaboration_creator_account_id,
collaboration_identifier,
membership_identifier,
query_log_status,
default_result_configuration,
payment_configuration
FROM aws.cleanrooms.memberships
WHERE region = 'us-east-1' AND data__Identifier = '<MembershipIdentifier>';
INSERT
example
Use the following StackQL query and manifest file to create a new membership
resource, using stack-deploy
.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO aws.cleanrooms.memberships (
CollaborationIdentifier,
QueryLogStatus,
region
)
SELECT
'{{ CollaborationIdentifier }}',
'{{ QueryLogStatus }}',
'{{ region }}';
/*+ create */
INSERT INTO aws.cleanrooms.memberships (
Tags,
CollaborationIdentifier,
QueryLogStatus,
DefaultResultConfiguration,
PaymentConfiguration,
region
)
SELECT
'{{ Tags }}',
'{{ CollaborationIdentifier }}',
'{{ QueryLogStatus }}',
'{{ DefaultResultConfiguration }}',
'{{ PaymentConfiguration }}',
'{{ region }}';
version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
value: '{{ vars.AWS_REGION }}'
resources:
- name: membership
props:
- name: Tags
value:
- Key: '{{ Key }}'
Value: '{{ Value }}'
- name: CollaborationIdentifier
value: '{{ CollaborationIdentifier }}'
- name: QueryLogStatus
value: '{{ QueryLogStatus }}'
- name: DefaultResultConfiguration
value:
OutputConfiguration:
S3:
ResultFormat: '{{ ResultFormat }}'
Bucket: '{{ Bucket }}'
KeyPrefix: '{{ KeyPrefix }}'
RoleArn: '{{ RoleArn }}'
- name: PaymentConfiguration
value:
QueryCompute:
IsResponsible: '{{ IsResponsible }}'
DELETE
example
/*+ delete */
DELETE FROM aws.cleanrooms.memberships
WHERE data__Identifier = '<MembershipIdentifier>'
AND region = 'us-east-1';
Permissions
To operate on the memberships
resource, the following permissions are required:
Create
cleanrooms:CreateMembership,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:PutResourcePolicy,
logs:CreateLogGroup,
cleanrooms:GetMembership,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:ListMemberships,
iam:PassRole
Read
cleanrooms:GetMembership,
cleanrooms:ListTagsForResource,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:GetLogDelivery
Update
cleanrooms:UpdateMembership,
cleanrooms:GetMembership,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:PutResourcePolicy,
logs:CreateLogGroup,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource,
iam:PassRole
Delete
cleanrooms:DeleteMembership,
cleanrooms:GetMembership,
cleanrooms:ListMemberships,
cleanrooms:ListTagsForResource,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:GetLogDelivery
List
cleanrooms:ListMemberships