aws-cdk-lib.aws_cleanrooms.CfnCollaborationProps

interface CfnCollaborationProps

LanguageType name
.NETAmazon.CDK.aws_cleanrooms.CfnCollaborationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnCollaborationProps
Javaservices.cleanrooms.CfnCollaborationProps
Pythonaws_cdk.aws_cleanrooms.CfnCollaborationProps
TypeScript aws-cdk-lib » aws_cleanrooms » CfnCollaborationProps

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 { 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'],
  }],
  name: 'name',
  queryLogStatus: 'queryLogStatus',

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

Properties

NameTypeDescription
creatorDisplayNamestringA display name of the collaboration creator.
creatorMemberAbilitiesstring[]The abilities granted to the collaboration creator.
descriptionstringA description of the collaboration provided by the collaboration owner.
membersIResolvable | IResolvable | MemberSpecificationProperty[]A list of initial members, not including the creator.
namestringA human-readable identifier provided by the collaboration owner.
queryLogStatusstringAn indicator as to whether query logging has been enabled or disabled for the collaboration.
dataEncryptionMetadata?IResolvable | DataEncryptionMetadataPropertyThe 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.


creatorMemberAbilities

Type: string[]

The abilities granted to the collaboration creator.


description

Type: string

A description of the collaboration provided by the collaboration owner.


members

Type: IResolvable | IResolvable | MemberSpecificationProperty[]

A list of initial members, not including the creator.

This list is immutable.


name

Type: string

A human-readable identifier provided by the collaboration owner.

Display names are not unique.


queryLogStatus

Type: string

An indicator as to whether query logging has been enabled or disabled for the collaboration.


dataEncryptionMetadata?

Type: IResolvable | DataEncryptionMetadataProperty (optional)

The settings for client-side encryption for cryptographic computing.


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.