aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,040 lines • 175 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { AnalysisTemplateReference, CollaborationReference, ConfiguredTableAssociationReference, ConfiguredTableReference, IAnalysisTemplateRef, ICollaborationRef, IConfiguredTableAssociationRef, IConfiguredTableRef, IdMappingTableReference, IdNamespaceAssociationReference, IIdMappingTableRef, IIdNamespaceAssociationRef, IMembershipRef, IPrivacyBudgetTemplateRef, MembershipReference, PrivacyBudgetTemplateReference } from "../../interfaces/generated/aws-cleanrooms-interfaces.generated";
/**
* Creates a new analysis template.
*
* @cloudformationResource AWS::CleanRooms::AnalysisTemplate
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html
*/
export declare class CfnAnalysisTemplate extends cdk.CfnResource implements cdk.IInspectable, IAnalysisTemplateRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnAnalysisTemplate from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAnalysisTemplate;
/**
* Checks whether the given object is a CfnAnalysisTemplate
*/
static isCfnAnalysisTemplate(x: any): x is CfnAnalysisTemplate;
static arnForAnalysisTemplate(resource: IAnalysisTemplateRef): string;
/**
* The parameters of the analysis template.
*/
private _analysisParameters?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the analysis template.
*/
private _description?;
/**
* The configuration that specifies the level of detail in error messages returned by analyses using this template.
*/
private _errorMessageConfiguration?;
/**
* The format of the analysis template.
*/
private _format;
/**
* The identifier for a membership resource.
*/
private _membershipIdentifier;
/**
* The name of the analysis template.
*/
private _name;
/**
* The entire schema object.
*/
private _schema?;
/**
* The source of the analysis template.
*/
private _source;
/**
* The source metadata for the analysis template.
*/
private _sourceMetadata?;
/**
* The parameters used to generate synthetic data for this analysis template.
*/
private _syntheticDataParameters?;
/**
* An optional label that you can assign to a resource when you create it.
*/
private _tags?;
/**
* Create a new `AWS::CleanRooms::AnalysisTemplate`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnAnalysisTemplateProps);
get analysisTemplateRef(): AnalysisTemplateReference;
/**
* The parameters of the analysis template.
*/
get analysisParameters(): Array<CfnAnalysisTemplate.AnalysisParameterProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* The parameters of the analysis template.
*/
set analysisParameters(value: Array<CfnAnalysisTemplate.AnalysisParameterProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* The description of the analysis template.
*/
get description(): string | undefined;
/**
* The description of the analysis template.
*/
set description(value: string | undefined);
/**
* The configuration that specifies the level of detail in error messages returned by analyses using this template.
*/
get errorMessageConfiguration(): CfnAnalysisTemplate.ErrorMessageConfigurationProperty | cdk.IResolvable | undefined;
/**
* The configuration that specifies the level of detail in error messages returned by analyses using this template.
*/
set errorMessageConfiguration(value: CfnAnalysisTemplate.ErrorMessageConfigurationProperty | cdk.IResolvable | undefined);
/**
* The format of the analysis template.
*/
get format(): string;
/**
* The format of the analysis template.
*/
set format(value: string);
/**
* The identifier for a membership resource.
*/
get membershipIdentifier(): string;
/**
* The identifier for a membership resource.
*/
set membershipIdentifier(value: string);
/**
* The name of the analysis template.
*/
get name(): string;
/**
* The name of the analysis template.
*/
set name(value: string);
/**
* The entire schema object.
*/
get schema(): CfnAnalysisTemplate.AnalysisSchemaProperty | cdk.IResolvable | undefined;
/**
* The entire schema object.
*/
set schema(value: CfnAnalysisTemplate.AnalysisSchemaProperty | cdk.IResolvable | undefined);
/**
* The source of the analysis template.
*/
get source(): CfnAnalysisTemplate.AnalysisSourceProperty | cdk.IResolvable;
/**
* The source of the analysis template.
*/
set source(value: CfnAnalysisTemplate.AnalysisSourceProperty | cdk.IResolvable);
/**
* The source metadata for the analysis template.
*/
get sourceMetadata(): CfnAnalysisTemplate.AnalysisSourceMetadataProperty | cdk.IResolvable | undefined;
/**
* The source metadata for the analysis template.
*/
set sourceMetadata(value: CfnAnalysisTemplate.AnalysisSourceMetadataProperty | cdk.IResolvable | undefined);
/**
* The parameters used to generate synthetic data for this analysis template.
*/
get syntheticDataParameters(): cdk.IResolvable | CfnAnalysisTemplate.SyntheticDataParametersProperty | undefined;
/**
* The parameters used to generate synthetic data for this analysis template.
*/
set syntheticDataParameters(value: cdk.IResolvable | CfnAnalysisTemplate.SyntheticDataParametersProperty | undefined);
/**
* An optional label that you can assign to a resource when you create it.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* An optional label that you can assign to a resource when you create it.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* Returns the identifier for the analysis template.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`
*
* @cloudformationAttribute AnalysisTemplateIdentifier
*/
get attrAnalysisTemplateIdentifier(): string;
/**
* Returns the Amazon Resource Name (ARN) of the analysis template.
*
* Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* Returns the unique ARN for the analysis template’s associated collaboration.
*
* Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`
*
* @cloudformationAttribute CollaborationArn
*/
get attrCollaborationArn(): string;
/**
* Returns the unique ID for the associated collaboration of the analysis template.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`
*
* @cloudformationAttribute CollaborationIdentifier
*/
get attrCollaborationIdentifier(): string;
/**
* Returns the Amazon Resource Name (ARN) of the member who created the analysis template.
*
* Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`
*
* @cloudformationAttribute MembershipArn
*/
get attrMembershipArn(): string;
/**
* @cloudformationAttribute Schema
*/
get attrSchema(): cdk.IResolvable;
/**
* @cloudformationAttribute Schema.ReferencedTables
*/
get attrSchemaReferencedTables(): Array<string>;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnAnalysisTemplate {
/**
* Optional.
*
* The member who can query can provide this placeholder for a literal data value in an analysis template.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html
*/
interface AnalysisParameterProperty {
/**
* Optional.
*
* The default value that is applied in the analysis template. The member who can query can override this value in the query editor.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-defaultvalue
*/
readonly defaultValue?: string;
/**
* The name of the parameter.
*
* The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-name
*/
readonly name: string;
/**
* The type of parameter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-type
*/
readonly type: string;
}
/**
* The structure that defines the body of the analysis template.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html
*/
interface AnalysisSourceProperty {
/**
* The artifacts of the analysis source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html#cfn-cleanrooms-analysistemplate-analysissource-artifacts
*/
readonly artifacts?: CfnAnalysisTemplate.AnalysisTemplateArtifactsProperty | cdk.IResolvable;
/**
* The query text.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html#cfn-cleanrooms-analysistemplate-analysissource-text
*/
readonly text?: string;
}
/**
* The analysis template artifacts.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html
*/
interface AnalysisTemplateArtifactsProperty {
/**
* Additional artifacts for the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-additionalartifacts
*/
readonly additionalArtifacts?: Array<CfnAnalysisTemplate.AnalysisTemplateArtifactProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The entry point for the analysis template artifacts.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-entrypoint
*/
readonly entryPoint: CfnAnalysisTemplate.AnalysisTemplateArtifactProperty | cdk.IResolvable;
/**
* The role ARN for the analysis template artifacts.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-rolearn
*/
readonly roleArn: string;
}
/**
* The analysis template artifact.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.html
*/
interface AnalysisTemplateArtifactProperty {
/**
* The artifact location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.html#cfn-cleanrooms-analysistemplate-analysistemplateartifact-location
*/
readonly location: cdk.IResolvable | CfnAnalysisTemplate.S3LocationProperty;
}
/**
* The S3 location.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html
*/
interface S3LocationProperty {
/**
* The bucket name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html#cfn-cleanrooms-analysistemplate-s3location-bucket
*/
readonly bucket: string;
/**
* The object key.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html#cfn-cleanrooms-analysistemplate-s3location-key
*/
readonly key: string;
}
/**
* A relation within an analysis.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisschema.html
*/
interface AnalysisSchemaProperty {
/**
* The tables referenced in the analysis schema.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisschema.html#cfn-cleanrooms-analysistemplate-analysisschema-referencedtables
*/
readonly referencedTables: Array<string>;
}
/**
* The analysis source metadata.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.html
*/
interface AnalysisSourceMetadataProperty {
/**
* The artifacts of the analysis source metadata.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.html#cfn-cleanrooms-analysistemplate-analysissourcemetadata-artifacts
*/
readonly artifacts: CfnAnalysisTemplate.AnalysisTemplateArtifactMetadataProperty | cdk.IResolvable;
}
/**
* The analysis template artifact metadata.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html
*/
interface AnalysisTemplateArtifactMetadataProperty {
/**
* Additional artifact hashes for the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-additionalartifacthashes
*/
readonly additionalArtifactHashes?: Array<CfnAnalysisTemplate.HashProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The hash of the entry point for the analysis template artifact metadata.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-entrypointhash
*/
readonly entryPointHash: CfnAnalysisTemplate.HashProperty | cdk.IResolvable;
}
/**
* Hash.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-hash.html
*/
interface HashProperty {
/**
* The SHA-256 hash value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-hash.html#cfn-cleanrooms-analysistemplate-hash-sha256
*/
readonly sha256?: string;
}
/**
* A structure that defines the level of detail included in error messages returned by PySpark jobs.
*
* This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-errormessageconfiguration.html
*/
interface ErrorMessageConfigurationProperty {
/**
* The level of detail for error messages returned by the PySpark job.
*
* When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job.
*
* Because this setting may expose sensitive data, it is recommended for development and testing environments.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-errormessageconfiguration.html#cfn-cleanrooms-analysistemplate-errormessageconfiguration-type
*/
readonly type: string;
}
/**
* The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.html
*/
interface SyntheticDataParametersProperty {
/**
* The machine learning-specific parameters for synthetic data generation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.html#cfn-cleanrooms-analysistemplate-syntheticdataparameters-mlsyntheticdataparameters
*/
readonly mlSyntheticDataParameters: cdk.IResolvable | CfnAnalysisTemplate.MLSyntheticDataParametersProperty;
}
/**
* Parameters that control the generation of synthetic data for machine learning, including privacy settings and column classification details.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html
*/
interface MLSyntheticDataParametersProperty {
/**
* Classification details for data columns that specify how each column should be treated during synthetic data generation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-columnclassification
*/
readonly columnClassification: CfnAnalysisTemplate.ColumnClassificationDetailsProperty | cdk.IResolvable;
/**
* The epsilon value for differential privacy when generating synthetic data.
*
* Lower values provide stronger privacy guarantees but may reduce data utility.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-epsilon
*/
readonly epsilon: number;
/**
* The maximum acceptable score for membership inference attack vulnerability.
*
* Synthetic data generation fails if the score for the resulting data exceeds this threshold.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-maxmembershipinferenceattackscore
*/
readonly maxMembershipInferenceAttackScore: number;
}
/**
* Contains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.html
*/
interface ColumnClassificationDetailsProperty {
/**
* A mapping that defines the classification of data columns for synthetic data generation and specifies how each column should be handled during the privacy-preserving data synthesis process.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.html#cfn-cleanrooms-analysistemplate-columnclassificationdetails-columnmapping
*/
readonly columnMapping: Array<cdk.IResolvable | CfnAnalysisTemplate.SyntheticDataColumnPropertiesProperty> | cdk.IResolvable;
}
/**
* Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html
*/
interface SyntheticDataColumnPropertiesProperty {
/**
* The name of the data column as it appears in the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columnname
*/
readonly columnName: string;
/**
* The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columntype
*/
readonly columnType: string;
/**
* Indicates if this column contains predictive values that should be treated as target variables in machine learning models.
*
* This affects how the synthetic data generation preserves statistical relationships.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-ispredictivevalue
*/
readonly isPredictiveValue: boolean | cdk.IResolvable;
}
}
/**
* Properties for defining a `CfnAnalysisTemplate`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html
*/
export interface CfnAnalysisTemplateProps {
/**
* The parameters of the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-analysisparameters
*/
readonly analysisParameters?: Array<CfnAnalysisTemplate.AnalysisParameterProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The description of the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-description
*/
readonly description?: string;
/**
* The configuration that specifies the level of detail in error messages returned by analyses using this template.
*
* When set to `DETAILED` , error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-errormessageconfiguration
*/
readonly errorMessageConfiguration?: CfnAnalysisTemplate.ErrorMessageConfigurationProperty | cdk.IResolvable;
/**
* The format of the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-format
*/
readonly format: string;
/**
* The identifier for a membership resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-membershipidentifier
*/
readonly membershipIdentifier: string;
/**
* The name of the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-name
*/
readonly name: string;
/**
* The entire schema object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-schema
*/
readonly schema?: CfnAnalysisTemplate.AnalysisSchemaProperty | cdk.IResolvable;
/**
* The source of the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-source
*/
readonly source: CfnAnalysisTemplate.AnalysisSourceProperty | cdk.IResolvable;
/**
* The source metadata for the analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-sourcemetadata
*/
readonly sourceMetadata?: CfnAnalysisTemplate.AnalysisSourceMetadataProperty | cdk.IResolvable;
/**
* The parameters used to generate synthetic data for this analysis template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-syntheticdataparameters
*/
readonly syntheticDataParameters?: cdk.IResolvable | CfnAnalysisTemplate.SyntheticDataParametersProperty;
/**
* An optional label that you can assign to a resource when you create it.
*
* Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Creates a new collaboration.
*
* @cloudformationResource AWS::CleanRooms::Collaboration
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html
*/
export declare class CfnCollaboration extends cdk.CfnResource implements cdk.IInspectable, ICollaborationRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCollaboration from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCollaboration;
/**
* Checks whether the given object is a CfnCollaboration
*/
static isCfnCollaboration(x: any): x is CfnCollaboration;
static arnForCollaboration(resource: ICollaborationRef): string;
/**
* The AWS Regions where collaboration query results can be stored.
*/
private _allowedResultRegions?;
/**
* The analytics engine for the collaboration.
*/
private _analyticsEngine?;
/**
* The types of change requests that are automatically approved for this collaboration.
*/
private _autoApprovedChangeTypes?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* A display name of the collaboration creator.
*/
private _creatorDisplayName;
/**
* The abilities granted to the collaboration creator.
*/
private _creatorMemberAbilities?;
/**
* The ML member abilities for a collaboration member.
*/
private _creatorMlMemberAbilities?;
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*/
private _creatorPaymentConfiguration?;
/**
* The settings for client-side encryption for cryptographic computing.
*/
private _dataEncryptionMetadata?;
/**
* A description of the collaboration provided by the collaboration owner.
*/
private _description;
private _isMetricsEnabled?;
/**
* An indicator as to whether job logging has been enabled or disabled for the collaboration.
*/
private _jobLogStatus?;
/**
* A list of initial members, not including the creator.
*/
private _members?;
/**
* A human-readable identifier provided by the collaboration owner.
*/
private _name;
/**
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*/
private _queryLogStatus;
/**
* An optional label that you can assign to a resource when you create it.
*/
private _tags?;
/**
* Create a new `AWS::CleanRooms::Collaboration`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCollaborationProps);
get collaborationRef(): CollaborationReference;
/**
* The AWS Regions where collaboration query results can be stored.
*/
get allowedResultRegions(): Array<string> | undefined;
/**
* The AWS Regions where collaboration query results can be stored.
*/
set allowedResultRegions(value: Array<string> | undefined);
/**
* The analytics engine for the collaboration.
*/
get analyticsEngine(): string | undefined;
/**
* The analytics engine for the collaboration.
*/
set analyticsEngine(value: string | undefined);
/**
* The types of change requests that are automatically approved for this collaboration.
*/
get autoApprovedChangeTypes(): Array<string> | undefined;
/**
* The types of change requests that are automatically approved for this collaboration.
*/
set autoApprovedChangeTypes(value: Array<string> | undefined);
/**
* A display name of the collaboration creator.
*/
get creatorDisplayName(): string;
/**
* A display name of the collaboration creator.
*/
set creatorDisplayName(value: string);
/**
* The abilities granted to the collaboration creator.
*/
get creatorMemberAbilities(): Array<string> | undefined;
/**
* The abilities granted to the collaboration creator.
*/
set creatorMemberAbilities(value: Array<string> | undefined);
/**
* The ML member abilities for a collaboration member.
*/
get creatorMlMemberAbilities(): cdk.IResolvable | CfnCollaboration.MLMemberAbilitiesProperty | undefined;
/**
* The ML member abilities for a collaboration member.
*/
set creatorMlMemberAbilities(value: cdk.IResolvable | CfnCollaboration.MLMemberAbilitiesProperty | undefined);
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*/
get creatorPaymentConfiguration(): cdk.IResolvable | CfnCollaboration.PaymentConfigurationProperty | undefined;
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*/
set creatorPaymentConfiguration(value: cdk.IResolvable | CfnCollaboration.PaymentConfigurationProperty | undefined);
/**
* The settings for client-side encryption for cryptographic computing.
*/
get dataEncryptionMetadata(): CfnCollaboration.DataEncryptionMetadataProperty | cdk.IResolvable | undefined;
/**
* The settings for client-side encryption for cryptographic computing.
*/
set dataEncryptionMetadata(value: CfnCollaboration.DataEncryptionMetadataProperty | cdk.IResolvable | undefined);
/**
* A description of the collaboration provided by the collaboration owner.
*/
get description(): string;
/**
* A description of the collaboration provided by the collaboration owner.
*/
set description(value: string);
get isMetricsEnabled(): boolean | cdk.IResolvable | undefined;
set isMetricsEnabled(value: boolean | cdk.IResolvable | undefined);
/**
* An indicator as to whether job logging has been enabled or disabled for the collaboration.
*/
get jobLogStatus(): string | undefined;
/**
* An indicator as to whether job logging has been enabled or disabled for the collaboration.
*/
set jobLogStatus(value: string | undefined);
/**
* A list of initial members, not including the creator.
*/
get members(): Array<cdk.IResolvable | CfnCollaboration.MemberSpecificationProperty> | cdk.IResolvable | undefined;
/**
* A list of initial members, not including the creator.
*/
set members(value: Array<cdk.IResolvable | CfnCollaboration.MemberSpecificationProperty> | cdk.IResolvable | undefined);
/**
* A human-readable identifier provided by the collaboration owner.
*/
get name(): string;
/**
* A human-readable identifier provided by the collaboration owner.
*/
set name(value: string);
/**
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*/
get queryLogStatus(): string;
/**
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*/
set queryLogStatus(value: string);
/**
* An optional label that you can assign to a resource when you create it.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* An optional label that you can assign to a resource when you create it.
*/
set tags(value: Array<cdk.CfnTag> | 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`
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* Returns the unique identifier of the specified collaboration.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`
*
* @cloudformationAttribute CollaborationIdentifier
*/
get attrCollaborationIdentifier(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnCollaboration {
/**
* The settings for client-side encryption for cryptographic computing.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html
*/
interface DataEncryptionMetadataProperty {
/**
* Indicates whether encrypted tables can contain cleartext data ( `TRUE` ) or are to cryptographically process every column ( `FALSE` ).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowcleartext
*/
readonly allowCleartext: boolean | cdk.IResolvable;
/**
* Indicates whether Fingerprint columns can contain duplicate entries ( `TRUE` ) or are to contain only non-repeated values ( `FALSE` ).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowduplicates
*/
readonly allowDuplicates: boolean | cdk.IResolvable;
/**
* 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` ).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowjoinsoncolumnswithdifferentnames
*/
readonly allowJoinsOnColumnsWithDifferentNames: boolean | cdk.IResolvable;
/**
* Indicates whether NULL values are to be copied as NULL to encrypted tables ( `TRUE` ) or cryptographically processed ( `FALSE` ).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-preservenulls
*/
readonly preserveNulls: boolean | cdk.IResolvable;
}
/**
* Basic metadata used to construct a new member.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html
*/
interface MemberSpecificationProperty {
/**
* The identifier used to reference members of the collaboration.
*
* Currently only supports AWS account ID.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-accountid
*/
readonly accountId: string;
/**
* The member's display name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-displayname
*/
readonly displayName: string;
/**
* The abilities granted to the collaboration member.
*
* *Allowed Values* : `CAN_QUERY` | `CAN_RECEIVE_RESULTS`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-memberabilities
*/
readonly memberAbilities?: Array<string>;
/**
* The ML abilities granted to the collaboration member.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-mlmemberabilities
*/
readonly mlMemberAbilities?: cdk.IResolvable | CfnCollaboration.MLMemberAbilitiesProperty;
/**
* 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-paymentconfiguration
*/
readonly paymentConfiguration?: cdk.IResolvable | CfnCollaboration.PaymentConfigurationProperty;
}
/**
* The ML member abilities for a collaboration member.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlmemberabilities.html
*/
interface MLMemberAbilitiesProperty {
/**
* The custom ML member abilities for a collaboration member.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlmemberabilities.html#cfn-cleanrooms-collaboration-mlmemberabilities-custommlmemberabilities
*/
readonly customMlMemberAbilities: Array<string>;
}
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html
*/
interface PaymentConfigurationProperty {
/**
* The compute configuration for the job.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-jobcompute
*/
readonly jobCompute?: cdk.IResolvable | CfnCollaboration.JobComputePaymentConfigProperty;
/**
* An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-machinelearning
*/
readonly machineLearning?: cdk.IResolvable | CfnCollaboration.MLPaymentConfigProperty;
/**
* The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-querycompute
*/
readonly queryCompute: cdk.IResolvable | CfnCollaboration.QueryComputePaymentConfigProperty;
}
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-jobcomputepaymentconfig.html
*/
interface JobComputePaymentConfigProperty {
/**
* Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( `TRUE` ) or has not configured the collaboration member to pay for query and job compute costs ( `FALSE` ).
*
* Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.
*
* An error is returned if the collaboration creator sets a `FALSE` value for the member who can run queries and jobs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-jobcomputepaymentconfig.html#cfn-cleanrooms-collaboration-jobcomputepaymentconfig-isresponsible
*/
readonly isResponsible: boolean | cdk.IResolvable;
}
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html
*/
interface QueryComputePaymentConfigProperty {
/**
* 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html#cfn-cleanrooms-collaboration-querycomputepaymentconfig-isresponsible
*/
readonly isResponsible: boolean | cdk.IResolvable;
}
/**
* An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html
*/
interface MLPaymentConfigProperty {
/**
* The payment responsibilities accepted by the member for model inference.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html#cfn-cleanrooms-collaboration-mlpaymentconfig-modelinference
*/
readonly modelInference?: cdk.IResolvable | CfnCollaboration.ModelInferencePaymentConfigProperty;
/**
* The payment responsibilities accepted by the member for model training.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html#cfn-cleanrooms-collaboration-mlpaymentconfig-modeltraining
*/
readonly modelTraining?: cdk.IResolvable | CfnCollaboration.ModelTrainingPaymentConfigProperty;
/**
* The payment configuration for machine learning synthetic data generation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html#cfn-cleanrooms-collaboration-mlpaymentconfig-syntheticdatageneration
*/
readonly syntheticDataGeneration?: cdk.IResolvable | CfnCollaboration.SyntheticDataGenerationPaymentConfigProperty;
}
/**
* An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-modeltrainingpaymentconfig.html
*/
interface ModelTrainingPaymentConfigProperty {
/**
* Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( `TRUE` ) or has not co