interface CfnMembershipProps

Language	Type name
.NET	`Amazon.CDK.AWS.CleanRooms.CfnMembershipProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnMembershipProps`
Java	`software.amazon.awscdk.services.cleanrooms.CfnMembershipProps`
Python	`aws_cdk.aws_cleanrooms.CfnMembershipProps`
TypeScript	`aws-cdk-lib` » `aws_cleanrooms` » `CfnMembershipProps`

Properties for defining a CfnMembership.

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 cfnMembershipProps: cleanrooms.CfnMembershipProps = {
  collaborationIdentifier: 'collaborationIdentifier',
  queryLogStatus: 'queryLogStatus',

  // the properties below are optional
  defaultJobResultConfiguration: {
    outputConfiguration: {
      s3: {
        bucket: 'bucket',

        // the properties below are optional
        keyPrefix: 'keyPrefix',
      },
    },
    roleArn: 'roleArn',
  },
  defaultResultConfiguration: {
    outputConfiguration: {
      s3: {
        bucket: 'bucket',
        resultFormat: 'resultFormat',

        // the properties below are optional
        keyPrefix: 'keyPrefix',
        singleFileOutput: false,
      },
    },

    // the properties below are optional
    roleArn: 'roleArn',
  },
  jobLogStatus: 'jobLogStatus',
  paymentConfiguration: {
    queryCompute: {
      isResponsible: false,
    },

    // the properties below are optional
    jobCompute: {
      isResponsible: false,
    },
    machineLearning: {
      modelInference: {
        isResponsible: false,
      },
      modelTraining: {
        isResponsible: false,
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
collaborationIdentifier	`string`	The unique ID for the associated collaboration.
queryLogStatus	`string`	An indicator as to whether query logging has been enabled or disabled for the membership.
defaultJobResultConfiguration?	`IResolvable` `\|` `MembershipProtectedJobResultConfigurationProperty`	The default job result configuration for the membership.
defaultResultConfiguration?	`IResolvable` `\|` `MembershipProtectedQueryResultConfigurationProperty`	The default protected query result configuration as specified by the member who can receive results.
jobLogStatus?	`string`	An indicator as to whether job logging has been enabled or disabled for the collaboration.
paymentConfiguration?	`IResolvable` `\|` `MembershipPaymentConfigurationProperty`	The payment responsibilities accepted by the collaboration member.
tags?	`CfnTag[]`	An optional label that you can assign to a resource when you create it.

collaborationIdentifier

Type: string

The unique ID for the associated collaboration.

queryLogStatus

Type: string

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

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 .

defaultJobResultConfiguration?

Type: IResolvable | MembershipProtectedJobResultConfigurationProperty (optional)

The default job result configuration for the membership.

defaultResultConfiguration?

Type: IResolvable | MembershipProtectedQueryResultConfigurationProperty (optional)

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

jobLogStatus?

Type: string (optional)

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

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 .

paymentConfiguration?

Type: IResolvable | MembershipPaymentConfigurationProperty (optional)

The payment responsibilities accepted by the collaboration member.

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.