interface CfnCollaborationProps

Language	Type name
.NET	Amazon.CDK.aws_cleanrooms.CfnCollaborationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnCollaborationProps
Java	software.amazon.awscdk.services.cleanrooms.CfnCollaborationProps
Python	aws_cdk.aws_cleanrooms.CfnCollaborationProps
TypeScript	aws-cdk-lib » aws_cleanrooms » CfnCollaborationProps

Properties for defining a CfnCollaboration.

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 { aws_cleanrooms as cleanrooms } from 'aws-cdk-lib';
const cfnCollaborationProps: cleanrooms.CfnCollaborationProps = {
  creatorDisplayName: 'creatorDisplayName',
  creatorMemberAbilities: ['creatorMemberAbilities'],
  description: 'description',
  members: [{
    accountId: 'accountId',
    displayName: 'displayName',
    memberAbilities: ['memberAbilities'],

    // the properties below are optional
    paymentConfiguration: {
      queryCompute: {
        isResponsible: false,
      },
    },
  }],
  name: 'name',
  queryLogStatus: 'queryLogStatus',

  // the properties below are optional
  analyticsEngine: 'analyticsEngine',
  creatorPaymentConfiguration: {
    queryCompute: {
      isResponsible: false,
    },
  },
  dataEncryptionMetadata: {
    allowCleartext: false,
    allowDuplicates: false,
    allowJoinsOnColumnsWithDifferentNames: false,
    preserveNulls: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
creatorDisplayName	string	A display name of the collaboration creator.
creatorMemberAbilities	string[]	The abilities granted to the collaboration creator.
description	string	A description of the collaboration provided by the collaboration owner.
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.
analyticsEngine?	string	The analytics engine for the collaboration.
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.
tags?	CfnTag[]	An optional label that you can assign to a resource when you create it.

---

creatorDisplayName

Type: string

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[]

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

---

description

Type: string

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

---

members

Type: IResolvable | IResolvable | MemberSpecificationProperty[]

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

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

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

---

analyticsEngine?

Type: string (optional)

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

---

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

---

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