Class CfnMembership

Creates a membership for a specific collaboration identifier and joins the collaboration.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnMembership
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.CleanRooms
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMembership : CfnResource, IInspectable, IMembershipRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnMembership Inherits CfnResource Implements IInspectable, IMembershipRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

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

CloudformationResource: AWS::CleanRooms::Membership

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 cfnMembership = new CfnMembership(this, "MyCfnMembership", 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

Constructors

CfnMembership(Construct, string, ICfnMembershipProps)

Create a new AWS::CleanRooms::Membership.

Properties

AttrArn

Returns the Amazon Resource Name (ARN) of the specified membership.
AttrCollaborationArn

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

Returns the unique identifier of the specified collaboration creator account.
AttrMembershipIdentifier

Returns the unique identifier of the specified membership.
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 membership for a specific collaboration identifier and joins the collaboration.
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.
MembershipRef

A reference to a Membership resource.
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.

Methods

ArnForMembership(IMembershipRef)

Creates a membership for a specific collaboration identifier and joins the collaboration.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnMembership(object)

Checks whether the given object is a CfnMembership.
RenderProperties(IDictionary<string, object>)

Creates a membership for a specific collaboration identifier and joins the collaboration.

Constructors

CfnMembership(Construct, string, ICfnMembershipProps)

Create a new AWS::CleanRooms::Membership.

public CfnMembership(Construct scope, string id, ICfnMembershipProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnMembershipProps

Resource properties.

Remarks

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

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

Properties

AttrArn

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

public virtual string AttrArn { get; }
Property Value

string

Remarks

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

CloudformationAttribute: Arn

AttrCollaborationArn

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

public virtual string AttrCollaborationArn { get; }
Property Value

string

Remarks

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

CloudformationAttribute: CollaborationArn

AttrCollaborationCreatorAccountId

Returns the unique identifier of the specified collaboration creator account.

public virtual string AttrCollaborationCreatorAccountId { get; }
Property Value

string

Remarks

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

CloudformationAttribute: CollaborationCreatorAccountId

AttrMembershipIdentifier

Returns the unique identifier of the specified membership.

public virtual string AttrMembershipIdentifier { get; }
Property Value

string

Remarks

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

CloudformationAttribute: MembershipIdentifier

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-membership.html

CloudformationResource: AWS::CleanRooms::Membership

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-membership.html

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

CfnProperties

Creates a membership for a specific collaboration identifier and joins the 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-membership.html

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

CollaborationIdentifier

The unique ID for the associated collaboration.

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

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

DefaultJobResultConfiguration

The default job result configuration for the membership.

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

object

Remarks

Type union: either IResolvable or CfnMembership.IMembershipProtectedJobResultConfigurationProperty

DefaultResultConfiguration

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

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

object

Remarks

Type union: either IResolvable or CfnMembership.IMembershipProtectedQueryResultConfigurationProperty

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-membership.html

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

MembershipRef

A reference to a Membership resource.

public virtual IMembershipReference MembershipRef { get; }
Property Value

IMembershipReference

Remarks

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

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

PaymentConfiguration

The payment responsibilities accepted by the collaboration member.

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

object

Remarks

Type union: either IResolvable or CfnMembership.IMembershipPaymentConfigurationProperty

QueryLogStatus

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

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

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Membership

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-membership.html

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

Methods

ArnForMembership(IMembershipRef)

Creates a membership for a specific collaboration identifier and joins the collaboration.

public static string ArnForMembership(IMembershipRef resource)
Parameters
resource IMembershipRef
Returns

string

Remarks

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

CloudformationResource: AWS::CleanRooms::Membership

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 cfnMembership = new CfnMembership(this, "MyCfnMembership", 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"
                 } }
             });

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-membership.html

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

IsCfnMembership(object)

Checks whether the given object is a CfnMembership.

public static bool IsCfnMembership(object x)
Parameters
x object
Returns

bool

Remarks

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

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a membership for a specific collaboration identifier and joins the 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-membership.html

CloudformationResource: AWS::CleanRooms::Membership

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable