Package software.amazon.awscdk.cfnpropertymixins.services.cleanrooms

Class CfnCollaborationPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cleanrooms.CfnCollaborationPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollaborationPropsMixin>

Enclosing class:

CfnCollaborationPropsMixin

@Stability(Stable)
public static final class CfnCollaborationPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCollaborationPropsMixin>

A fluent builder for CfnCollaborationPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCollaborationPropsMixin.Builder	allowedResultRegions(List<String> allowedResultRegions)	The AWS Regions where collaboration query results can be stored.
CfnCollaborationPropsMixin.Builder	analyticsEngine(String analyticsEngine)	The analytics engine for the collaboration.
CfnCollaborationPropsMixin.Builder	autoApprovedChangeTypes(List<String> autoApprovedChangeTypes)	The types of change requests that are automatically approved for this collaboration.
CfnCollaborationPropsMixin	build()
static CfnCollaborationPropsMixin.Builder	create()
static CfnCollaborationPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCollaborationPropsMixin.Builder	creatorDisplayName(String creatorDisplayName)	A display name of the collaboration creator.
CfnCollaborationPropsMixin.Builder	creatorMemberAbilities(List<String> creatorMemberAbilities)	The abilities granted to the collaboration creator.
CfnCollaborationPropsMixin.Builder	creatorMlMemberAbilities(CfnCollaborationPropsMixin.MLMemberAbilitiesProperty creatorMlMemberAbilities)	The ML member abilities for a collaboration member.
CfnCollaborationPropsMixin.Builder	creatorMlMemberAbilities(IResolvable creatorMlMemberAbilities)	The ML member abilities for a collaboration member.
CfnCollaborationPropsMixin.Builder	creatorPaymentConfiguration(CfnCollaborationPropsMixin.PaymentConfigurationProperty creatorPaymentConfiguration)	An object representing the collaboration member's payment responsibilities set by the collaboration creator.
CfnCollaborationPropsMixin.Builder	creatorPaymentConfiguration(IResolvable creatorPaymentConfiguration)	An object representing the collaboration member's payment responsibilities set by the collaboration creator.
CfnCollaborationPropsMixin.Builder	dataEncryptionMetadata(CfnCollaborationPropsMixin.DataEncryptionMetadataProperty dataEncryptionMetadata)	The settings for client-side encryption for cryptographic computing.
CfnCollaborationPropsMixin.Builder	dataEncryptionMetadata(IResolvable dataEncryptionMetadata)	The settings for client-side encryption for cryptographic computing.
CfnCollaborationPropsMixin.Builder	description(String description)	A description of the collaboration provided by the collaboration owner.
CfnCollaborationPropsMixin.Builder	isMetricsEnabled(Boolean isMetricsEnabled)
CfnCollaborationPropsMixin.Builder	isMetricsEnabled(IResolvable isMetricsEnabled)
CfnCollaborationPropsMixin.Builder	jobLogStatus(String jobLogStatus)	An indicator as to whether job logging has been enabled or disabled for the collaboration.
CfnCollaborationPropsMixin.Builder	members(List<? extends Object> members)	A list of initial members, not including the creator.
CfnCollaborationPropsMixin.Builder	members(IResolvable members)	A list of initial members, not including the creator.
CfnCollaborationPropsMixin.Builder	name(String name)	A human-readable identifier provided by the collaboration owner.
CfnCollaborationPropsMixin.Builder	queryLogStatus(String queryLogStatus)	An indicator as to whether query logging has been enabled or disabled for the collaboration.
CfnCollaborationPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An optional label that you can assign to a resource when you create it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCollaborationPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCollaborationPropsMixin.Builder.

create

@Stability(Stable)
public static CfnCollaborationPropsMixin.Builder create()

Returns:

a new instance of CfnCollaborationPropsMixin.Builder.

allowedResultRegions

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder allowedResultRegions(List<String> allowedResultRegions)

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.

Parameters:

allowedResultRegions - The AWS Regions where collaboration query results can be stored. This parameter is required.

Returns:

this

See Also:

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

analyticsEngine

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder analyticsEngine(String analyticsEngine)

The analytics engine for the collaboration.

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

Parameters:

analyticsEngine - The analytics engine for the collaboration. This parameter is required.

Returns:

this

See Also:

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

autoApprovedChangeTypes

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder autoApprovedChangeTypes(List<String> autoApprovedChangeTypes)

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

