Package software.amazon.awscdk.services.cleanrooms

Interface CfnCollaborationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCollaborationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:00.248Z")
@Stability(Stable)
public interface CfnCollaborationProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cleanrooms.*;
 CfnCollaborationProps cfnCollaborationProps = CfnCollaborationProps.builder()
         .creatorDisplayName("creatorDisplayName")
         .description("description")
         .name("name")
         .queryLogStatus("queryLogStatus")
         // the properties below are optional
         .allowedResultRegions(List.of("allowedResultRegions"))
         .analyticsEngine("analyticsEngine")
         .autoApprovedChangeTypes(List.of("autoApprovedChangeTypes"))
         .creatorMemberAbilities(List.of("creatorMemberAbilities"))
         .creatorMlMemberAbilities(MLMemberAbilitiesProperty.builder()
                 .customMlMemberAbilities(List.of("customMlMemberAbilities"))
                 .build())
         .creatorPaymentConfiguration(PaymentConfigurationProperty.builder()
                 .queryCompute(QueryComputePaymentConfigProperty.builder()
                         .isResponsible(false)
                         .build())
                 // the properties below are optional
                 .jobCompute(JobComputePaymentConfigProperty.builder()
                         .isResponsible(false)
                         .build())
                 .machineLearning(MLPaymentConfigProperty.builder()
                         .modelInference(ModelInferencePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .modelTraining(ModelTrainingPaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .build())
                 .build())
         .dataEncryptionMetadata(DataEncryptionMetadataProperty.builder()
                 .allowCleartext(false)
                 .allowDuplicates(false)
                 .allowJoinsOnColumnsWithDifferentNames(false)
                 .preserveNulls(false)
                 .build())
         .jobLogStatus("jobLogStatus")
         .members(List.of(MemberSpecificationProperty.builder()
                 .accountId("accountId")
                 .displayName("displayName")
                 // the properties below are optional
                 .memberAbilities(List.of("memberAbilities"))
                 .mlMemberAbilities(MLMemberAbilitiesProperty.builder()
                         .customMlMemberAbilities(List.of("customMlMemberAbilities"))
                         .build())
                 .paymentConfiguration(PaymentConfigurationProperty.builder()
                         .queryCompute(QueryComputePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         // the properties below are optional
                         .jobCompute(JobComputePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .machineLearning(MLPaymentConfigProperty.builder()
                                 .modelInference(ModelInferencePaymentConfigProperty.builder()
                                         .isResponsible(false)
                                         .build())
                                 .modelTraining(ModelTrainingPaymentConfigProperty.builder()
                                         .isResponsible(false)
                                         .build())
                                 .build())
                         .build())
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCollaborationProps.Builder	A builder for CfnCollaborationProps
static final class	CfnCollaborationProps.Jsii$Proxy	An implementation for CfnCollaborationProps

Method Summary

Modifier and Type	Method	Description
static CfnCollaborationProps.Builder	builder()
default List<String>	getAllowedResultRegions()	The AWS Regions where collaboration query results can be stored.
default String	getAnalyticsEngine()	The analytics engine for the collaboration.
default List<String>	getAutoApprovedChangeTypes()	The types of change requests that are automatically approved for this collaboration.
String	getCreatorDisplayName()	A display name of the collaboration creator.
default List<String>	getCreatorMemberAbilities()	The abilities granted to the collaboration creator.
default Object	getCreatorMlMemberAbilities()	The ML member abilities for a collaboration member.
default Object	getCreatorPaymentConfiguration()	An object representing the collaboration member's payment responsibilities set by the collaboration creator.
default Object	getDataEncryptionMetadata()	The settings for client-side encryption for cryptographic computing.
String	getDescription()	A description of the collaboration provided by the collaboration owner.
default String	getJobLogStatus()	An indicator as to whether job logging has been enabled or disabled for the collaboration.
default Object	getMembers()	A list of initial members, not including the creator.
String	getName()	A human-readable identifier provided by the collaboration owner.
String	getQueryLogStatus()	An indicator as to whether query logging has been enabled or disabled for the collaboration.
default List<CfnTag>	getTags()	An optional label that you can assign to a resource when you create it.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCreatorDisplayName

@Stability(Stable)
@NotNull
String getCreatorDisplayName()

A display name of the collaboration creator.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatordisplayname

getDescription

@Stability(Stable)
@NotNull
String getDescription()

A description of the collaboration provided by the collaboration owner.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-description

getName

@Stability(Stable)
@NotNull
String getName()

A human-readable identifier provided by the collaboration owner.

Display names are not unique.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-name

getQueryLogStatus

@Stability(Stable)
@NotNull
String getQueryLogStatus()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-querylogstatus

getAllowedResultRegions

@Stability(Stable)
@Nullable
default List<String> getAllowedResultRegions()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-allowedresultregions

getAnalyticsEngine

@Stability(Stable)
@Nullable
default String getAnalyticsEngine()

The analytics engine for the collaboration.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-analyticsengine

getAutoApprovedChangeTypes

@Stability(Stable)
@Nullable
default List<String> getAutoApprovedChangeTypes()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-autoapprovedchangetypes

getCreatorMemberAbilities

@Stability(Stable)
@Nullable
default List<String> getCreatorMemberAbilities()

The abilities granted to the collaboration creator.

Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatormemberabilities

getCreatorMlMemberAbilities

@Stability(Stable)
@Nullable
default Object getCreatorMlMemberAbilities()

The ML member abilities for a collaboration member.

Returns union: either IResolvable or CfnCollaboration.MLMemberAbilitiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatormlmemberabilities

getCreatorPaymentConfiguration

@Stability(Stable)
@Nullable
default Object getCreatorPaymentConfiguration()

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

Returns union: either IResolvable or CfnCollaboration.PaymentConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatorpaymentconfiguration

getDataEncryptionMetadata

@Stability(Stable)
@Nullable
default Object getDataEncryptionMetadata()

The settings for client-side encryption for cryptographic computing.

Returns union: either IResolvable or CfnCollaboration.DataEncryptionMetadataProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-dataencryptionmetadata

getJobLogStatus

@Stability(Stable)
@Nullable
default String getJobLogStatus()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-joblogstatus

getMembers

@Stability(Stable)
@Nullable
default Object getMembers()

A list of initial members, not including the creator.

This list is immutable.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCollaboration.MemberSpecificationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-members

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-tags

builder

@Stability(Stable)
static CfnCollaborationProps.Builder builder()

Returns:

a CfnCollaborationProps.Builder of CfnCollaborationProps