aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,024 lines • 137 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* 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, 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;
/**
* Returns the identifier for the analysis template.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`
*
* @cloudformationAttribute AnalysisTemplateIdentifier
*/
readonly 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
*/
readonly 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
*/
readonly attrCollaborationArn: string;
/**
* Returns the unique ID for the associated collaboration of the analysis template.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`
*
* @cloudformationAttribute CollaborationIdentifier
*/
readonly 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
*/
readonly attrMembershipArn: string;
/**
* @cloudformationAttribute Schema
*/
readonly attrSchema: cdk.IResolvable;
/**
* @cloudformationAttribute Schema.ReferencedTables
*/
readonly attrSchemaReferencedTables: Array<string>;
/**
* The parameters of the analysis template.
*/
analysisParameters?: Array<CfnAnalysisTemplate.AnalysisParameterProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the analysis template.
*/
description?: string;
/**
* The format of the analysis template.
*/
format: string;
/**
* The identifier for a membership resource.
*/
membershipIdentifier: string;
/**
* The name of the analysis template.
*/
name: string;
/**
* The entire schema object.
*/
schema?: CfnAnalysisTemplate.AnalysisSchemaProperty | cdk.IResolvable;
/**
* The source of the analysis template.
*/
source: CfnAnalysisTemplate.AnalysisSourceProperty | cdk.IResolvable;
/**
* The source metadata for the analysis template.
*/
sourceMetadata?: CfnAnalysisTemplate.AnalysisSourceMetadataProperty | cdk.IResolvable;
/**
* An optional label that you can assign to a resource when you create it.
*/
tags?: Array<cdk.CfnTag>;
/**
* @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);
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;
}
}
/**
* 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 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;
/**
* 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, 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;
/**
* 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
*/
readonly attrArn: string;
/**
* Returns the unique identifier of the specified collaboration.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`
*
* @cloudformationAttribute CollaborationIdentifier
*/
readonly attrCollaborationIdentifier: string;
/**
* The analytics engine for the collaboration.
*/
analyticsEngine?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* A display name of the collaboration creator.
*/
creatorDisplayName: string;
/**
* The abilities granted to the collaboration creator.
*/
creatorMemberAbilities: Array<string>;
/**
* The ML member abilities for a collaboration member.
*/
creatorMlMemberAbilities?: cdk.IResolvable | CfnCollaboration.MLMemberAbilitiesProperty;
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*/
creatorPaymentConfiguration?: cdk.IResolvable | CfnCollaboration.PaymentConfigurationProperty;
/**
* The settings for client-side encryption for cryptographic computing.
*/
dataEncryptionMetadata?: CfnCollaboration.DataEncryptionMetadataProperty | cdk.IResolvable;
/**
* A description of the collaboration provided by the collaboration owner.
*/
description: string;
/**
* An indicator as to whether job logging has been enabled or disabled for the collaboration.
*/
jobLogStatus?: string;
/**
* A list of initial members, not including the creator.
*/
members: Array<cdk.IResolvable | CfnCollaboration.MemberSpecificationProperty> | cdk.IResolvable;
/**
* A human-readable identifier provided by the collaboration owner.
*/
name: string;
/**
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*/
queryLogStatus: string;
/**
* An optional label that you can assign to a resource when you create it.
*/
tags?: Array<cdk.CfnTag>;
/**
* @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);
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;
}
/**
* 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 configured the collaboration member to pay for model training costs ( `FALSE` ).
*
* Exactly one member can be configured to pay for model training 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 model training 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-modeltrainingpaymentconfig.html#cfn-cleanrooms-collaboration-modeltrainingpaymentconfig-isresponsible
*/
readonly isResponsible: boolean | cdk.IResolvable;
}
/**
* An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-modelinferencepaymentconfig.html
*/
interface ModelInferencePaymentConfigProperty {
/**
* Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( `TRUE` ) or has not configured the collaboration member to pay for model inference costs ( `FALSE` ).
*
* Exactly one member can be configured to pay for model inference 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 model inference 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-modelinferencepaymentconfig.html#cfn-cleanrooms-collaboration-modelinferencepaymentconfig-isresponsible
*/
readonly isResponsible: boolean | cdk.IResolvable;
}
}
/**
* Properties for defining a `CfnCollaboration`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html
*/
export interface CfnCollaborationProps {
/**
* The analytics engine for the collaboration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-analyticsengine
*/
readonly analyticsEngine?: string;
/**
* A display name of the collaboration creator.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatordisplayname
*/
readonly creatorDisplayName: string;
/**
* The abilities granted to the collaboration creator.
*
* *Allowed values* `CAN_QUERY` | `CAN_RECEIVE_RESULTS` | `CAN_RUN_JOB`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatormemberabilities
*/
readonly creatorMemberAbilities: Array<string>;
/**
* The ML member abilities for a collaboration member.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatormlmemberabilities
*/
readonly creatorMlMemberAbilities?: cdk.IResolvable | CfnCollaboration.MLMemberAbilitiesProperty;
/**
* An object representing the collaboration member's payment responsibilities set by the collaboration creator.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatorpaymentconfiguration
*/
readonly creatorPaymentConfiguration?: cdk.IResolvable | CfnCollaboration.PaymentConfigurationProperty;
/**
* The settings for client-side encryption for cryptographic computing.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-dataencryptionmetadata
*/
readonly dataEncryptionMetadata?: CfnCollaboration.DataEncryptionMetadataProperty | cdk.IResolvable;
/**
* A description of the collaboration provided by the collaboration owner.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-description
*/
readonly description: 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` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-joblogstatus
*/
readonly jobLogStatus?: string;
/**
* A list of initial members, not including the creator.
*
* This list is immutable.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-members
*/
readonly members: Array<cdk.IResolvable | CfnCollaboration.MemberSpecificationProperty> | cdk.IResolvable;
/**
* A human-readable identifier provided by the collaboration owner.
*
* Display names are not unique.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-name
*/
readonly name: 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` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-querylogstatus
*/
readonly queryLogStatus: string;
/**
* 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-collaboration.html#cfn-cleanrooms-collaboration-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Creates a new configured table resource.
*
* @cloudformationResource AWS::CleanRooms::ConfiguredTable
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html
*/
export declare class CfnConfiguredTable extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnConfiguredTable 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): CfnConfiguredTable;
/**
* Returns the Amazon Resource Name (ARN) of the specified configured table.
*
* Example: `arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* Returns the unique identifier of the specified configured table.
*
* Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`
*
* @cloudformationAttribute ConfiguredTableIdentifier
*/
readonly attrConfiguredTableIdentifier: string;
/**
* The columns within the underlying AWS Glue table that can be utilized within collaborations.
*/
allowedColumns: Array<string>;
/**
* The analysis method for the configured table.
*/
analysisMethod: string;
/**
* The analysis rule that was created for the configured table.
*/
analysisRules?: Array<CfnConfiguredTable.AnalysisRuleProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* A description for the configured table.
*/
description?: string;
/**
* A name for the configured table.
*/
name: string;
/**
* The selected analysis methods for the configured table.
*/
selectedAnalysisMethods?: Array<string>;
/**
* The table that this configured table represents.
*/
tableReference: cdk.IResolvable | CfnConfiguredTable.TableReferenceProperty;
/**
* An optional label that you can assign to a resource when you create it.
*/
tags?: Array<cdk.CfnTag>;
/**
* @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: CfnConfiguredTableProps);
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 CfnConfiguredTable {
/**
* A pointer to the dataset that underlies this table.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html
*/
interface TableReferenceProperty {
/**
* If present, a reference to the Athena table referred to by this table reference.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html#cfn-cleanrooms-configuredtable-tablereference-athena
*/
readonly athena?: CfnConfiguredTable.AthenaTableReferenceProperty | cdk.IResolvable;
/**
* If present, a reference to the AWS Glue table referred to by this table reference.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html#cfn-cleanrooms-configuredtable-tablereference-glue
*/
readonly glue?: CfnConfiguredTable.GlueTableReferenceProperty | cdk.IResolvable;
/**
* If present, a reference to the Snowflake table referred to by this table reference.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html#cfn-cleanrooms-configuredtable-tablereference-snowflake
*/
readonly snowflake?: cdk.IResolvable | CfnConfiguredTable.SnowflakeTableReferenceProperty;
}
/**
* A reference to a table within an AWS Glue data catalog.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html
*/
interface GlueTableReferenceProperty {
/**
* The name of the database the AWS Glue table belongs to.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html#cfn-cleanrooms-configuredtable-gluetablereference-databasename
*/
readonly databaseName: string;
/**
* The name of the AWS Glue table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html#cfn-cleanrooms-configuredtable-gluetablereference-tablename
*/
readonly tableName: string;
}
/**
* A reference to a table within Snowflake.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html
*/
interface SnowflakeTableReferenceProperty {
/**
* The account identifier for the Snowflake table reference.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-accountidentifier
*/
readonly accountIdentifier: string;
/**
* The name of the database the Snowflake table belongs to.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-databasename
*/
readonly databaseName: string;
/**
* The schema name of the Snowflake table reference.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-schemaname
*/
readonly schemaName: string;
/**
* The secret ARN of the Snowflake table reference.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-secretarn
*/
readonly secretArn: string;
/**
* The name of the Snowflake table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-tablename
*/
readonly tableName: string;
/**
* The schema of the Snowflake table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-tableschema
*/
readonly tableSchema: cdk.IResolvable | CfnConfiguredTable.SnowflakeTableSchemaProperty;
}
/**
* The schema of a Snowflake table.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschema.html
*/
interface SnowflakeTableSchemaProperty {
/**
* The schema of a Snowflake table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschema.html#cfn-cleanrooms-configuredtable-snowflaketableschema-v1
*/
readonly v1: Array<cdk.IResolvable | CfnConfiguredTable.SnowflakeTableSchemaV1Property> | cdk.IResolvable;
}
/**
* The Snowflake table schema.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.html
*/
interface SnowflakeTableSchemaV1Property {
/**
* The column name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.html#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columnname
*/
readonly columnName: string;
/**
* The column's data type.
*
* Supported data types: `ARRAY` , `BIGINT` , `BOOLEAN` , `CHAR` , `DATE` , `DECIMAL` , `DOUBLE` , `DOUBLE PRECISION` , `FLOAT` , `FLOAT4` , `INT` , `INTEGER` , `MAP` , `NUMERIC` , `NUMBER` , `REAL` , `SMALLINT` , `STRING` , `TIMESTAMP` , `TIMESTAMP_LTZ` , `TIMESTAMP_NTZ` , `DATETIME` , `TINYINT` , `VARCHAR` , `TEXT` , `CHARACTER` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.html#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columntype
*/
readonly columnType: string;
}
/**
* A reference to a table within Athena.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html
*/
interface