AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CleanRooms::Collaboration

CfnCollaboration

Creates a new collaboration.

Import

import { CfnCollaboration } from 'aws-cdk-lib/aws-cleanrooms';

Or use the module namespace:

import * as cleanrooms from 'aws-cdk-lib/aws-cleanrooms';
// cleanrooms.CfnCollaboration

Properties

Configuration passed to the constructor as CfnCollaborationProps.

creatorDisplayNameRequired
string

A display name of the collaboration creator.

descriptionRequired
string

A description of the collaboration provided by the collaboration owner.

nameRequired
string

A human-readable identifier provided by the collaboration owner. Display names are not unique.

queryLogStatusRequired
string

An indicator as to whether query logging has been enabled or disabled for the collaboration. When `ENABLED` , AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .

allowedResultRegionsOptional
string[]

The AWS Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.

analyticsEngineOptional
string

The analytics engine for the collaboration. > After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available.

autoApprovedChangeTypesOptional
string[]

The types of change requests that are automatically approved for this collaboration.

creatorMemberAbilitiesOptional
string[]

The abilities granted to the collaboration creator. *Allowed values* `CAN_QUERY` | `CAN_RECEIVE_RESULTS` | `CAN_RUN_JOB`

creatorMlMemberAbilitiesOptional
IResolvable | MLMemberAbilitiesProperty

The ML member abilities for a collaboration member.

creatorPaymentConfigurationOptional
IResolvable | PaymentConfigurationProperty

An object representing the collaboration member's payment responsibilities set by the collaboration creator.

dataEncryptionMetadataOptional
IResolvable | DataEncryptionMetadataProperty

The settings for client-side encryption for cryptographic computing.

isMetricsEnabledOptional
boolean | IResolvable
jobLogStatusOptional
string

An indicator as to whether job logging has been enabled or disabled for the collaboration. When `ENABLED` , AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .

membersOptional
IResolvable | IResolvable | MemberSpecificationProperty[]

A list of initial members, not including the creator. This list is immutable.

tagsOptional
CfnTag[]

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

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

Subscribe to Newsletter