@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
177 lines (176 loc) • 8.73 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Represents a collaboration between AWS accounts that allows for secure data collaboration
*/
export declare class Collaboration extends pulumi.CustomResource {
/**
* Get an existing Collaboration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Collaboration;
/**
* Returns true if the given object is an instance of Collaboration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Collaboration;
/**
* The AWS Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
*/
readonly allowedResultRegions: pulumi.Output<enums.cleanrooms.CollaborationSupportedS3Region[] | undefined>;
/**
* The analytics engine for the collaboration.
*
* > After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available.
*/
readonly analyticsEngine: pulumi.Output<enums.cleanrooms.CollaborationAnalyticsEngine | undefined>;
/**
* Returns the Amazon Resource Name (ARN) of the specified collaboration.
*
* Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`
*/
readonly arn: pulumi.Output<string>;
/**
* The types of change requests that are automatically approved for this collaboration.
*/
readonly autoApprovedChangeTypes: pulumi.Output<enums.cleanrooms.CollaborationAutoApprovedChangeType[] | undefined>;
/**
* Returns the unique identifier of the specified collaboration.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`
*/
readonly collaborationIdentifier: pulumi.Output<string>;
/**
* A display name of the collaboration creator.
*/
readonly creatorDisplayName: pulumi.Output<string>;
/**
* The abilities granted to the collaboration creator.
*
* *Allowed values* `CAN_QUERY` | `CAN_RECEIVE_RESULTS` | `CAN_RUN_JOB`
*/
readonly creatorMemberAbilities: pulumi.Output<enums.cleanrooms.CollaborationMemberAbility[] | undefined>;
/**
* The ML member abilities for a collaboration member.
*/
readonly creatorMlMemberAbilities: pulumi.Output<outputs.cleanrooms.CollaborationMlMemberAbilities | undefined>;
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*/
readonly creatorPaymentConfiguration: pulumi.Output<outputs.cleanrooms.CollaborationPaymentConfiguration | undefined>;
/**
* The settings for client-side encryption for cryptographic computing.
*/
readonly dataEncryptionMetadata: pulumi.Output<outputs.cleanrooms.CollaborationDataEncryptionMetadata | undefined>;
/**
* A description of the collaboration provided by the collaboration owner.
*/
readonly description: pulumi.Output<string>;
/**
* An indicator as to whether job logging has been enabled or disabled for the collaboration.
*
* When `ENABLED` , AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .
*/
readonly jobLogStatus: pulumi.Output<enums.cleanrooms.CollaborationJobLogStatus | undefined>;
/**
* A list of initial members, not including the creator. This list is immutable.
*/
readonly members: pulumi.Output<outputs.cleanrooms.CollaborationMemberSpecification[] | undefined>;
/**
* A human-readable identifier provided by the collaboration owner. Display names are not unique.
*/
readonly name: pulumi.Output<string>;
/**
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*
* When `ENABLED` , AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .
*/
readonly queryLogStatus: pulumi.Output<enums.cleanrooms.CollaborationQueryLogStatus>;
/**
* An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a Collaboration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CollaborationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Collaboration resource.
*/
export interface CollaborationArgs {
/**
* The AWS Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
*/
allowedResultRegions?: pulumi.Input<pulumi.Input<enums.cleanrooms.CollaborationSupportedS3Region>[]>;
/**
* The analytics engine for the collaboration.
*
* > After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available.
*/
analyticsEngine?: pulumi.Input<enums.cleanrooms.CollaborationAnalyticsEngine>;
/**
* The types of change requests that are automatically approved for this collaboration.
*/
autoApprovedChangeTypes?: pulumi.Input<pulumi.Input<enums.cleanrooms.CollaborationAutoApprovedChangeType>[]>;
/**
* A display name of the collaboration creator.
*/
creatorDisplayName: pulumi.Input<string>;
/**
* The abilities granted to the collaboration creator.
*
* *Allowed values* `CAN_QUERY` | `CAN_RECEIVE_RESULTS` | `CAN_RUN_JOB`
*/
creatorMemberAbilities?: pulumi.Input<pulumi.Input<enums.cleanrooms.CollaborationMemberAbility>[]>;
/**
* The ML member abilities for a collaboration member.
*/
creatorMlMemberAbilities?: pulumi.Input<inputs.cleanrooms.CollaborationMlMemberAbilitiesArgs>;
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*/
creatorPaymentConfiguration?: pulumi.Input<inputs.cleanrooms.CollaborationPaymentConfigurationArgs>;
/**
* The settings for client-side encryption for cryptographic computing.
*/
dataEncryptionMetadata?: pulumi.Input<inputs.cleanrooms.CollaborationDataEncryptionMetadataArgs>;
/**
* A description of the collaboration provided by the collaboration owner.
*/
description: pulumi.Input<string>;
/**
* An indicator as to whether job logging has been enabled or disabled for the collaboration.
*
* When `ENABLED` , AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .
*/
jobLogStatus?: pulumi.Input<enums.cleanrooms.CollaborationJobLogStatus>;
/**
* A list of initial members, not including the creator. This list is immutable.
*/
members?: pulumi.Input<pulumi.Input<inputs.cleanrooms.CollaborationMemberSpecificationArgs>[]>;
/**
* A human-readable identifier provided by the collaboration owner. Display names are not unique.
*/
name?: pulumi.Input<string>;
/**
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*
* When `ENABLED` , AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .
*/
queryLogStatus: pulumi.Input<enums.cleanrooms.CollaborationQueryLogStatus>;
/**
* An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}