interface CfnCollaborationMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CleanRooms.Mixins.CfnCollaborationMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscleanrooms/mixins#CfnCollaborationMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cleanrooms.mixins.CfnCollaborationMixinProps
Python	aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnCollaborationMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cleanrooms » mixins » CfnCollaborationMixinProps

Properties for CfnCollaborationPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cleanrooms_mixins } from '@aws-cdk/mixins-preview/aws-cleanrooms';
const cfnCollaborationMixinProps: cleanrooms_mixins.CfnCollaborationMixinProps = {
  allowedResultRegions: ['allowedResultRegions'],
  analyticsEngine: 'analyticsEngine',
  autoApprovedChangeTypes: ['autoApprovedChangeTypes'],
  creatorDisplayName: 'creatorDisplayName',
  creatorMemberAbilities: ['creatorMemberAbilities'],
  creatorMlMemberAbilities: {
    customMlMemberAbilities: ['customMlMemberAbilities'],
  },
  creatorPaymentConfiguration: {
    jobCompute: {
      isResponsible: false,
    },
    machineLearning: {
      modelInference: {
        isResponsible: false,
      },
      modelTraining: {
        isResponsible: false,
      },
      syntheticDataGeneration: {
        isResponsible: false,
      },
    },
    queryCompute: {
      isResponsible: false,
    },
  },
  dataEncryptionMetadata: {
    allowCleartext: false,
    allowDuplicates: false,
    allowJoinsOnColumnsWithDifferentNames: false,
    preserveNulls: false,
  },
  description: 'description',
  jobLogStatus: 'jobLogStatus',
  members: [{
    accountId: 'accountId',
    displayName: 'displayName',
    memberAbilities: ['memberAbilities'],
    mlMemberAbilities: {
      customMlMemberAbilities: ['customMlMemberAbilities'],
    },
    paymentConfiguration: {
      jobCompute: {
        isResponsible: false,
      },
      machineLearning: {
        modelInference: {
          isResponsible: false,
        },
        modelTraining: {
          isResponsible: false,
        },
        syntheticDataGeneration: {
          isResponsible: false,
        },
      },
      queryCompute: {
        isResponsible: false,
      },
    },
  }],
  name: 'name',
  queryLogStatus: 'queryLogStatus',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

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

---

allowedResultRegions?

Type: string[] (optional)

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

---

analyticsEngine?

Type: string (optional)

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

---

autoApprovedChangeTypes?

Type: string[] (optional)

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

---

creatorDisplayName?

Type: string (optional)

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

---

creatorMemberAbilities?

Type: string[] (optional)

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

---

creatorMlMemberAbilities?

Type: IResolvable | MLMemberAbilitiesProperty (optional)

The ML member abilities for a collaboration member.

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

---

creatorPaymentConfiguration?

Type: IResolvable | PaymentConfigurationProperty (optional)

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

---

dataEncryptionMetadata?

Type: IResolvable | DataEncryptionMetadataProperty (optional)

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

---

description?

Type: string (optional)

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

---

jobLogStatus?

Type: string (optional)

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

---

members?

Type: IResolvable | (IResolvable | MemberSpecificationProperty)[] (optional)

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

---

name?

Type: string (optional)

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

---

queryLogStatus?

Type: string (optional)

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

---

tags?

Type: CfnTag[] (optional)

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