interface CfnCollaborationProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CleanRooms.CfnCollaborationProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnCollaborationProps |
 Java | software.amazon.awscdk.services.cleanrooms.CfnCollaborationProps |
 Python | aws_cdk.aws_cleanrooms.CfnCollaborationProps |
 TypeScript | aws-cdk-lib » aws_cleanrooms » CfnCollaborationProps |
Properties for defining a CfnCollaboration.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cleanrooms as cleanrooms } from 'aws-cdk-lib';
const cfnCollaborationProps: cleanrooms.CfnCollaborationProps = {
creatorDisplayName: 'creatorDisplayName',
description: 'description',
name: 'name',
queryLogStatus: 'queryLogStatus',
// the properties below are optional
allowedResultRegions: ['allowedResultRegions'],
analyticsEngine: 'analyticsEngine',
autoApprovedChangeTypes: ['autoApprovedChangeTypes'],
creatorMemberAbilities: ['creatorMemberAbilities'],
creatorMlMemberAbilities: {
customMlMemberAbilities: ['customMlMemberAbilities'],
},
creatorPaymentConfiguration: {
queryCompute: {
isResponsible: false,
},
// the properties below are optional
jobCompute: {
isResponsible: false,
},
machineLearning: {
modelInference: {
isResponsible: false,
},
modelTraining: {
isResponsible: false,
},
syntheticDataGeneration: {
isResponsible: false,
},
},
},
dataEncryptionMetadata: {
allowCleartext: false,
allowDuplicates: false,
allowJoinsOnColumnsWithDifferentNames: false,
preserveNulls: false,
},
jobLogStatus: 'jobLogStatus',
members: [{
accountId: 'accountId',
displayName: 'displayName',
// the properties below are optional
memberAbilities: ['memberAbilities'],
mlMemberAbilities: {
customMlMemberAbilities: ['customMlMemberAbilities'],
},
paymentConfiguration: {
queryCompute: {
isResponsible: false,
},
// the properties below are optional
jobCompute: {
isResponsible: false,
},
machineLearning: {
modelInference: {
isResponsible: false,
},
modelTraining: {
isResponsible: false,
},
syntheticDataGeneration: {
isResponsible: false,
},
},
},
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| creator | string | A display name of the collaboration creator. |
| description | string | A description of the collaboration provided by the collaboration owner. |
| name | string | A human-readable identifier provided by the collaboration owner. |
| query | string | An indicator as to whether query logging has been enabled or disabled for the collaboration. |
| allowed | string[] | The AWS Regions where collaboration query results can be stored. |
| analytics | string | The analytics engine for the collaboration. |
| auto | string[] | The types of change requests that are automatically approved for this collaboration. |
| creator | string[] | The abilities granted to the collaboration creator. |
| creator | IResolvable | MLMember | The ML member abilities for a collaboration member. |
| creator | IResolvable | Payment | An object representing the collaboration member's payment responsibilities set by the collaboration creator. |
| data | IResolvable | Data | The settings for client-side encryption for cryptographic computing. |
| job | string | An indicator as to whether job logging has been enabled or disabled for the collaboration. |
| members? | IResolvable | (IResolvable | Member)[] | A list of initial members, not including the creator. |
| tags? | Cfn[] | An optional label that you can assign to a resource when you create it. |
creatorDisplayName
Type:
string
A display name of the collaboration creator.
description
Type:
string
A description of the collaboration provided by the collaboration owner.
name
Type:
string
A human-readable identifier provided by the collaboration owner.
Display names are not unique.
queryLogStatus
Type:
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 .
allowedResultRegions?
Type:
string[]
(optional)
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.
analyticsEngine?
Type:
string
(optional)
The analytics engine for the collaboration.
After July 16, 2025, the
CLEAN_ROOMS_SQLparameter will no longer be available.
autoApprovedChangeTypes?
Type:
string[]
(optional)
The types of change requests that are automatically approved for this collaboration.
creatorMemberAbilities?
Type:
string[]
(optional)
The abilities granted to the collaboration creator.
Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB
creatorMlMemberAbilities?
Type:
IResolvable | MLMember
(optional)
The ML member abilities for a collaboration member.
creatorPaymentConfiguration?
Type:
IResolvable | Payment
(optional)
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
dataEncryptionMetadata?
Type:
IResolvable | Data
(optional)
The settings for client-side encryption for cryptographic computing.
jobLogStatus?
Type:
string
(optional)
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 .
members?
Type:
IResolvable | (IResolvable | Member)[]
(optional)
A list of initial members, not including the creator.
This list is immutable.
tags?
Type:
Cfn[]
(optional)
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.