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	awscc.cleanrooms.memberships

Fields

get (all properties)

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
job_log_status	string
▶default_result_configuration	object
▶default_job_result_configuration	object
▶payment_configuration	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
membership_identifier	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	memberships	INSERT	CollaborationIdentifier, QueryLogStatus, region
delete_resource	memberships	DELETE	Identifier, region
update_resource	memberships	UPDATE	Identifier, PatchDocument, region
list_resources	memberships_list_only	SELECT	region
get_resource	memberships	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual membership.

SELECT
  region,
  arn,
  tags,
  collaboration_arn,
  collaboration_creator_account_id,
  collaboration_identifier,
  membership_identifier,
  query_log_status,
  job_log_status,
  default_result_configuration,
  default_job_result_configuration,
  payment_configuration
FROM awscc.cleanrooms.memberships
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ membership_identifier }}';

list (identifiers only)

Lists all memberships in a region.

SELECT
  region,
  membership_identifier
FROM awscc.cleanrooms.memberships_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cleanrooms.memberships (
  CollaborationIdentifier,
  QueryLogStatus,
  region
)
SELECT
  '{{ collaboration_identifier }}',
  '{{ query_log_status }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cleanrooms.memberships (
  Tags,
  CollaborationIdentifier,
  QueryLogStatus,
  JobLogStatus,
  DefaultResultConfiguration,
  DefaultJobResultConfiguration,
  PaymentConfiguration,
  region
)
SELECT
  '{{ tags }}',
  '{{ collaboration_identifier }}',
  '{{ query_log_status }}',
  '{{ job_log_status }}',
  '{{ default_result_configuration }}',
  '{{ default_job_result_configuration }}',
  '{{ payment_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

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: collaboration_identifier
      value: '{{ collaboration_identifier }}'
    - name: query_log_status
      value: '{{ query_log_status }}'
    - name: job_log_status
      value: '{{ job_log_status }}'
    - name: default_result_configuration
      value:
        output_configuration:
          s3:
            result_format: '{{ result_format }}'
            bucket: '{{ bucket }}'
            key_prefix: '{{ key_prefix }}'
            single_file_output: '{{ single_file_output }}'
        role_arn: '{{ role_arn }}'
    - name: default_job_result_configuration
      value:
        output_configuration:
          s3:
            bucket: '{{ bucket }}'
            key_prefix: '{{ key_prefix }}'
        role_arn: '{{ role_arn }}'
    - name: payment_configuration
      value:
        query_compute:
          is_responsible: '{{ is_responsible }}'
        machine_learning:
          model_training:
            is_responsible: '{{ is_responsible }}'
          model_inference:
            is_responsible: '{{ is_responsible }}'
        job_compute:
          is_responsible: '{{ is_responsible }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cleanrooms.memberships
SET PatchDocument = string('{{ {
    "Tags": tags,
    "QueryLogStatus": query_log_status,
    "JobLogStatus": job_log_status,
    "DefaultResultConfiguration": default_result_configuration,
    "DefaultJobResultConfiguration": default_job_result_configuration,
    "PaymentConfiguration": payment_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ membership_identifier }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cleanrooms.memberships
WHERE
  Identifier = '{{ membership_identifier }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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