Interface ICfnMembershipProps

Properties for defining a CfnMembership.

Namespace: Amazon.CDK.AwsCleanrooms

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnMembershipProps

Syntax (vb)

Public Interface ICfnMembershipProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.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 cfnMembershipProps = new CfnMembershipProps {
                 CollaborationIdentifier = "collaborationIdentifier",
                 QueryLogStatus = "queryLogStatus",

                 // the properties below are optional
                 DefaultJobResultConfiguration = new MembershipProtectedJobResultConfigurationProperty {
                     OutputConfiguration = new MembershipProtectedJobOutputConfigurationProperty {
                         S3 = new ProtectedJobS3OutputConfigurationInputProperty {
                             Bucket = "bucket",

                             // the properties below are optional
                             KeyPrefix = "keyPrefix"
                         }
                     },
                     RoleArn = "roleArn"
                 },
                 DefaultResultConfiguration = new MembershipProtectedQueryResultConfigurationProperty {
                     OutputConfiguration = new MembershipProtectedQueryOutputConfigurationProperty {
                         S3 = new ProtectedQueryS3OutputConfigurationProperty {
                             Bucket = "bucket",
                             ResultFormat = "resultFormat",

                             // the properties below are optional
                             KeyPrefix = "keyPrefix",
                             SingleFileOutput = false
                         }
                     },

                     // the properties below are optional
                     RoleArn = "roleArn"
                 },
                 JobLogStatus = "jobLogStatus",
                 PaymentConfiguration = new MembershipPaymentConfigurationProperty {
                     QueryCompute = new MembershipQueryComputePaymentConfigProperty {
                         IsResponsible = false
                     },

                     // the properties below are optional
                     JobCompute = new MembershipJobComputePaymentConfigProperty {
                         IsResponsible = false
                     },
                     MachineLearning = new MembershipMLPaymentConfigProperty {
                         ModelInference = new MembershipModelInferencePaymentConfigProperty {
                             IsResponsible = false
                         },
                         ModelTraining = new MembershipModelTrainingPaymentConfigProperty {
                             IsResponsible = false
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

CollaborationIdentifier	The unique ID for the associated collaboration.
DefaultJobResultConfiguration	The default job result configuration for the membership.
DefaultResultConfiguration	The default protected query result configuration as specified by the member who can receive results.
JobLogStatus	An indicator as to whether job logging has been enabled or disabled for the collaboration.
PaymentConfiguration	The payment responsibilities accepted by the collaboration member.
QueryLogStatus	An indicator as to whether query logging has been enabled or disabled for the membership.
Tags	An optional label that you can assign to a resource when you create it.

Properties

CollaborationIdentifier

The unique ID for the associated collaboration.

string CollaborationIdentifier { get; }

Property Value

string

Remarks

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

DefaultJobResultConfiguration

The default job result configuration for the membership.

object? DefaultJobResultConfiguration { get; }

Property Value

object

Remarks

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

DefaultResultConfiguration

The default protected query result configuration as specified by the member who can receive results.

object? DefaultResultConfiguration { get; }

Property Value

object

Remarks

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

JobLogStatus

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

string? JobLogStatus { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-joblogstatus

PaymentConfiguration

The payment responsibilities accepted by the collaboration member.

object? PaymentConfiguration { get; }

Property Value

object

Remarks

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

QueryLogStatus

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

string QueryLogStatus { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-querylogstatus

Tags

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

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-membership.html#cfn-cleanrooms-membership-tags