pulumi-aws-kotlin/com.pulumi.aws.cleanrooms.kotlin/CollaborationArgs

CollaborationArgs

data class CollaborationArgs(val creatorDisplayName: Output<String>? = null, val creatorMemberAbilities: Output<List<String>>? = null, val dataEncryptionMetadata: Output<CollaborationDataEncryptionMetadataArgs>? = null, val description: Output<String>? = null, val members: Output<List<CollaborationMemberArgs>>? = null, val name: Output<String>? = null, val queryLogStatus: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<CollaborationArgs>

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",
    },
});
Content copied to clipboard
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",
    })
Content copied to clipboard
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" },
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(creatorDisplayName: Output<String>? = null, creatorMemberAbilities: Output<List<String>>? = null, dataEncryptionMetadata: Output<CollaborationDataEncryptionMetadataArgs>? = null, description: Output<String>? = null, members: Output<List<CollaborationMemberArgs>>? = null, name: Output<String>? = null, queryLogStatus: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val creatorDisplayName: Output<String>? = null

The name for the member record for the collaboration creator.

Link copied to clipboard
val creatorMemberAbilities: Output<List<String>>? = null

The list of member abilities for the creator of the collaboration. Valid values may be found here.

Link copied to clipboard
val dataEncryptionMetadata: Output<CollaborationDataEncryptionMetadataArgs>? = null

a collection of settings which determine how the c3r client will encrypt data for use within this collaboration.

Link copied to clipboard
val description: Output<String>? = null

A description for a collaboration.

Link copied to clipboard
val members: Output<List<CollaborationMemberArgs>>? = null

Additional members of the collaboration which will be invited to join the collaboration.

Link copied to clipboard
val name: Output<String>? = null

The name of the collaboration. Collaboration names do not need to be unique.

Link copied to clipboard
val queryLogStatus: Output<String>? = null

Determines if members of the collaboration can enable query logs within their own. emberships. Valid values may be found here.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Key value pairs which tag the collaboration.

Functions

Link copied to clipboard
open override fun toJava(): CollaborationArgs