AWS Fundamentals Logo
AWS Fundamentals
AWS::CleanRooms::Collaboration

CleanRooms Collaboration

Represents a collaboration between AWS accounts that allows for secure data collaboration

Properties

15 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
CreatorDisplayName
string
RequiredCreate-only
Description
string
Required
Name
string
Required
QueryLogStatus
string
RequiredCreate-only
AllowedResultRegions
array
Create-only
AnalyticsEngine
string
AutoApprovedChangeTypes
array
Create-only
CreatorMemberAbilities
array
Create-only
CreatorMLMemberAbilities
MLMemberAbilities
Create-only
CreatorPaymentConfiguration
PaymentConfiguration
Create-only
DataEncryptionMetadata
DataEncryptionMetadata
Create-only
IsMetricsEnabled
boolean
JobLogStatus
string
Create-only
Members
Array<MemberSpecification>
Create-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
CollaborationIdentifierstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CleanRooms::Collaboration

Resources:
  MyResource:
    Type: AWS::CleanRooms::Collaboration
    Properties:
      CreatorDisplayName: "my-creatordisplayname"
      Name: "my-name"
      Description: "value"
      QueryLogStatus: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cleanrooms:CreateCollaborationcleanrooms:GetCollaborationcleanrooms:ListMemberscleanrooms:ListTagsForResourcecleanrooms:TagResourcecleanrooms:GetCollaborationcleanrooms:ListCollaborations

read

cleanrooms:GetCollaborationcleanrooms:ListMemberscleanrooms:ListTagsForResource

update

cleanrooms:UpdateCollaborationcleanrooms:GetCollaborationcleanrooms:ListMemberscleanrooms:ListTagsForResourcecleanrooms:TagResourcecleanrooms:UntagResource

delete

cleanrooms:DeleteCollaborationcleanrooms:GetCollaborationcleanrooms:ListTagsForResourcecleanrooms:UntagResourcecleanrooms:ListMemberscleanrooms:ListCollaborations

list

cleanrooms:ListCollaborations

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceCleanRooms
Properties17
Required4
TaggingSupported
Primary IDCollaborationIdentifier

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

CreatorDisplayNameCreatorMemberAbilitiesCreatorMLMemberAbilitiesDataEncryptionMetadataJobLogStatusQueryLogStatusMembersCreatorPaymentConfigurationAutoApprovedChangeTypesAllowedResultRegions

Related Resources

External Links