Collaboration class
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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const testCollaboration = new aws.cleanrooms.Collaboration("test_collaboration", {
dataEncryptionMetadata: {
allowClearText: true,
allowDuplicates: true,
allowJoinsOnColumnsWithDifferentNames: true,
preserveNulls: false,
},
members: [{
accountId: "123456789012",
displayName: "Other member",
memberAbilities: [],
}],
name: "pulumi-example-collaboration",
creatorMemberAbilities: [
"CAN_QUERY",
"CAN_RECEIVE_RESULTS",
],
creatorDisplayName: "Creator ",
description: "I made this collaboration with Pulumi!",
queryLogStatus: "DISABLED",
analyticsEngine: "SPARK",
tags: {
Project: "Pulumi",
},
});
import pulumi
import pulumi_aws as aws
test_collaboration = aws.cleanrooms.Collaboration("test_collaboration",
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": [],
}],
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",
analytics_engine="SPARK",
tags={
"Project": "Pulumi",
})
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()
{
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() { },
},
},
Name = "pulumi-example-collaboration",
CreatorMemberAbilities = new[]
{
"CAN_QUERY",
"CAN_RECEIVE_RESULTS",
},
CreatorDisplayName = "Creator ",
Description = "I made this collaboration with Pulumi!",
QueryLogStatus = "DISABLED",
AnalyticsEngine = "SPARK",
Tags =
{
{ "Project", "Pulumi" },
},
});
});
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.NewCollaboration(ctx, "test_collaboration", &cleanrooms.CollaborationArgs{
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{},
},
},
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"),
AnalyticsEngine: pulumi.String("SPARK"),
Tags: pulumi.StringMap{
"Project": pulumi.String("Pulumi"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cleanrooms_collaboration" "test_collaboration" {
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 = []
}
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"
analytics_engine = "SPARK"
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.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());
}
}
resources:
testCollaboration:
type: aws:cleanrooms:Collaboration
name: test_collaboration
properties:
dataEncryptionMetadata:
allowClearText: true
allowDuplicates: true
allowJoinsOnColumnsWithDifferentNames: true
preserveNulls: false
members:
- accountId: 1.23456789012e+11
displayName: Other member
memberAbilities: []
name: pulumi-example-collaboration
creatorMemberAbilities:
- CAN_QUERY
- CAN_RECEIVE_RESULTS
creatorDisplayName: 'Creator '
description: I made this collaboration with Pulumi!
queryLogStatus: DISABLED
analyticsEngine: SPARK
tags:
Project: Pulumi
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:
$ pulumi import aws:cleanrooms/collaboration:Collaboration collaboration 1234abcd-12ab-34cd-56ef-1234567890ab
Constructors
- Collaboration(String name, {CollaborationArgs? args, CustomResourceOptions? options})
-
Creates a new Collaboration.
nameThe Pulumi resource name.argsArguments used to configure this Collaboration. The set of arguments for Collaboration.optionsResource options controlling this resource's behavior. - Collaboration.reference(String urn)
- Creates a typed reference to an existing Collaboration resource.
Properties
-
analyticsEngine
↔ Output<
String?> -
Analytics engine used by the collaboration. Valid values are
CLEAN_ROOMS_SQL(deprecated) andSPARK.latefinal -
arn
↔ Output<
String> -
ARN of the collaboration.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createTime
↔ Output<
String> -
Date and time the collaboration was created.
latefinal
-
creatorDisplayName
↔ Output<
String> -
Name for the member record for the collaboration creator.
latefinal
-
creatorMemberAbilities
↔ Output<
List< String> > -
List of member abilities for the creator of the collaboration. Valid values may be found here.
latefinal
-
dataEncryptionMetadata
↔ Output<
CollaborationDataEncryptionMetadata?> -
Collection of settings which determine how the c3r client will encrypt data for use within this collaboration. See below.
latefinal
-
description
↔ Output<
String> -
Description for a collaboration.
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
-
members
↔ Output<
List< CollaborationMember> ?> -
Additional members of the collaboration which will be invited to join the collaboration. See below.
latefinal
-
name
↔ Output<
String> -
Name of the collaboration. Collaboration names do not need to be unique.
latefinal
-
queryLogStatus
↔ Output<
String> -
Whether members of the collaboration can enable query logs within their own memberships. Valid values may be found here.
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
-
Key value pairs which tag the collaboration.
latefinal
-
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
updateTime
↔ Output<
String> -
Date and time the collaboration 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, {CollaborationState? state, CustomResourceOptions? options}) → Collaboration -
Gets an existing Collaboration resource's state with the given
nameandid.