Package software.amazon.awscdk.services.cleanrooms

Class CfnMembership

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cleanrooms.CfnMembership
All Implemented Interfaces:
IInspectable, IMembershipRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:08.375Z") @Stability(Stable) public class CfnMembership extends CfnResource implements IInspectable, IMembershipRef, ITaggableV2
Creates a membership for a specific collaboration identifier and joins the collaboration.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cleanrooms.*;
 CfnMembership cfnMembership = CfnMembership.Builder.create(this, "MyCfnMembership")
         .collaborationIdentifier("collaborationIdentifier")
         .queryLogStatus("queryLogStatus")
         // the properties below are optional
         .defaultJobResultConfiguration(MembershipProtectedJobResultConfigurationProperty.builder()
                 .outputConfiguration(MembershipProtectedJobOutputConfigurationProperty.builder()
                         .s3(ProtectedJobS3OutputConfigurationInputProperty.builder()
                                 .bucket("bucket")
                                 // the properties below are optional
                                 .keyPrefix("keyPrefix")
                                 .build())
                         .build())
                 .roleArn("roleArn")
                 .build())
         .defaultResultConfiguration(MembershipProtectedQueryResultConfigurationProperty.builder()
                 .outputConfiguration(MembershipProtectedQueryOutputConfigurationProperty.builder()
                         .s3(ProtectedQueryS3OutputConfigurationProperty.builder()
                                 .bucket("bucket")
                                 .resultFormat("resultFormat")
                                 // the properties below are optional
                                 .keyPrefix("keyPrefix")
                                 .singleFileOutput(false)
                                 .build())
                         .build())
                 // the properties below are optional
                 .roleArn("roleArn")
                 .build())
         .jobLogStatus("jobLogStatus")
         .paymentConfiguration(MembershipPaymentConfigurationProperty.builder()
                 .queryCompute(MembershipQueryComputePaymentConfigProperty.builder()
                         .isResponsible(false)
                         .build())
                 // the properties below are optional
                 .jobCompute(MembershipJobComputePaymentConfigProperty.builder()
                         .isResponsible(false)
                         .build())
                 .machineLearning(MembershipMLPaymentConfigProperty.builder()
                         .modelInference(MembershipModelInferencePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .modelTraining(MembershipModelTrainingPaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMembership

      protected CfnMembership(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMembership

      protected CfnMembership(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMembership

      @Stability(Stable) public CfnMembership(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMembershipProps props)
      Create a new AWS::CleanRooms::Membership.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForMembership

      @Stability(Stable) @NotNull public static String arnForMembership(@NotNull IMembershipRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnMembership

      @Stability(Stable) @NotNull public static Boolean isCfnMembership(@NotNull Object x)
      Checks whether the given object is a CfnMembership.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) of the specified membership.

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

    • getAttrCollaborationArn

      @Stability(Stable) @NotNull public String getAttrCollaborationArn()
      Returns the Amazon Resource Name (ARN) of the specified collaboration.

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

    • getAttrCollaborationCreatorAccountId

      @Stability(Stable) @NotNull public String getAttrCollaborationCreatorAccountId()
      Returns the unique identifier of the specified collaboration creator account.

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

    • getAttrMembershipIdentifier

      @Stability(Stable) @NotNull public String getAttrMembershipIdentifier()
      Returns the unique identifier of the specified membership.

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMembershipRef

      @Stability(Stable) @NotNull public MembershipReference getMembershipRef()
      A reference to a Membership resource.
      Specified by:
      getMembershipRef in interface IMembershipRef

    • getCollaborationIdentifier

      @Stability(Stable) @NotNull public String getCollaborationIdentifier()
      The unique ID for the associated collaboration.

    • setCollaborationIdentifier

      @Stability(Stable) public void setCollaborationIdentifier(@NotNull String value)
      The unique ID for the associated collaboration.

    • getQueryLogStatus

      @Stability(Stable) @NotNull public String getQueryLogStatus()
      An indicator as to whether query logging has been enabled or disabled for the membership.

    • setQueryLogStatus

      @Stability(Stable) public void setQueryLogStatus(@NotNull String value)
      An indicator as to whether query logging has been enabled or disabled for the membership.

    • getDefaultJobResultConfiguration

      @Stability(Stable) @Nullable public Object getDefaultJobResultConfiguration()
      The default job result configuration for the membership.

      Returns union: either IResolvable or CfnMembership.MembershipProtectedJobResultConfigurationProperty

    • setDefaultJobResultConfiguration

      @Stability(Stable) public void setDefaultJobResultConfiguration(@Nullable IResolvable value)
      The default job result configuration for the membership.

    • setDefaultJobResultConfiguration

      @Stability(Stable) public void setDefaultJobResultConfiguration(@Nullable CfnMembership.MembershipProtectedJobResultConfigurationProperty value)
      The default job result configuration for the membership.

    • getDefaultResultConfiguration

      @Stability(Stable) @Nullable public Object getDefaultResultConfiguration()
      The default protected query result configuration as specified by the member who can receive results.

      Returns union: either IResolvable or CfnMembership.MembershipProtectedQueryResultConfigurationProperty

    • setDefaultResultConfiguration

      @Stability(Stable) public void setDefaultResultConfiguration(@Nullable IResolvable value)
      The default protected query result configuration as specified by the member who can receive results.

    • setDefaultResultConfiguration

      @Stability(Stable) public void setDefaultResultConfiguration(@Nullable CfnMembership.MembershipProtectedQueryResultConfigurationProperty value)
      The default protected query result configuration as specified by the member who can receive results.

    • getJobLogStatus

      @Stability(Stable) @Nullable public String getJobLogStatus()
      An indicator as to whether job logging has been enabled or disabled for the collaboration.

    • setJobLogStatus

      @Stability(Stable) public void setJobLogStatus(@Nullable String value)
      An indicator as to whether job logging has been enabled or disabled for the collaboration.

    • getPaymentConfiguration

      @Stability(Stable) @Nullable public Object getPaymentConfiguration()
      The payment responsibilities accepted by the collaboration member.

      Returns union: either IResolvable or CfnMembership.MembershipPaymentConfigurationProperty

    • setPaymentConfiguration

      @Stability(Stable) public void setPaymentConfiguration(@Nullable IResolvable value)
      The payment responsibilities accepted by the collaboration member.

    • setPaymentConfiguration

      @Stability(Stable) public void setPaymentConfiguration(@Nullable CfnMembership.MembershipPaymentConfigurationProperty value)
      The payment responsibilities accepted by the collaboration member.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An optional label that you can assign to a resource when you create it.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An optional label that you can assign to a resource when you create it.