CfnCollaborationProps

class aws_cdk.aws_cleanrooms.CfnCollaborationProps(*, creator_display_name, description, name, query_log_status, analytics_engine=None, auto_approved_change_types=None, creator_member_abilities=None, creator_ml_member_abilities=None, creator_payment_configuration=None, data_encryption_metadata=None, job_log_status=None, members=None, tags=None)

Bases: object

Properties for defining a CfnCollaboration.

Parameters:

• creator_display_name (str) – A display name of the collaboration creator.

• description (str) – A description of the collaboration provided by the collaboration owner.

• name (str) – A human-readable identifier provided by the collaboration owner. Display names are not unique.

• query_log_status (str) – 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 .

• analytics_engine (Optional[str]) – The analytics engine for the collaboration. .. epigraph:: After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

• auto_approved_change_types (Optional[Sequence[str]]) – The types of change requests that are automatically approved for this collaboration.

• creator_member_abilities (Optional[Sequence[str]]) – The abilities granted to the collaboration creator. Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB

• creator_ml_member_abilities (Union[IResolvable, MLMemberAbilitiesProperty, Dict[str, Any], None]) – The ML member abilities for a collaboration member.

• creator_payment_configuration (Union[IResolvable, PaymentConfigurationProperty, Dict[str, Any], None]) – An object representing the collaboration member’s payment responsibilities set by the collaboration creator.

• data_encryption_metadata (Union[IResolvable, DataEncryptionMetadataProperty, Dict[str, Any], None]) – The settings for client-side encryption for cryptographic computing.

• job_log_status (Optional[str]) – 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 (Union[IResolvable, Sequence[Union[IResolvable, MemberSpecificationProperty, Dict[str, Any]]], None]) – A list of initial members, not including the creator. This list is immutable.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cleanrooms as cleanrooms

cfn_collaboration_props = cleanrooms.CfnCollaborationProps(
    creator_display_name="creatorDisplayName",
    description="description",
    name="name",
    query_log_status="queryLogStatus",

    # the properties below are optional
    analytics_engine="analyticsEngine",
    auto_approved_change_types=["autoApprovedChangeTypes"],
    creator_member_abilities=["creatorMemberAbilities"],
    creator_ml_member_abilities=cleanrooms.CfnCollaboration.MLMemberAbilitiesProperty(
        custom_ml_member_abilities=["customMlMemberAbilities"]
    ),
    creator_payment_configuration=cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
        query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
            is_responsible=False
        ),

        # the properties below are optional
        job_compute=cleanrooms.CfnCollaboration.JobComputePaymentConfigProperty(
            is_responsible=False
        ),
        machine_learning=cleanrooms.CfnCollaboration.MLPaymentConfigProperty(
            model_inference=cleanrooms.CfnCollaboration.ModelInferencePaymentConfigProperty(
                is_responsible=False
            ),
            model_training=cleanrooms.CfnCollaboration.ModelTrainingPaymentConfigProperty(
                is_responsible=False
            )
        )
    ),
    data_encryption_metadata=cleanrooms.CfnCollaboration.DataEncryptionMetadataProperty(
        allow_cleartext=False,
        allow_duplicates=False,
        allow_joins_on_columns_with_different_names=False,
        preserve_nulls=False
    ),
    job_log_status="jobLogStatus",
    members=[cleanrooms.CfnCollaboration.MemberSpecificationProperty(
        account_id="accountId",
        display_name="displayName",

        # the properties below are optional
        member_abilities=["memberAbilities"],
        ml_member_abilities=cleanrooms.CfnCollaboration.MLMemberAbilitiesProperty(
            custom_ml_member_abilities=["customMlMemberAbilities"]
        ),
        payment_configuration=cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
            query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
                is_responsible=False
            ),

            # the properties below are optional
            job_compute=cleanrooms.CfnCollaboration.JobComputePaymentConfigProperty(
                is_responsible=False
            ),
            machine_learning=cleanrooms.CfnCollaboration.MLPaymentConfigProperty(
                model_inference=cleanrooms.CfnCollaboration.ModelInferencePaymentConfigProperty(
                    is_responsible=False
                ),
                model_training=cleanrooms.CfnCollaboration.ModelTrainingPaymentConfigProperty(
                    is_responsible=False
                )
            )
        )
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

analytics_engine

The analytics engine for the collaboration.

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

See:

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

auto_approved_change_types

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

See:

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

creator_display_name

A display name of the collaboration creator.

See:

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

creator_member_abilities

The abilities granted to the collaboration creator.

Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB

See:

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

creator_ml_member_abilities

The ML member abilities for a collaboration member.

See:

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

creator_payment_configuration

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

See:

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

data_encryption_metadata

The settings for client-side encryption for cryptographic computing.

See:

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

description

A description of the collaboration provided by the collaboration owner.

See:

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

job_log_status

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:

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

members

A list of initial members, not including the creator.

This list is immutable.

See:

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

name

A human-readable identifier provided by the collaboration owner.

Display names are not unique.

See:

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

query_log_status

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:

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

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.

See:

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