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.104.0 (build e79254c)",
           date="2024-12-27T17:01:58.197Z")
@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")
         .creatorMemberAbilities(List.of("creatorMemberAbilities"))
         .description("description")
         .members(List.of(MemberSpecificationProperty.builder()
                 .accountId("accountId")
                 .displayName("displayName")
                 .memberAbilities(List.of("memberAbilities"))
                 // the properties below are optional
                 .paymentConfiguration(PaymentConfigurationProperty.builder()
                         .queryCompute(QueryComputePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .build())
                 .build()))
         .name("name")
         .queryLogStatus("queryLogStatus")
         // the properties below are optional
         .analyticsEngine("analyticsEngine")
         .creatorPaymentConfiguration(PaymentConfigurationProperty.builder()
                 .queryCompute(QueryComputePaymentConfigProperty.builder()
                         .isResponsible(false)
                         .build())
                 .build())
         .dataEncryptionMetadata(DataEncryptionMetadataProperty.builder()
                 .allowCleartext(false)
                 .allowDuplicates(false)
                 .allowJoinsOnColumnsWithDifferentNames(false)
                 .preserveNulls(false)
                 .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 String	getAnalyticsEngine()	The analytics engine for the collaboration.
String	getCreatorDisplayName()	A display name of the collaboration creator.
List<String>	getCreatorMemberAbilities()	The abilities granted to the collaboration creator.
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.
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

getCreatorMemberAbilities

@Stability(Stable)
@NotNull
List<String> getCreatorMemberAbilities()

The abilities granted to the collaboration creator.

Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS

See Also:

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

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

getMembers

@Stability(Stable)
@NotNull
Object getMembers()

A list of initial members, not including the creator.

This list is immutable.

See Also:

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

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.

See Also:

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

getAnalyticsEngine

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

The analytics engine for the collaboration.

See Also:

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

getCreatorPaymentConfiguration

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

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

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.

See Also:

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

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