We recommend new projects start with resources from the AWS provider.
aws-native.cleanrooms.Collaboration
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Represents a collaboration between AWS accounts that allows for secure data collaboration
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[CollaborationMemberAbility]] = None,
description: Optional[str] = None,
members: Optional[Sequence[CollaborationMemberSpecificationArgs]] = None,
query_log_status: Optional[CollaborationQueryLogStatus] = None,
creator_payment_configuration: Optional[CollaborationPaymentConfigurationArgs] = None,
data_encryption_metadata: Optional[CollaborationDataEncryptionMetadataArgs] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.
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:
- Creator
Display stringName - A display name of the collaboration creator.
- Creator
Member List<Pulumi.Abilities Aws Native. Clean Rooms. Collaboration Member Ability> The abilities granted to the collaboration creator.
Allowed values
CAN_QUERY
|CAN_RECEIVE_RESULTS
- Description string
- A description of the collaboration provided by the collaboration owner.
- Members
List<Pulumi.
Aws Native. Clean Rooms. Inputs. Collaboration Member Specification> - A list of initial members, not including the creator. This list is immutable.
- Query
Log Pulumi.Status Aws Native. Clean Rooms. Collaboration Query Log Status - An indicator as to whether query logging has been enabled or disabled for the collaboration.
- Creator
Payment Pulumi.Configuration Aws Native. Clean Rooms. Inputs. Collaboration Payment Configuration - An object representing the collaboration member's payment responsibilities set by the collaboration creator.
- Data
Encryption Pulumi.Metadata Aws Native. Clean Rooms. Inputs. Collaboration Data Encryption Metadata - The settings for client-side encryption for cryptographic computing.
- Name string
- A human-readable identifier provided by the collaboration owner. Display names are not unique.
- List<Pulumi.
Aws Native. Inputs. Tag> - An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- Creator
Display stringName - A display name of the collaboration creator.
- Creator
Member []CollaborationAbilities Member Ability The abilities granted to the collaboration creator.
Allowed values
CAN_QUERY
|CAN_RECEIVE_RESULTS
- Description string
- A description of the collaboration provided by the collaboration owner.
- Members
[]Collaboration
Member Specification Args - A list of initial members, not including the creator. This list is immutable.
- Query
Log CollaborationStatus Query Log Status - An indicator as to whether query logging has been enabled or disabled for the collaboration.
- Creator
Payment CollaborationConfiguration Payment Configuration Args - An object representing the collaboration member's payment responsibilities set by the collaboration creator.
- Data
Encryption CollaborationMetadata Data Encryption Metadata Args - The settings for client-side encryption for cryptographic computing.
- Name string
- A human-readable identifier provided by the collaboration owner. Display names are not unique.
- Tag
Args - An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- creator
Display StringName - A display name of the collaboration creator.
- creator
Member List<CollaborationAbilities Member Ability> The abilities granted to the collaboration creator.
Allowed values
CAN_QUERY
|CAN_RECEIVE_RESULTS
- description String
- A description of the collaboration provided by the collaboration owner.
- members
List<Collaboration
Member Specification> - A list of initial members, not including the creator. This list is immutable.
- query
Log CollaborationStatus Query Log Status - An indicator as to whether query logging has been enabled or disabled for the collaboration.
- creator
Payment CollaborationConfiguration Payment Configuration - An object representing the collaboration member's payment responsibilities set by the collaboration creator.
- data
Encryption CollaborationMetadata Data Encryption Metadata - The settings for client-side encryption for cryptographic computing.
- name String
- A human-readable identifier provided by the collaboration owner. Display names are not unique.
- List<Tag>
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- creator
Display stringName - A display name of the collaboration creator.
- creator
Member CollaborationAbilities Member Ability[] The abilities granted to the collaboration creator.
Allowed values
CAN_QUERY
|CAN_RECEIVE_RESULTS
- description string
- A description of the collaboration provided by the collaboration owner.
- members
Collaboration
Member Specification[] - A list of initial members, not including the creator. This list is immutable.
- query
Log CollaborationStatus Query Log Status - An indicator as to whether query logging has been enabled or disabled for the collaboration.
- creator
Payment CollaborationConfiguration Payment Configuration - An object representing the collaboration member's payment responsibilities set by the collaboration creator.
- data
Encryption CollaborationMetadata Data Encryption Metadata - The settings for client-side encryption for cryptographic computing.
- name string
- A human-readable identifier provided by the collaboration owner. Display names are not unique.
- Tag[]
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- creator_
display_ strname - A display name of the collaboration creator.
- creator_
member_ Sequence[Collaborationabilities Member Ability] The abilities granted to the collaboration creator.
Allowed values
CAN_QUERY
|CAN_RECEIVE_RESULTS
- description str
- A description of the collaboration provided by the collaboration owner.
- members
Sequence[Collaboration
Member Specification Args] - A list of initial members, not including the creator. This list is immutable.
- query_
log_ Collaborationstatus Query Log Status - An indicator as to whether query logging has been enabled or disabled for the collaboration.
- creator_
payment_ Collaborationconfiguration Payment Configuration Args - An object representing the collaboration member's payment responsibilities set by the collaboration creator.
- data_
encryption_ Collaborationmetadata Data Encryption Metadata Args - The settings for client-side encryption for cryptographic computing.
- name str
- A human-readable identifier provided by the collaboration owner. Display names are not unique.
- Sequence[Tag
Args] - An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
- creator
Display StringName - A display name of the collaboration creator.
- creator
Member List<"CAN_QUERY" | "CAN_RECEIVE_RESULTS">Abilities The abilities granted to the collaboration creator.
Allowed values
CAN_QUERY
|CAN_RECEIVE_RESULTS
- description String
- A description of the collaboration provided by the collaboration owner.
- members List<Property Map>
- A list of initial members, not including the creator. This list is immutable.
- query
Log "ENABLED" | "DISABLED"Status - An indicator as to whether query logging has been enabled or disabled for the collaboration.
- creator
Payment Property MapConfiguration - An object representing the collaboration member's payment responsibilities set by the collaboration creator.
- data
Encryption Property MapMetadata - The settings for client-side encryption for cryptographic computing.
- name String
- A human-readable identifier provided by the collaboration owner. Display names are not unique.
- List<Property Map>
- An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
Outputs
All input properties are implicitly available as output properties. Additionally, the Collaboration resource produces the following output properties:
- Arn string
Returns the Amazon Resource Name (ARN) of the specified collaboration.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- Collaboration
Identifier string Returns the unique identifier of the specified collaboration.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- Id string
- The provider-assigned unique ID for this managed resource.
- Arn string
Returns the Amazon Resource Name (ARN) of the specified collaboration.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- Collaboration
Identifier string Returns the unique identifier of the specified collaboration.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- Id string
- The provider-assigned unique ID for this managed resource.
- arn String
Returns the Amazon Resource Name (ARN) of the specified collaboration.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- collaboration
Identifier String Returns the unique identifier of the specified collaboration.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- id String
- The provider-assigned unique ID for this managed resource.
- arn string
Returns the Amazon Resource Name (ARN) of the specified collaboration.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- collaboration
Identifier string Returns the unique identifier of the specified collaboration.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- id string
- The provider-assigned unique ID for this managed resource.
- arn str
Returns the Amazon Resource Name (ARN) of the specified collaboration.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- collaboration_
identifier str Returns the unique identifier of the specified collaboration.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- id str
- The provider-assigned unique ID for this managed resource.
- arn String
Returns the Amazon Resource Name (ARN) of the specified collaboration.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- collaboration
Identifier String Returns the unique identifier of the specified collaboration.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
CollaborationDataEncryptionMetadata, CollaborationDataEncryptionMetadataArgs
- Allow
Cleartext bool - Indicates whether encrypted tables can contain cleartext data (
TRUE
) or are to cryptographically process every column (FALSE
). - Allow
Duplicates bool - Indicates whether Fingerprint columns can contain duplicate entries (
TRUE
) or are to contain only non-repeated values (FALSE
). - Allow
Joins boolOn Columns With Different Names - Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (
TRUE
) or can only be joined on Fingerprint columns of the same name (FALSE
). - Preserve
Nulls bool - Indicates whether NULL values are to be copied as NULL to encrypted tables (
TRUE
) or cryptographically processed (FALSE
).
- Allow
Cleartext bool - Indicates whether encrypted tables can contain cleartext data (
TRUE
) or are to cryptographically process every column (FALSE
). - Allow
Duplicates bool - Indicates whether Fingerprint columns can contain duplicate entries (
TRUE
) or are to contain only non-repeated values (FALSE
). - Allow
Joins boolOn Columns With Different Names - Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (
TRUE
) or can only be joined on Fingerprint columns of the same name (FALSE
). - Preserve
Nulls bool - Indicates whether NULL values are to be copied as NULL to encrypted tables (
TRUE
) or cryptographically processed (FALSE
).
- allow
Cleartext Boolean - Indicates whether encrypted tables can contain cleartext data (
TRUE
) or are to cryptographically process every column (FALSE
). - allow
Duplicates Boolean - Indicates whether Fingerprint columns can contain duplicate entries (
TRUE
) or are to contain only non-repeated values (FALSE
). - allow
Joins BooleanOn Columns With Different Names - Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (
TRUE
) or can only be joined on Fingerprint columns of the same name (FALSE
). - preserve
Nulls Boolean - Indicates whether NULL values are to be copied as NULL to encrypted tables (
TRUE
) or cryptographically processed (FALSE
).
- allow
Cleartext boolean - Indicates whether encrypted tables can contain cleartext data (
TRUE
) or are to cryptographically process every column (FALSE
). - allow
Duplicates boolean - Indicates whether Fingerprint columns can contain duplicate entries (
TRUE
) or are to contain only non-repeated values (FALSE
). - allow
Joins booleanOn Columns With Different Names - Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (
TRUE
) or can only be joined on Fingerprint columns of the same name (FALSE
). - preserve
Nulls boolean - Indicates whether NULL values are to be copied as NULL to encrypted tables (
TRUE
) or cryptographically processed (FALSE
).
- allow_
cleartext bool - Indicates whether encrypted tables can contain cleartext data (
TRUE
) or are to cryptographically process every column (FALSE
). - allow_
duplicates bool - Indicates whether Fingerprint columns can contain duplicate entries (
TRUE
) or are to contain only non-repeated values (FALSE
). - allow_
joins_ boolon_ columns_ with_ different_ names - Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (
TRUE
) or can only be joined on Fingerprint columns of the same name (FALSE
). - preserve_
nulls bool - Indicates whether NULL values are to be copied as NULL to encrypted tables (
TRUE
) or cryptographically processed (FALSE
).
- allow
Cleartext Boolean - Indicates whether encrypted tables can contain cleartext data (
TRUE
) or are to cryptographically process every column (FALSE
). - allow
Duplicates Boolean - Indicates whether Fingerprint columns can contain duplicate entries (
TRUE
) or are to contain only non-repeated values (FALSE
). - allow
Joins BooleanOn Columns With Different Names - Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (
TRUE
) or can only be joined on Fingerprint columns of the same name (FALSE
). - preserve
Nulls Boolean - Indicates whether NULL values are to be copied as NULL to encrypted tables (
TRUE
) or cryptographically processed (FALSE
).
CollaborationMemberAbility, CollaborationMemberAbilityArgs
- Can
Query - CAN_QUERY
- Can
Receive Results - CAN_RECEIVE_RESULTS
- Collaboration
Member Ability Can Query - CAN_QUERY
- Collaboration
Member Ability Can Receive Results - CAN_RECEIVE_RESULTS
- Can
Query - CAN_QUERY
- Can
Receive Results - CAN_RECEIVE_RESULTS
- Can
Query - CAN_QUERY
- Can
Receive Results - CAN_RECEIVE_RESULTS
- CAN_QUERY
- CAN_QUERY
- CAN_RECEIVE_RESULTS
- CAN_RECEIVE_RESULTS
- "CAN_QUERY"
- CAN_QUERY
- "CAN_RECEIVE_RESULTS"
- CAN_RECEIVE_RESULTS
CollaborationMemberSpecification, CollaborationMemberSpecificationArgs
- Account
Id string - The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- Display
Name string - The member's display name.
- Member
Abilities List<Pulumi.Aws Native. Clean Rooms. Collaboration Member Ability> The abilities granted to the collaboration member.
Allowed Values :
CAN_QUERY
|CAN_RECEIVE_RESULTS
- Payment
Configuration Pulumi.Aws Native. Clean Rooms. Inputs. Collaboration Payment Configuration The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- Account
Id string - The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- Display
Name string - The member's display name.
- Member
Abilities []CollaborationMember Ability The abilities granted to the collaboration member.
Allowed Values :
CAN_QUERY
|CAN_RECEIVE_RESULTS
- Payment
Configuration CollaborationPayment Configuration The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- account
Id String - The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- display
Name String - The member's display name.
- member
Abilities List<CollaborationMember Ability> The abilities granted to the collaboration member.
Allowed Values :
CAN_QUERY
|CAN_RECEIVE_RESULTS
- payment
Configuration CollaborationPayment Configuration The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- account
Id string - The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- display
Name string - The member's display name.
- member
Abilities CollaborationMember Ability[] The abilities granted to the collaboration member.
Allowed Values :
CAN_QUERY
|CAN_RECEIVE_RESULTS
- payment
Configuration CollaborationPayment Configuration The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- account_
id str - The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- display_
name str - The member's display name.
- member_
abilities Sequence[CollaborationMember Ability] The abilities granted to the collaboration member.
Allowed Values :
CAN_QUERY
|CAN_RECEIVE_RESULTS
- payment_
configuration CollaborationPayment Configuration The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- account
Id String - The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- display
Name String - The member's display name.
- member
Abilities List<"CAN_QUERY" | "CAN_RECEIVE_RESULTS"> The abilities granted to the collaboration member.
Allowed Values :
CAN_QUERY
|CAN_RECEIVE_RESULTS
- payment
Configuration Property Map The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
CollaborationPaymentConfiguration, CollaborationPaymentConfigurationArgs
- Query
Compute Pulumi.Aws Native. Clean Rooms. Inputs. Collaboration Query Compute Payment Config - The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
- Query
Compute CollaborationQuery Compute Payment Config - The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
- query
Compute CollaborationQuery Compute Payment Config - The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
- query
Compute CollaborationQuery Compute Payment Config - The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
- query_
compute CollaborationQuery Compute Payment Config - The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
- query
Compute Property Map - The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
CollaborationQueryComputePaymentConfig, CollaborationQueryComputePaymentConfigArgs
- Is
Responsible bool Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (
TRUE
) or has not configured the collaboration member to pay for query compute costs (FALSE
).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a
TRUE
value for more than one member in the collaboration.If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSE
value for the member who can query.
- Is
Responsible bool Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (
TRUE
) or has not configured the collaboration member to pay for query compute costs (FALSE
).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a
TRUE
value for more than one member in the collaboration.If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSE
value for the member who can query.
- is
Responsible Boolean Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (
TRUE
) or has not configured the collaboration member to pay for query compute costs (FALSE
).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a
TRUE
value for more than one member in the collaboration.If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSE
value for the member who can query.
- is
Responsible boolean Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (
TRUE
) or has not configured the collaboration member to pay for query compute costs (FALSE
).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a
TRUE
value for more than one member in the collaboration.If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSE
value for the member who can query.
- is_
responsible bool Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (
TRUE
) or has not configured the collaboration member to pay for query compute costs (FALSE
).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a
TRUE
value for more than one member in the collaboration.If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSE
value for the member who can query.
- is
Responsible Boolean Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (
TRUE
) or has not configured the collaboration member to pay for query compute costs (FALSE
).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a
TRUE
value for more than one member in the collaboration.If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSE
value for the member who can query.
CollaborationQueryLogStatus, CollaborationQueryLogStatusArgs
- Enabled
- ENABLED
- Disabled
- DISABLED
- Collaboration
Query Log Status Enabled - ENABLED
- Collaboration
Query Log Status Disabled - DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.