Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cleanrooms
  5. Collaboration
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.cleanrooms.Collaboration

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    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

    Collaboration with tags

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

const testCollaboration = new aws.cleanrooms.Collaboration("test_collaboration", {
    name: "pulumi-example-collaboration",
    creatorMemberAbilities: [
        "CAN_QUERY",
        "CAN_RECEIVE_RESULTS",
    ],
    creatorDisplayName: "Creator ",
    description: "I made this collaboration with Pulumi!",
    queryLogStatus: "DISABLED",
    dataEncryptionMetadata: {
        allowClearText: true,
        allowDuplicates: true,
        allowJoinsOnColumnsWithDifferentNames: true,
        preserveNulls: false,
    },
    members: [{
        accountId: "123456789012",
        displayName: "Other member",
        memberAbilities: [],
    }],
    tags: {
        Project: "Pulumi",
    },
});

    import pulumi
import pulumi_aws as aws

test_collaboration = aws.cleanrooms.Collaboration("test_collaboration",
    name="pulumi-example-collaboration",
    creator_member_abilities=[
        "CAN_QUERY",
        "CAN_RECEIVE_RESULTS",
    ],
    creator_display_name="Creator ",
    description="I made this collaboration with Pulumi!",
    query_log_status="DISABLED",
    data_encryption_metadata={
        "allow_clear_text": True,
        "allow_duplicates": True,
        "allow_joins_on_columns_with_different_names": True,
        "preserve_nulls": False,
    },
    members=[{
        "account_id": "123456789012",
        "display_name": "Other member",
        "member_abilities": [],
    }],
    tags={
        "Project": "Pulumi",
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cleanrooms.NewCollaboration(ctx, "test_collaboration", &cleanrooms.CollaborationArgs{
			Name: pulumi.String("pulumi-example-collaboration"),
			CreatorMemberAbilities: pulumi.StringArray{
				pulumi.String("CAN_QUERY"),
				pulumi.String("CAN_RECEIVE_RESULTS"),
			},
			CreatorDisplayName: pulumi.String("Creator "),
			Description:        pulumi.String("I made this collaboration with Pulumi!"),
			QueryLogStatus:     pulumi.String("DISABLED"),
			DataEncryptionMetadata: &cleanrooms.CollaborationDataEncryptionMetadataArgs{
				AllowClearText:                        pulumi.Bool(true),
				AllowDuplicates:                       pulumi.Bool(true),
				AllowJoinsOnColumnsWithDifferentNames: pulumi.Bool(true),
				PreserveNulls:                         pulumi.Bool(false),
			},
			Members: cleanrooms.CollaborationMemberArray{
				&cleanrooms.CollaborationMemberArgs{
					AccountId:       pulumi.String("123456789012"),
					DisplayName:     pulumi.String("Other member"),
					MemberAbilities: pulumi.StringArray{},
				},
			},
			Tags: pulumi.StringMap{
				"Project": pulumi.String("Pulumi"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testCollaboration = new Aws.CleanRooms.Collaboration("test_collaboration", new()
    {
        Name = "pulumi-example-collaboration",
        CreatorMemberAbilities = new[]
        {
            "CAN_QUERY",
            "CAN_RECEIVE_RESULTS",
        },
        CreatorDisplayName = "Creator ",
        Description = "I made this collaboration with Pulumi!",
        QueryLogStatus = "DISABLED",
        DataEncryptionMetadata = new Aws.CleanRooms.Inputs.CollaborationDataEncryptionMetadataArgs
        {
            AllowClearText = true,
            AllowDuplicates = true,
            AllowJoinsOnColumnsWithDifferentNames = true,
            PreserveNulls = false,
        },
        Members = new[]
        {
            new Aws.CleanRooms.Inputs.CollaborationMemberArgs
            {
                AccountId = "123456789012",
                DisplayName = "Other member",
                MemberAbilities = new() { },
            },
        },
        Tags = 
        {
            { "Project", "Pulumi" },
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .name("pulumi-example-collaboration")
            .creatorMemberAbilities(            
                "CAN_QUERY",
                "CAN_RECEIVE_RESULTS")
            .creatorDisplayName("Creator ")
            .description("I made this collaboration with Pulumi!")
            .queryLogStatus("DISABLED")
            .dataEncryptionMetadata(CollaborationDataEncryptionMetadataArgs.builder()
                .allowClearText(true)
                .allowDuplicates(true)
                .allowJoinsOnColumnsWithDifferentNames(true)
                .preserveNulls(false)
                .build())
            .members(CollaborationMemberArgs.builder()
                .accountId(123456789012)
                .displayName("Other member")
                .memberAbilities()
                .build())
            .tags(Map.of("Project", "Pulumi"))
            .build());

    }
}

    resources:
  testCollaboration:
    type: aws:cleanrooms:Collaboration
    name: test_collaboration
    properties:
      name: pulumi-example-collaboration
      creatorMemberAbilities:
        - CAN_QUERY
        - CAN_RECEIVE_RESULTS
      creatorDisplayName: 'Creator '
      description: I made this collaboration with Pulumi!
      queryLogStatus: DISABLED
      dataEncryptionMetadata:
        allowClearText: true
        allowDuplicates: true
        allowJoinsOnColumnsWithDifferentNames: true
        preserveNulls: false
      members:
        - accountId: 1.23456789012e+11
          displayName: Other member
          memberAbilities: []
      tags:
        Project: Pulumi

    Create Collaboration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Collaboration(name: string, args: CollaborationArgs, opts?: CustomResourceOptions);
    @overload
def Collaboration(resource_name: str,
                  args: CollaborationArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def Collaboration(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  creator_display_name: Optional[str] = None,
                  creator_member_abilities: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  query_log_status: Optional[str] = None,
                  data_encryption_metadata: Optional[CollaborationDataEncryptionMetadataArgs] = None,
                  members: Optional[Sequence[CollaborationMemberArgs]] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewCollaboration(ctx *Context, name string, args CollaborationArgs, opts ...ResourceOption) (*Collaboration, error)
    public Collaboration(string name, CollaborationArgs args, CustomResourceOptions? opts = null)
    public Collaboration(String name, CollaborationArgs args)
public Collaboration(String name, CollaborationArgs args, CustomResourceOptions options)

    type: aws:cleanrooms:Collaboration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CollaborationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CollaborationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CollaborationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollaborationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollaborationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var collaborationResource = new Aws.CleanRooms.Collaboration("collaborationResource", new()
{
    CreatorDisplayName = "string",
    CreatorMemberAbilities = new[]
    {
        "string",
    },
    Description = "string",
    QueryLogStatus = "string",
    DataEncryptionMetadata = new Aws.CleanRooms.Inputs.CollaborationDataEncryptionMetadataArgs
    {
        AllowClearText = false,
        AllowDuplicates = false,
        AllowJoinsOnColumnsWithDifferentNames = false,
        PreserveNulls = false,
    },
    Members = new[]
    {
        new Aws.CleanRooms.Inputs.CollaborationMemberArgs
        {
            AccountId = "string",
            DisplayName = "string",
            MemberAbilities = new[]
            {
                "string",
            },
            Status = "string",
        },
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cleanrooms.NewCollaboration(ctx, "collaborationResource", &cleanrooms.CollaborationArgs{
	CreatorDisplayName: pulumi.String("string"),
	CreatorMemberAbilities: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:    pulumi.String("string"),
	QueryLogStatus: pulumi.String("string"),
	DataEncryptionMetadata: &cleanrooms.CollaborationDataEncryptionMetadataArgs{
		AllowClearText:                        pulumi.Bool(false),
		AllowDuplicates:                       pulumi.Bool(false),
		AllowJoinsOnColumnsWithDifferentNames: pulumi.Bool(false),
		PreserveNulls:                         pulumi.Bool(false),
	},
	Members: cleanrooms.CollaborationMemberArray{
		&cleanrooms.CollaborationMemberArgs{
			AccountId:   pulumi.String("string"),
			DisplayName: pulumi.String("string"),
			MemberAbilities: pulumi.StringArray{
				pulumi.String("string"),
			},
			Status: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var collaborationResource = new Collaboration("collaborationResource", CollaborationArgs.builder()
    .creatorDisplayName("string")
    .creatorMemberAbilities("string")
    .description("string")
    .queryLogStatus("string")
    .dataEncryptionMetadata(CollaborationDataEncryptionMetadataArgs.builder()
        .allowClearText(false)
        .allowDuplicates(false)
        .allowJoinsOnColumnsWithDifferentNames(false)
        .preserveNulls(false)
        .build())
    .members(CollaborationMemberArgs.builder()
        .accountId("string")
        .displayName("string")
        .memberAbilities("string")
        .status("string")
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    collaboration_resource = aws.cleanrooms.Collaboration("collaborationResource",
    creator_display_name="string",
    creator_member_abilities=["string"],
    description="string",
    query_log_status="string",
    data_encryption_metadata={
        "allow_clear_text": False,
        "allow_duplicates": False,
        "allow_joins_on_columns_with_different_names": False,
        "preserve_nulls": False,
    },
    members=[{
        "account_id": "string",
        "display_name": "string",
        "member_abilities": ["string"],
        "status": "string",
    }],
    name="string",
    tags={
        "string": "string",
    })

    const collaborationResource = new aws.cleanrooms.Collaboration("collaborationResource", {
    creatorDisplayName: "string",
    creatorMemberAbilities: ["string"],
    description: "string",
    queryLogStatus: "string",
    dataEncryptionMetadata: {
        allowClearText: false,
        allowDuplicates: false,
        allowJoinsOnColumnsWithDifferentNames: false,
        preserveNulls: false,
    },
    members: [{
        accountId: "string",
        displayName: "string",
        memberAbilities: ["string"],
        status: "string",
    }],
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:cleanrooms:Collaboration
properties:
    creatorDisplayName: string
    creatorMemberAbilities:
        - string
    dataEncryptionMetadata:
        allowClearText: false
        allowDuplicates: false
        allowJoinsOnColumnsWithDifferentNames: false
        preserveNulls: false
    description: string
    members:
        - accountId: string
          displayName: string
          memberAbilities:
            - string
          status: string
    name: string
    queryLogStatus: string
    tags:
        string: string

    Collaboration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Collaboration resource accepts the following input properties:

    CreatorDisplayName string
    The name for the member record for the collaboration creator.
    CreatorMemberAbilities List<string>
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    Description string
    A description for a collaboration.
    QueryLogStatus string
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    DataEncryptionMetadata CollaborationDataEncryptionMetadata
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    Members List<CollaborationMember>
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    Name string
    The name of the collaboration. Collaboration names do not need to be unique.
    Tags Dictionary<string, string>
    Key value pairs which tag the collaboration.
    CreatorDisplayName string
    The name for the member record for the collaboration creator.
    CreatorMemberAbilities []string
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    Description string
    A description for a collaboration.
    QueryLogStatus string
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    DataEncryptionMetadata CollaborationDataEncryptionMetadataArgs
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    Members []CollaborationMemberArgs
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    Name string
    The name of the collaboration. Collaboration names do not need to be unique.
    Tags map[string]string
    Key value pairs which tag the collaboration.
    creatorDisplayName String
    The name for the member record for the collaboration creator.
    creatorMemberAbilities List<String>
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    description String
    A description for a collaboration.
    queryLogStatus String
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    dataEncryptionMetadata CollaborationDataEncryptionMetadata
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    members List<CollaborationMember>
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name String
    The name of the collaboration. Collaboration names do not need to be unique.
    tags Map<String,String>
    Key value pairs which tag the collaboration.
    creatorDisplayName string
    The name for the member record for the collaboration creator.
    creatorMemberAbilities string[]
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    description string
    A description for a collaboration.
    queryLogStatus string
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    dataEncryptionMetadata CollaborationDataEncryptionMetadata
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    members CollaborationMember[]
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name string
    The name of the collaboration. Collaboration names do not need to be unique.
    tags {[key: string]: string}
    Key value pairs which tag the collaboration.
    creator_display_name str
    The name for the member record for the collaboration creator.
    creator_member_abilities Sequence[str]
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    description str
    A description for a collaboration.
    query_log_status str
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    data_encryption_metadata CollaborationDataEncryptionMetadataArgs
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    members Sequence[CollaborationMemberArgs]
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name str
    The name of the collaboration. Collaboration names do not need to be unique.
    tags Mapping[str, str]
    Key value pairs which tag the collaboration.
    creatorDisplayName String
    The name for the member record for the collaboration creator.
    creatorMemberAbilities List<String>
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    description String
    A description for a collaboration.
    queryLogStatus String
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    dataEncryptionMetadata Property Map
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    members List<Property Map>
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name String
    The name of the collaboration. Collaboration names do not need to be unique.
    tags Map<String>
    Key value pairs which tag the collaboration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Collaboration resource produces the following output properties:

    Arn string
    The arn of the collaboration.
    CreateTime string
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    UpdateTime string
    Arn string
    The arn of the collaboration.
    CreateTime string
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    UpdateTime string
    arn String
    The arn of the collaboration.
    createTime String
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    updateTime String
    arn string
    The arn of the collaboration.
    createTime string
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    updateTime string
    arn str
    The arn of the collaboration.
    create_time str
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    update_time str
    arn String
    The arn of the collaboration.
    createTime String
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    updateTime String

    Look up Existing Collaboration Resource

    Get an existing Collaboration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CollaborationState, opts?: CustomResourceOptions): Collaboration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        create_time: Optional[str] = None,
        creator_display_name: Optional[str] = None,
        creator_member_abilities: Optional[Sequence[str]] = None,
        data_encryption_metadata: Optional[CollaborationDataEncryptionMetadataArgs] = None,
        description: Optional[str] = None,
        members: Optional[Sequence[CollaborationMemberArgs]] = None,
        name: Optional[str] = None,
        query_log_status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        update_time: Optional[str] = None) -> Collaboration
    func GetCollaboration(ctx *Context, name string, id IDInput, state *CollaborationState, opts ...ResourceOption) (*Collaboration, error)
    public static Collaboration Get(string name, Input<string> id, CollaborationState? state, CustomResourceOptions? opts = null)
    public static Collaboration get(String name, Output<String> id, CollaborationState state, CustomResourceOptions options)
    resources:  _:    type: aws:cleanrooms:Collaboration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The arn of the collaboration.
    CreateTime string
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    CreatorDisplayName string
    The name for the member record for the collaboration creator.
    CreatorMemberAbilities List<string>
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    DataEncryptionMetadata CollaborationDataEncryptionMetadata
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    Description string
    A description for a collaboration.
    Members List<CollaborationMember>
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    Name string
    The name of the collaboration. Collaboration names do not need to be unique.
    QueryLogStatus string
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    Tags Dictionary<string, string>
    Key value pairs which tag the collaboration.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    UpdateTime string
    Arn string
    The arn of the collaboration.
    CreateTime string
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    CreatorDisplayName string
    The name for the member record for the collaboration creator.
    CreatorMemberAbilities []string
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    DataEncryptionMetadata CollaborationDataEncryptionMetadataArgs
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    Description string
    A description for a collaboration.
    Members []CollaborationMemberArgs
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    Name string
    The name of the collaboration. Collaboration names do not need to be unique.
    QueryLogStatus string
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    Tags map[string]string
    Key value pairs which tag the collaboration.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    UpdateTime string
    arn String
    The arn of the collaboration.
    createTime String
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    creatorDisplayName String
    The name for the member record for the collaboration creator.
    creatorMemberAbilities List<String>
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    dataEncryptionMetadata CollaborationDataEncryptionMetadata
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    description String
    A description for a collaboration.
    members List<CollaborationMember>
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name String
    The name of the collaboration. Collaboration names do not need to be unique.
    queryLogStatus String
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    tags Map<String,String>
    Key value pairs which tag the collaboration.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    updateTime String
    arn string
    The arn of the collaboration.
    createTime string
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    creatorDisplayName string
    The name for the member record for the collaboration creator.
    creatorMemberAbilities string[]
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    dataEncryptionMetadata CollaborationDataEncryptionMetadata
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    description string
    A description for a collaboration.
    members CollaborationMember[]
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name string
    The name of the collaboration. Collaboration names do not need to be unique.
    queryLogStatus string
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    tags {[key: string]: string}
    Key value pairs which tag the collaboration.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    updateTime string
    arn str
    The arn of the collaboration.
    create_time str
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    creator_display_name str
    The name for the member record for the collaboration creator.
    creator_member_abilities Sequence[str]
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    data_encryption_metadata CollaborationDataEncryptionMetadataArgs
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    description str
    A description for a collaboration.
    members Sequence[CollaborationMemberArgs]
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name str
    The name of the collaboration. Collaboration names do not need to be unique.
    query_log_status str
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    tags Mapping[str, str]
    Key value pairs which tag the collaboration.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    update_time str
    arn String
    The arn of the collaboration.
    createTime String
    The date and time the collaboration was created.

    • member status - For each member included in the collaboration an additional computed attribute of status is added. These values may be found here.
    creatorDisplayName String
    The name for the member record for the collaboration creator.
    creatorMemberAbilities List<String>
    The list of member abilities for the creator of the collaboration. Valid values may be found here.
    dataEncryptionMetadata Property Map
    a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

    • data_encryption_metadata.allow_clear_text - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field.
    • data_encryption_metadata.allow_duplicates - (Required - Forces new resource ) - Indicates whether Fingerprint columns can contain duplicate entries. This is a boolean field.
    • data_encryption_metadata.allow_joins_on_columns_with_different_names - (Required - Forces new resource) - Indicates whether Fingerprint columns can be joined n any other Fingerprint column with a different name. This is a boolean field.
    • data_encryption_metadata.preserve_nulls - (Required - Forces new resource) - Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
    description String
    A description for a collaboration.
    members List<Property Map>
    Additional members of the collaboration which will be invited to join the collaboration.

    • member.account_id - (Required - Forces new resource) - The account id for the invited member.
    • member.display_name - (Required - Forces new resource) - The display name for the invited member.
    • member.member_abilities - (Required - Forces new resource) - The list of abilities for the invited member. Valid values may be found here.
    name String
    The name of the collaboration. Collaboration names do not need to be unique.
    queryLogStatus String
    Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.
    tags Map<String>
    Key value pairs which tag the collaboration.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    updateTime String

    Supporting Types

    CollaborationDataEncryptionMetadata, CollaborationDataEncryptionMetadataArgs

    CollaborationMember, CollaborationMemberArgs

    AccountId string
    DisplayName string
    MemberAbilities List<string>
    Status string
    AccountId string
    DisplayName string
    MemberAbilities []string
    Status string
    accountId String
    displayName String
    memberAbilities List<String>
    status String
    accountId string
    displayName string
    memberAbilities string[]
    status string
    accountId String
    displayName String
    memberAbilities List<String>
    status String

    Import

    Using pulumi import, import aws_cleanrooms_collaboration using the id. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws