Interface ICfnCollaborationProps

Properties for defining a CfnCollaboration.

Namespace: Amazon.CDK.AwsCleanrooms
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnCollaborationProps
Syntax (vb)
Public Interface ICfnCollaborationProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_cleanrooms;

var cfnCollaborationProps = new CfnCollaborationProps {
    CreatorDisplayName = "creatorDisplayName",
    CreatorMemberAbilities = new [] { "creatorMemberAbilities" },
    Description = "description",
    Members = new [] { new MemberSpecificationProperty {
        AccountId = "accountId",
        DisplayName = "displayName",
        MemberAbilities = new [] { "memberAbilities" },

        // the properties below are optional
        MlMemberAbilities = new MLMemberAbilitiesProperty {
            CustomMlMemberAbilities = new [] { "customMlMemberAbilities" }
        },
        PaymentConfiguration = new PaymentConfigurationProperty {
            QueryCompute = new QueryComputePaymentConfigProperty {
                IsResponsible = false
            },

            // the properties below are optional
            MachineLearning = new MLPaymentConfigProperty {
                ModelInference = new ModelInferencePaymentConfigProperty {
                    IsResponsible = false
                },
                ModelTraining = new ModelTrainingPaymentConfigProperty {
                    IsResponsible = false
                }
            }
        }
    } },
    Name = "name",
    QueryLogStatus = "queryLogStatus",

    // the properties below are optional
    AnalyticsEngine = "analyticsEngine",
    CreatorMlMemberAbilities = new MLMemberAbilitiesProperty {
        CustomMlMemberAbilities = new [] { "customMlMemberAbilities" }
    },
    CreatorPaymentConfiguration = new PaymentConfigurationProperty {
        QueryCompute = new QueryComputePaymentConfigProperty {
            IsResponsible = false
        },

        // the properties below are optional
        MachineLearning = new MLPaymentConfigProperty {
            ModelInference = new ModelInferencePaymentConfigProperty {
                IsResponsible = false
            },
            ModelTraining = new ModelTrainingPaymentConfigProperty {
                IsResponsible = false
            }
        }
    },
    DataEncryptionMetadata = new DataEncryptionMetadataProperty {
        AllowCleartext = false,
        AllowDuplicates = false,
        AllowJoinsOnColumnsWithDifferentNames = false,
        PreserveNulls = false
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

AnalyticsEngine

The analytics engine for the collaboration.
CreatorDisplayName

A display name of the collaboration creator.
CreatorMemberAbilities

The abilities granted to the collaboration creator.
CreatorMlMemberAbilities

The ML member abilities for a collaboration member.
CreatorPaymentConfiguration

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

The settings for client-side encryption for cryptographic computing.
Description

A description of the collaboration provided by the collaboration owner.
Members

A list of initial members, not including the creator.
Name

A human-readable identifier provided by the collaboration owner.
QueryLogStatus

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

An optional label that you can assign to a resource when you create it.

Properties

AnalyticsEngine

The analytics engine for the collaboration.

virtual string AnalyticsEngine { get; }
Property Value

System.String

Remarks

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

CreatorDisplayName

A display name of the collaboration creator.

string CreatorDisplayName { get; }
Property Value

System.String

Remarks

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

CreatorMemberAbilities

The abilities granted to the collaboration creator.

string[] CreatorMemberAbilities { get; }
Property Value

System.String[]

Remarks

Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS

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

CreatorMlMemberAbilities

The ML member abilities for a collaboration member.

virtual object CreatorMlMemberAbilities { get; }
Property Value

System.Object

Remarks

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

CreatorPaymentConfiguration

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

virtual object CreatorPaymentConfiguration { get; }
Property Value

System.Object

Remarks

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

DataEncryptionMetadata

The settings for client-side encryption for cryptographic computing.

virtual object DataEncryptionMetadata { get; }
Property Value

System.Object

Remarks

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.

string Description { get; }
Property Value

System.String

Remarks

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

Members

A list of initial members, not including the creator.

object Members { get; }
Property Value

System.Object

Remarks

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.

string Name { get; }
Property Value

System.String

Remarks

Display names are not unique.

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

QueryLogStatus

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

string QueryLogStatus { get; }
Property Value

System.String

Remarks

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.

virtual ICfnTag[] Tags { get; }
Property Value

ICfnTag[]

Remarks

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