Package com.pulumi.aws.cleanrooms

Class Membership

  • public class Membership
extends com.pulumi.resources.CustomResource
    Provides a AWS Clean Rooms membership. Memberships are used to join a Clean Rooms collaboration by the invited member. ## Example Usage ### Membership with tags 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cleanrooms.Membership;
 import com.pulumi.aws.cleanrooms.MembershipArgs;
 import com.pulumi.aws.cleanrooms.inputs.MembershipDefaultResultConfigurationArgs;
 import com.pulumi.aws.cleanrooms.inputs.MembershipDefaultResultConfigurationOutputConfigurationArgs;
 import com.pulumi.aws.cleanrooms.inputs.MembershipDefaultResultConfigurationOutputConfigurationS3Args;
 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 testMembership = new Membership("testMembership", MembershipArgs.builder()
             .defaultResultConfiguration(MembershipDefaultResultConfigurationArgs.builder()
                 .outputConfiguration(MembershipDefaultResultConfigurationOutputConfigurationArgs.builder()
                     .s3(MembershipDefaultResultConfigurationOutputConfigurationS3Args.builder()
                         .bucket("test-bucket")
                         .resultFormat("PARQUET")
                         .keyPrefix("test-prefix")
                         .build())
                     .build())
                 .roleArn("arn:aws:iam::123456789012:role/role-name")
                 .build())
             .collaborationId("1234abcd-12ab-34cd-56ef-1234567890ab")
             .queryLogStatus("DISABLED")
             .tags(Map.of("Project", "Terraform"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` - (String) ID of the membership. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import `aws.cleanrooms.Membership` using the `id`. For example: ```sh $ pulumi import aws:cleanrooms/membership:Membership membership 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.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> collaborationArn()  
      com.pulumi.core.Output<java.lang.String> collaborationCreatorAccountId()  
      com.pulumi.core.Output<java.lang.String> collaborationCreatorDisplayName()  
      com.pulumi.core.Output<java.lang.String> collaborationId()  
      com.pulumi.core.Output<java.lang.String> collaborationName()  
      com.pulumi.core.Output<java.lang.String> createTime()  
      com.pulumi.core.Output<java.util.Optional<MembershipDefaultResultConfiguration>> defaultResultConfiguration()  
      static Membership get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, MembershipState 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.List<java.lang.String>> memberAbilities()  
      com.pulumi.core.Output<java.util.Optional<MembershipPaymentConfiguration>> paymentConfiguration()  
      com.pulumi.core.Output<java.lang.String> queryLogStatus()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> status()  
      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

      • Membership

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

      • Membership

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

      • Membership

        public Membership​(java.lang.String name,
                  MembershipArgs 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

      • arn

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

      • collaborationArn

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

      • collaborationCreatorAccountId

        public com.pulumi.core.Output<java.lang.String> collaborationCreatorAccountId()
        Returns:
        The account ID of the collaboration's creator.

      • collaborationCreatorDisplayName

        public com.pulumi.core.Output<java.lang.String> collaborationCreatorDisplayName()
        Returns:
        The display name of the collaboration's creator.

      • collaborationId

        public com.pulumi.core.Output<java.lang.String> collaborationId()
        Returns:
        The ID of the collaboration to which the member was invited.

      • collaborationName

        public com.pulumi.core.Output<java.lang.String> collaborationName()
        Returns:
        The name of the joined collaboration.

      • createTime

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

      • defaultResultConfiguration

        public com.pulumi.core.Output<java.util.Optional<MembershipDefaultResultConfiguration>> defaultResultConfiguration()
        Returns:
        The default configuration for a query result.

      • memberAbilities

        public com.pulumi.core.Output<java.util.List<java.lang.String>> memberAbilities()
        Returns:
        The list of abilities for the invited member.

      • queryLogStatus

        public com.pulumi.core.Output<java.lang.String> queryLogStatus()
        Returns:
        An indicator as to whether query logging has been enabled or disabled for the membership.

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

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        The status of the membership.

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

      • 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:
        The date and time the membership was last updated.

      • get

        public static Membership get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             MembershipState 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.