Parameters:

autoApprovedChangeTypes - The types of change requests that are automatically approved for this collaboration. This parameter is required.

Returns:

this

See Also:

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

creatorDisplayName

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder creatorDisplayName(String creatorDisplayName)

A display name of the collaboration creator.

Parameters:

creatorDisplayName - A display name of the collaboration creator. This parameter is required.

Returns:

this

See Also:

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

creatorMemberAbilities

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder creatorMemberAbilities(List<String> creatorMemberAbilities)

The abilities granted to the collaboration creator.

Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB

Parameters:

creatorMemberAbilities - The abilities granted to the collaboration creator. This parameter is required.

Returns:

this

See Also:

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

creatorMlMemberAbilities

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder creatorMlMemberAbilities(IResolvable creatorMlMemberAbilities)

The ML member abilities for a collaboration member.

Parameters:

creatorMlMemberAbilities - The ML member abilities for a collaboration member. This parameter is required.

Returns:

this

See Also:

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

creatorMlMemberAbilities

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder creatorMlMemberAbilities(CfnCollaborationPropsMixin.MLMemberAbilitiesProperty creatorMlMemberAbilities)

The ML member abilities for a collaboration member.

Parameters:

creatorMlMemberAbilities - The ML member abilities for a collaboration member. This parameter is required.

Returns:

this

See Also:

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

creatorPaymentConfiguration

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder creatorPaymentConfiguration(IResolvable creatorPaymentConfiguration)

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

Parameters:

creatorPaymentConfiguration - An object representing the collaboration member's payment responsibilities set by the collaboration creator. This parameter is required.

Returns:

this

See Also:

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

creatorPaymentConfiguration

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder creatorPaymentConfiguration(CfnCollaborationPropsMixin.PaymentConfigurationProperty creatorPaymentConfiguration)

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

Parameters:

creatorPaymentConfiguration - An object representing the collaboration member's payment responsibilities set by the collaboration creator. This parameter is required.

Returns:

this

See Also:

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

dataEncryptionMetadata

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder dataEncryptionMetadata(IResolvable dataEncryptionMetadata)

The settings for client-side encryption for cryptographic computing.

Parameters:

dataEncryptionMetadata - The settings for client-side encryption for cryptographic computing. This parameter is required.

Returns:

this

See Also:

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

dataEncryptionMetadata

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder dataEncryptionMetadata(CfnCollaborationPropsMixin.DataEncryptionMetadataProperty dataEncryptionMetadata)

The settings for client-side encryption for cryptographic computing.

Parameters:

dataEncryptionMetadata - The settings for client-side encryption for cryptographic computing. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder description(String description)

A description of the collaboration provided by the collaboration owner.

Parameters:

description - A description of the collaboration provided by the collaboration owner. This parameter is required.

Returns:

this

See Also:

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

isMetricsEnabled

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder isMetricsEnabled(Boolean isMetricsEnabled)

Parameters:

isMetricsEnabled - This parameter is required.

Returns:

this

See Also:

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

isMetricsEnabled

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder isMetricsEnabled(IResolvable isMetricsEnabled)

Parameters:

isMetricsEnabled - This parameter is required.

Returns:

this

See Also:

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

jobLogStatus

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder jobLogStatus(String jobLogStatus)

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 .

Parameters:

jobLogStatus - An indicator as to whether job logging has been enabled or disabled for the collaboration. This parameter is required.

Returns:

this

See Also:

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

members

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder members(IResolvable members)

A list of initial members, not including the creator.

This list is immutable.

Parameters:

members - A list of initial members, not including the creator. This parameter is required.

Returns:

this

See Also:

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

members

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder members(List<? extends Object> members)

A list of initial members, not including the creator.

This list is immutable.

Parameters:

members - A list of initial members, not including the creator. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder name(String name)

A human-readable identifier provided by the collaboration owner.

Display names are not unique.

Parameters:

name - A human-readable identifier provided by the collaboration owner. This parameter is required.

Returns:

this

See Also:

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

queryLogStatus

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder queryLogStatus(String 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 is DISABLED .

Parameters:

queryLogStatus - An indicator as to whether query logging has been enabled or disabled for the collaboration. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnCollaborationPropsMixin.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - An optional label that you can assign to a resource when you create it. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCollaborationPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCollaborationPropsMixin>

Returns:

a newly built instance of CfnCollaborationPropsMixin.