Package software.amazon.awscdk.services.cleanrooms

Class CfnCollaboration

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.CfnCollaboration
All Implemented Interfaces:
IInspectable, ICollaborationRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:15.849Z") @Stability(Stable) public class CfnCollaboration extends CfnResource implements IInspectable, ICollaborationRef, ITaggableV2
Creates a new 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.*;
 CfnCollaboration cfnCollaboration = CfnCollaboration.Builder.create(this, "MyCfnCollaboration")
         .creatorDisplayName("creatorDisplayName")
         .description("description")
         .name("name")
         .queryLogStatus("queryLogStatus")
         // the properties below are optional
         .allowedResultRegions(List.of("allowedResultRegions"))
         .analyticsEngine("analyticsEngine")
         .autoApprovedChangeTypes(List.of("autoApprovedChangeTypes"))
         .creatorMemberAbilities(List.of("creatorMemberAbilities"))
         .creatorMlMemberAbilities(MLMemberAbilitiesProperty.builder()
                 .customMlMemberAbilities(List.of("customMlMemberAbilities"))
                 .build())
         .creatorPaymentConfiguration(PaymentConfigurationProperty.builder()
                 .queryCompute(QueryComputePaymentConfigProperty.builder()
                         .isResponsible(false)
                         .build())
                 // the properties below are optional
                 .jobCompute(JobComputePaymentConfigProperty.builder()
                         .isResponsible(false)
                         .build())
                 .machineLearning(MLPaymentConfigProperty.builder()
                         .modelInference(ModelInferencePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .modelTraining(ModelTrainingPaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .build())
                 .build())
         .dataEncryptionMetadata(DataEncryptionMetadataProperty.builder()
                 .allowCleartext(false)
                 .allowDuplicates(false)
                 .allowJoinsOnColumnsWithDifferentNames(false)
                 .preserveNulls(false)
                 .build())
         .jobLogStatus("jobLogStatus")
         .members(List.of(MemberSpecificationProperty.builder()
                 .accountId("accountId")
                 .displayName("displayName")
                 // the properties below are optional
                 .memberAbilities(List.of("memberAbilities"))
                 .mlMemberAbilities(MLMemberAbilitiesProperty.builder()
                         .customMlMemberAbilities(List.of("customMlMemberAbilities"))
                         .build())
                 .paymentConfiguration(PaymentConfigurationProperty.builder()
                         .queryCompute(QueryComputePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         // the properties below are optional
                         .jobCompute(JobComputePaymentConfigProperty.builder()
                                 .isResponsible(false)
                                 .build())
                         .machineLearning(MLPaymentConfigProperty.builder()
                                 .modelInference(ModelInferencePaymentConfigProperty.builder()
                                         .isResponsible(false)
                                         .build())
                                 .modelTraining(ModelTrainingPaymentConfigProperty.builder()
                                         .isResponsible(false)
                                         .build())
                                 .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

    • CfnCollaboration

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

    • CfnCollaboration

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

    • CfnCollaboration

      @Stability(Stable) public CfnCollaboration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCollaborationProps props)
      Create a new AWS::CleanRooms::Collaboration.

      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

    • arnForCollaboration

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

    • isCfnCollaboration

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

      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 collaboration.

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

    • getAttrCollaborationIdentifier

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

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

    • 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

    • getCollaborationRef

      @Stability(Stable) @NotNull public CollaborationReference getCollaborationRef()
      A reference to a Collaboration resource.
      Specified by:
      getCollaborationRef in interface ICollaborationRef

    • getCreatorDisplayName

      @Stability(Stable) @NotNull public String getCreatorDisplayName()
      A display name of the collaboration creator.

    • setCreatorDisplayName

      @Stability(Stable) public void setCreatorDisplayName(@NotNull String value)
      A display name of the collaboration creator.

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      A description of the collaboration provided by the collaboration owner.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      A description of the collaboration provided by the collaboration owner.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A human-readable identifier provided by the collaboration owner.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A human-readable identifier provided by the collaboration owner.

    • getQueryLogStatus

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

    • setQueryLogStatus

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

    • getAllowedResultRegions

      @Stability(Stable) @Nullable public List<String> getAllowedResultRegions()
      The AWS Regions where collaboration query results can be stored.

    • setAllowedResultRegions

      @Stability(Stable) public void setAllowedResultRegions(@Nullable List<String> value)
      The AWS Regions where collaboration query results can be stored.

    • getAnalyticsEngine

      @Stability(Stable) @Nullable public String getAnalyticsEngine()
      The analytics engine for the collaboration.

    • setAnalyticsEngine

      @Stability(Stable) public void setAnalyticsEngine(@Nullable String value)
      The analytics engine for the collaboration.

    • getAutoApprovedChangeTypes

      @Stability(Stable) @Nullable public List<String> getAutoApprovedChangeTypes()
      The types of change requests that are automatically approved for this collaboration.

    • setAutoApprovedChangeTypes

      @Stability(Stable) public void setAutoApprovedChangeTypes(@Nullable List<String> value)
      The types of change requests that are automatically approved for this collaboration.

    • getCreatorMemberAbilities

      @Stability(Stable) @Nullable public List<String> getCreatorMemberAbilities()
      The abilities granted to the collaboration creator.

    • setCreatorMemberAbilities

      @Stability(Stable) public void setCreatorMemberAbilities(@Nullable List<String> value)
      The abilities granted to the collaboration creator.

    • getCreatorMlMemberAbilities

      @Stability(Stable) @Nullable public Object getCreatorMlMemberAbilities()
      The ML member abilities for a collaboration member.

      Returns union: either IResolvable or CfnCollaboration.MLMemberAbilitiesProperty

    • setCreatorMlMemberAbilities

      @Stability(Stable) public void setCreatorMlMemberAbilities(@Nullable IResolvable value)
      The ML member abilities for a collaboration member.

    • setCreatorMlMemberAbilities

      @Stability(Stable) public void setCreatorMlMemberAbilities(@Nullable CfnCollaboration.MLMemberAbilitiesProperty value)
      The ML member abilities for a collaboration member.

    • getCreatorPaymentConfiguration

      @Stability(Stable) @Nullable public Object getCreatorPaymentConfiguration()
      An object representing the collaboration member's payment responsibilities set by the collaboration creator.

      Returns union: either IResolvable or CfnCollaboration.PaymentConfigurationProperty

    • setCreatorPaymentConfiguration

      @Stability(Stable) public void setCreatorPaymentConfiguration(@Nullable IResolvable value)
      An object representing the collaboration member's payment responsibilities set by the collaboration creator.

    • setCreatorPaymentConfiguration

      @Stability(Stable) public void setCreatorPaymentConfiguration(@Nullable CfnCollaboration.PaymentConfigurationProperty value)
      An object representing the collaboration member's payment responsibilities set by the collaboration creator.

    • getDataEncryptionMetadata

      @Stability(Stable) @Nullable public Object getDataEncryptionMetadata()
      The settings for client-side encryption for cryptographic computing.

      Returns union: either IResolvable or CfnCollaboration.DataEncryptionMetadataProperty

    • setDataEncryptionMetadata

      @Stability(Stable) public void setDataEncryptionMetadata(@Nullable IResolvable value)
      The settings for client-side encryption for cryptographic computing.

    • setDataEncryptionMetadata

      @Stability(Stable) public void setDataEncryptionMetadata(@Nullable CfnCollaboration.DataEncryptionMetadataProperty value)
      The settings for client-side encryption for cryptographic computing.

    • 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.

    • getMembers

      @Stability(Stable) @Nullable public Object getMembers()
      A list of initial members, not including the creator.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCollaboration.MemberSpecificationProperty>

    • setMembers

      @Stability(Stable) public void setMembers(@Nullable IResolvable value)
      A list of initial members, not including the creator.

    • setMembers

      @Stability(Stable) public void setMembers(@Nullable List<Object> value)
      A list of initial members, not including the creator.

    • 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.