Membership class

Provides a AWS Clean Rooms membership. Memberships are used to join a Clean Rooms collaboration by the invited member.

Example Usage

Membership with tags

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testMembership = new aws.cleanrooms.Membership("test_membership", {
    defaultResultConfiguration: {
        outputConfiguration: {
            s3: {
                bucket: "test-bucket",
                resultFormat: "PARQUET",
                keyPrefix: "test-prefix",
            },
        },
        roleArn: "arn:aws:iam::123456789012:role/role-name",
    },
    collaborationId: "1234abcd-12ab-34cd-56ef-1234567890ab",
    queryLogStatus: "DISABLED",
    tags: {
        Project: "Terraform",
    },
});
import pulumi
import pulumi_aws as aws

test_membership = aws.cleanrooms.Membership("test_membership",
    default_result_configuration={
        "output_configuration": {
            "s3": {
                "bucket": "test-bucket",
                "result_format": "PARQUET",
                "key_prefix": "test-prefix",
            },
        },
        "role_arn": "arn:aws:iam::123456789012:role/role-name",
    },
    collaboration_id="1234abcd-12ab-34cd-56ef-1234567890ab",
    query_log_status="DISABLED",
    tags={
        "Project": "Terraform",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var testMembership = new Aws.CleanRooms.Membership("test_membership", new()
    {
        DefaultResultConfiguration = new Aws.CleanRooms.Inputs.MembershipDefaultResultConfigurationArgs
        {
            OutputConfiguration = new Aws.CleanRooms.Inputs.MembershipDefaultResultConfigurationOutputConfigurationArgs
            {
                S3 = new Aws.CleanRooms.Inputs.MembershipDefaultResultConfigurationOutputConfigurationS3Args
                {
                    Bucket = "test-bucket",
                    ResultFormat = "PARQUET",
                    KeyPrefix = "test-prefix",
                },
            },
            RoleArn = "arn:aws:iam::123456789012:role/role-name",
        },
        CollaborationId = "1234abcd-12ab-34cd-56ef-1234567890ab",
        QueryLogStatus = "DISABLED",
        Tags =
        {
            { "Project", "Terraform" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cleanrooms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cleanrooms.NewMembership(ctx, "test_membership", &cleanrooms.MembershipArgs{
			DefaultResultConfiguration: &cleanrooms.MembershipDefaultResultConfigurationArgs{
				OutputConfiguration: &cleanrooms.MembershipDefaultResultConfigurationOutputConfigurationArgs{
					S3: &cleanrooms.MembershipDefaultResultConfigurationOutputConfigurationS3Args{
						Bucket:       pulumi.String("test-bucket"),
						ResultFormat: pulumi.String("PARQUET"),
						KeyPrefix:    pulumi.String("test-prefix"),
					},
				},
				RoleArn: pulumi.String("arn:aws:iam::123456789012:role/role-name"),
			},
			CollaborationId: pulumi.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
			QueryLogStatus:  pulumi.String("DISABLED"),
			Tags: pulumi.StringMap{
				"Project": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cleanrooms_membership" "test_membership" {
  default_result_configuration = {
    output_configuration = {
      s3 = {
        bucket        = "test-bucket"
        result_format = "PARQUET"
        key_prefix    = "test-prefix"
      }
    }
    role_arn = "arn:aws:iam::123456789012:role/role-name"
  }
  collaboration_id = "1234abcd-12ab-34cd-56ef-1234567890ab"
  query_log_status = "DISABLED"
  tags = {
    "Project" = "Terraform"
  }
}
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());

    }
}
resources:
  testMembership:
    type: aws:cleanrooms:Membership
    name: test_membership
    properties:
      defaultResultConfiguration:
        outputConfiguration:
          s3:
            bucket: test-bucket
            resultFormat: PARQUET
            keyPrefix: test-prefix
        roleArn: arn:aws:iam::123456789012:role/role-name
      collaborationId: 1234abcd-12ab-34cd-56ef-1234567890ab
      queryLogStatus: DISABLED
      tags:
        Project: Terraform

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:

$ pulumi import aws:cleanrooms/membership:Membership membership 1234abcd-12ab-34cd-56ef-1234567890ab

Constructors

Membership(String name, {MembershipArgs? args, CustomResourceOptions? options})
Creates a new Membership. name The Pulumi resource name. args Arguments used to configure this Membership. The set of arguments for Membership. options Resource options controlling this resource's behavior.
Membership.reference(String urn)
Creates a typed reference to an existing Membership resource.

Properties

arn ↔ Output<String>
The ARN of the membership.
latefinal
childResources → Set<Resource>
finalinherited
collaborationArn ↔ Output<String>
The ARN of the joined collaboration.
latefinal
collaborationCreatorAccountId ↔ Output<String>
The account ID of the collaboration's creator.
latefinal
collaborationCreatorDisplayName ↔ Output<String>
The display name of the collaboration's creator.
latefinal
collaborationId ↔ Output<String>
The ID of the collaboration to which the member was invited.
latefinal
collaborationName ↔ Output<String>
The name of the joined collaboration.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createTime ↔ Output<String>
The date and time the membership was created.
latefinal
defaultResultConfiguration ↔ Output<MembershipDefaultResultConfiguration?>
The default configuration for a query result.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
memberAbilities ↔ Output<List<String>>
The list of abilities for the invited member.
latefinal
paymentConfiguration ↔ Output<MembershipPaymentConfiguration?>
latefinal
queryLogStatus ↔ Output<String>
An indicator as to whether query logging has been enabled or disabled for the membership.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status ↔ Output<String>
The status of the membership.
latefinal
tags ↔ Output<Map<String, String>?>
Key value pairs which tag the membership.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>
The date and time the membership was last updated.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {MembershipState? state, CustomResourceOptions? options}) → Membership
Gets an existing Membership resource's state with the given name and id.