Creates a new collaboration.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::CleanRooms::Collaboration",
"Properties" : {
"AnalyticsEngine" : String,
"CreatorDisplayName" : String,
"CreatorMemberAbilities" : [ String, ... ],
"CreatorMLMemberAbilities" : MLMemberAbilities,
"CreatorPaymentConfiguration" : PaymentConfiguration,
"DataEncryptionMetadata" : DataEncryptionMetadata,
"Description" : String,
"Members" : [ MemberSpecification, ... ],
"Name" : String,
"QueryLogStatus" : String,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::CleanRooms::Collaboration
Properties:
AnalyticsEngine: String
CreatorDisplayName: String
CreatorMemberAbilities:
- String
CreatorMLMemberAbilities:
MLMemberAbilities
CreatorPaymentConfiguration:
PaymentConfiguration
DataEncryptionMetadata:
DataEncryptionMetadata
Description: String
Members:
- MemberSpecification
Name: String
QueryLogStatus: String
Tags:
- Tag
Properties
AnalyticsEngine-
The analytics engine for the collaboration.
Required: No
Type: String
Allowed values:
CLEAN_ROOMS_SQL | SPARKUpdate requires: Replacement
CreatorDisplayName-
A display name of the collaboration creator.
Required: Yes
Type: String
Pattern:
^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$Minimum:
1Maximum:
100Update requires: Replacement
CreatorMemberAbilities-
The abilities granted to the collaboration creator.
Allowed values
CAN_QUERY|CAN_RECEIVE_RESULTSRequired: Yes
Type: Array of String
Update requires: Replacement
CreatorMLMemberAbilities-
The ML member abilities for a collaboration member.
Required: No
Type: MLMemberAbilities
Update requires: Replacement
CreatorPaymentConfiguration-
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
Required: No
Type: PaymentConfiguration
Update requires: Replacement
DataEncryptionMetadata-
The settings for client-side encryption for cryptographic computing.
Required: No
Type: DataEncryptionMetadata
Update requires: Replacement
Description-
A description of the collaboration provided by the collaboration owner.
Required: Yes
Type: String
Pattern:
^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$Minimum:
1Maximum:
255Update requires: No interruption
Members-
A list of initial members, not including the creator. This list is immutable.
Required: Yes
Type: Array of MemberSpecification
Minimum:
0Maximum:
9Update requires: Replacement
Name-
A human-readable identifier provided by the collaboration owner. Display names are not unique.
Required: Yes
Type: String
Pattern:
^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$Minimum:
1Maximum:
100Update requires: No interruption
QueryLogStatus-
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 isDISABLED.Required: Yes
Type: String
Allowed values:
ENABLED | DISABLEDUpdate requires: Replacement
-
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.
Required: No
Type: Array of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the CollaborationIdentifier, such as
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. For example:
{ "Ref": "MyCollaboration" }
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
Arn-
Returns the Amazon Resource Name (ARN) of the specified collaboration.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 CollaborationIdentifier-
Returns the unique identifier of the specified collaboration.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Examples
Create a collaboration
The following example creates a collaboration with the collaboration creator.
JSON
"ExampleCollaboration": {
{
"Type": "AWS::CleanRooms::Collaboration",
"Properties": {
"Name": "Example Collaboration",
"Description": "Example AWS Clean Rooms collaboration",
"CreatorDisplayName": "Member 1",
"CreatorMemberAbilities": ["CAN_QUERY", "CAN_RECEIVE_RESULTS"],
"Members": [
{
"AccountId": "111122223333",
"DisplayName": "Member 2",
"MemberAbilities": []
},
{
"AccountId": "444455556666",
"DisplayName": "Member 3",
"MemberAbilities": []
}
],
"QueryLogStatus": "ENABLED"
}
}
}YAML
ExampleCollaboration:
Type: AWS::CleanRooms::Collaboration
Properties:
Name: Example Collaboration
Description: Example AWS Clean Rooms collaboration
CreatorDisplayName: Member 1
CreatorMemberAbilities:
- CAN_QUERY
- CAN_RECEIVE_RESULTS
Members:
- AccountId: 111122223333
DisplayName: Member 2
MemberAbilities: []
- AccountId: 444455556666
DisplayName: Member 3
MemberAbilities: []
QueryLogStatus: ENABLED