Package com.pulumi.aws.cleanrooms

Class Collaboration

  • public class Collaboration
extends com.pulumi.resources.CustomResource
    Provides a AWS Clean Rooms collaboration. All members included in the definition will be invited to join the collaboration and can create memberships. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cleanrooms.Collaboration;
 import com.pulumi.aws.cleanrooms.CollaborationArgs;
 import com.pulumi.aws.cleanrooms.inputs.CollaborationDataEncryptionMetadataArgs;
 import com.pulumi.aws.cleanrooms.inputs.CollaborationMemberArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var testCollaboration = new Collaboration("testCollaboration", CollaborationArgs.builder()
             .dataEncryptionMetadata(CollaborationDataEncryptionMetadataArgs.builder()
                 .allowClearText(true)
                 .allowDuplicates(true)
                 .allowJoinsOnColumnsWithDifferentNames(true)
                 .preserveNulls(false)
                 .build())
             .members(CollaborationMemberArgs.builder()
                 .accountId("123456789012")
                 .displayName("Other member")
                 .memberAbilities()
                 .build())
             .name("pulumi-example-collaboration")
             .creatorMemberAbilities(            
                 "CAN_QUERY",
                 "CAN_RECEIVE_RESULTS")
             .creatorDisplayName("Creator ")
             .description("I made this collaboration with Pulumi!")
             .queryLogStatus("DISABLED")
             .analyticsEngine("SPARK")
             .tags(Map.of("Project", "Pulumi"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` - (String) ID of the cleanrooms collaboration. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import `aws.cleanrooms.Collaboration` using the `id`. For example: ```sh $ pulumi import aws:cleanrooms/collaboration:Collaboration collaboration 1234abcd-12ab-34cd-56ef-1234567890ab ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> analyticsEngine()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createTime()  
      com.pulumi.core.Output<java.lang.String> creatorDisplayName()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> creatorMemberAbilities()  
      com.pulumi.core.Output<java.util.Optional<CollaborationDataEncryptionMetadata>> dataEncryptionMetadata()  
      com.pulumi.core.Output<java.lang.String> description()  
      static Collaboration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CollaborationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.List<CollaborationMember>>> members()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> queryLogStatus()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> updateTime()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Collaboration

        public Collaboration​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Collaboration

        public Collaboration​(java.lang.String name,
                     CollaborationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Collaboration

        public Collaboration​(java.lang.String name,
                     CollaborationArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • analyticsEngine

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> analyticsEngine()
        Returns:
        Analytics engine used by the collaboration. Valid values are `CLEAN_ROOMS_SQL` (deprecated) and `SPARK`.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the collaboration.

      • createTime

        public com.pulumi.core.Output<java.lang.String> createTime()
        Returns:
        Date and time the collaboration was created.

      • creatorDisplayName

        public com.pulumi.core.Output<java.lang.String> creatorDisplayName()
        Returns:
        Name for the member record for the collaboration creator.

      • creatorMemberAbilities

        public com.pulumi.core.Output<java.util.List<java.lang.String>> creatorMemberAbilities()
        Returns:
        List of member abilities for the creator of the collaboration. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-creatorMemberAbilities).

      • dataEncryptionMetadata

        public com.pulumi.core.Output<java.util.Optional<CollaborationDataEncryptionMetadata>> dataEncryptionMetadata()
        Returns:
        Collection of settings which determine how the [c3r client](https://docs.aws.amazon.com/clean-rooms/latest/userguide/crypto-computing.html) will encrypt data for use within this collaboration. See below.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        Description for a collaboration.

      • members

        public com.pulumi.core.Output<java.util.Optional<java.util.List<CollaborationMember>>> members()
        Returns:
        Additional members of the collaboration which will be invited to join the collaboration. See below.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the collaboration. Collaboration names do not need to be unique.

      • queryLogStatus

        public com.pulumi.core.Output<java.lang.String> queryLogStatus()
        Returns:
        Whether members of the collaboration can enable query logs within their own memberships. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-queryLogStatus). The following arguments are optional:

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key value pairs which tag the collaboration.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()

      • updateTime

        public com.pulumi.core.Output<java.lang.String> updateTime()
        Returns:
        Date and time the collaboration was last updated.

      • get

        public static Collaboration get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                CollaborationState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.