Class CfnCollaboration

Creates a new collaboration.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnCollaboration
Inherited Members
Namespace: Amazon.CDK.AwsCleanrooms
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCollaboration : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnCollaboration Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

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 cfnCollaboration = new CfnCollaboration(this, "MyCfnCollaboration", new CfnCollaborationProps {
                 CreatorDisplayName = "creatorDisplayName",
                 Description = "description",
                 Name = "name",
                 QueryLogStatus = "queryLogStatus",

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

                     // the properties below are optional
                     JobCompute = new JobComputePaymentConfigProperty {
                         IsResponsible = false
                     },
                     MachineLearning = new MLPaymentConfigProperty {
                         ModelInference = new ModelInferencePaymentConfigProperty {
                             IsResponsible = false
                         },
                         ModelTraining = new ModelTrainingPaymentConfigProperty {
                             IsResponsible = false
                         }
                     }
                 },
                 DataEncryptionMetadata = new DataEncryptionMetadataProperty {
                     AllowCleartext = false,
                     AllowDuplicates = false,
                     AllowJoinsOnColumnsWithDifferentNames = false,
                     PreserveNulls = false
                 },
                 JobLogStatus = "jobLogStatus",
                 Members = new [] { new MemberSpecificationProperty {
                     AccountId = "accountId",
                     DisplayName = "displayName",

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

                         // the properties below are optional
                         JobCompute = new JobComputePaymentConfigProperty {
                             IsResponsible = false
                         },
                         MachineLearning = new MLPaymentConfigProperty {
                             ModelInference = new ModelInferencePaymentConfigProperty {
                                 IsResponsible = false
                             },
                             ModelTraining = new ModelTrainingPaymentConfigProperty {
                                 IsResponsible = false
                             }
                         }
                     }
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnCollaboration(Construct, string, ICfnCollaborationProps)

Creates a new collaboration.

Properties

AnalyticsEngine

The analytics engine for the collaboration.
AttrArn

Returns the Amazon Resource Name (ARN) of the specified collaboration.
AttrCollaborationIdentifier

Returns the unique identifier of the specified collaboration.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Creates a new 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.
JobLogStatus

An indicator as to whether job logging has been enabled or disabled for the collaboration.
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Creates a new collaboration.

Constructors

CfnCollaboration(Construct, string, ICfnCollaborationProps)

Creates a new collaboration.

public CfnCollaboration(Construct scope, string id, ICfnCollaborationProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnCollaborationProps

Resource properties.

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

Properties

AnalyticsEngine

The analytics engine for the collaboration.

public virtual string? AnalyticsEngine { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

AttrArn

Returns the Amazon Resource Name (ARN) of the specified collaboration.

public virtual string AttrArn { get; }
Property Value

string

Remarks

Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

CloudformationAttribute: Arn

AttrCollaborationIdentifier

Returns the unique identifier of the specified collaboration.

public virtual string AttrCollaborationIdentifier { get; }
Property Value

string

Remarks

Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

CloudformationAttribute: CollaborationIdentifier

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new collaboration.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

CreatorDisplayName

A display name of the collaboration creator.

public virtual string CreatorDisplayName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

CreatorMemberAbilities

The abilities granted to the collaboration creator.

public virtual string[]? CreatorMemberAbilities { get; set; }
Property Value

string[]

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

CreatorMlMemberAbilities

The ML member abilities for a collaboration member.

public virtual object? CreatorMlMemberAbilities { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

CreatorPaymentConfiguration

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

public virtual object? CreatorPaymentConfiguration { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

DataEncryptionMetadata

The settings for client-side encryption for cryptographic computing.

public virtual object? DataEncryptionMetadata { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

Description

A description of the collaboration provided by the collaboration owner.

public virtual string Description { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

JobLogStatus

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

public virtual string? JobLogStatus { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

Members

A list of initial members, not including the creator.

public virtual object? Members { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

Name

A human-readable identifier provided by the collaboration owner.

public virtual string Name { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

QueryLogStatus

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

public virtual string QueryLogStatus { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

Tags

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

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new collaboration.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::CleanRooms::Collaboration

ExampleMetadata: fixture=_generated

Implements