import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { CampaignReference, DatasetGroupReference, DatasetReference, EventTrackerReference, FilterReference, ICampaignRef, IDatasetGroupRef, IDatasetRef, IEventTrackerRef, IFilterRef, IMetricAttributionRef, ISchemaRef, ISolutionRef, MetricAttributionReference, SchemaReference, SolutionReference } from "../../interfaces/generated/aws-personalize-interfaces.generated"; /** * Creates an empty dataset and adds it to the specified dataset group. * * Use [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) to import your training data to a dataset. * * There are 5 types of datasets: * * - Item interactions * - Items * - Users * - Action interactions (you can't use CloudFormation to create an Action interactions dataset) * - Actions (you can't use CloudFormation to create an Actions dataset) * * Each dataset type has an associated schema with required field types. Only the `Item interactions` dataset is required in order to train a model (also referred to as creating a solution). * * A dataset can be in one of the following states: * * - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED * - DELETE PENDING > DELETE IN_PROGRESS * * To get the status of the dataset, call [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) . * * **Related APIs** - [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) * - [ListDatasets](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html) * - [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) * - [DeleteDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html) * * @cloudformationResource AWS::Personalize::Dataset * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html */ export declare class CfnDataset extends cdk.CfnResource implements cdk.IInspectable, IDatasetRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDataset 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): CfnDataset; /** * Checks whether the given object is a CfnDataset */ static isCfnDataset(x: any): x is CfnDataset; static arnForDataset(resource: IDatasetRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The Amazon Resource Name (ARN) of the dataset group. */ private _datasetGroupArn; /** * Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. */ private _datasetImportJob?; /** * One of the following values:. */ private _datasetType; /** * The name of the dataset. */ private _name; /** * The ARN of the associated schema. */ private _schemaArn; /** * The tags used to organize, track, or control access for this resource. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::Dataset`. * * @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: CfnDatasetProps); get datasetRef(): DatasetReference; /** * The Amazon Resource Name (ARN) of the dataset group. */ get datasetGroupArn(): string; /** * The Amazon Resource Name (ARN) of the dataset group. */ set datasetGroupArn(value: string); /** * Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. */ get datasetImportJob(): CfnDataset.DatasetImportJobProperty | cdk.IResolvable | undefined; /** * Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. */ set datasetImportJob(value: CfnDataset.DatasetImportJobProperty | cdk.IResolvable | undefined); /** * One of the following values:. */ get datasetType(): string; /** * One of the following values:. */ set datasetType(value: string); /** * The name of the dataset. */ get name(): string; /** * The name of the dataset. */ set name(value: string); /** * The ARN of the associated schema. */ get schemaArn(): string; /** * The ARN of the associated schema. */ set schemaArn(value: string); /** * The tags used to organize, track, or control access for this resource. */ get tags(): Array | undefined; /** * The tags used to organize, track, or control access for this resource. */ set tags(value: Array | undefined); /** * The Amazon Resource Name (ARN) of the dataset. * * @cloudformationAttribute DatasetArn */ get attrDatasetArn(): string; protected get cfnProperties(): Record; /** * 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): Record; } export declare namespace CfnDataset { /** * Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. * * A dataset import job can be in one of the following states: * * - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED * * If you specify a dataset import job as part of a dataset, all dataset import job fields are required. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html */ interface DatasetImportJobProperty { /** * The Amazon Resource Name (ARN) of the dataset that receives the imported data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-datasetarn */ readonly datasetArn?: string; /** * The ARN of the dataset import job. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-datasetimportjobarn */ readonly datasetImportJobArn?: string; /** * The Amazon S3 bucket that contains the training data to import. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-datasource */ readonly dataSource?: any | cdk.IResolvable; /** * The name of the import job. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-jobname */ readonly jobName?: string; /** * The ARN of the IAM role that has permissions to read from the Amazon S3 data source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-rolearn */ readonly roleArn?: string; } /** * Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html */ interface DataSourceProperty { /** * For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. * * For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete. * * For example: * * `s3://bucket-name/folder-name/fileName.csv` * * If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a `/` after the folder name: * * `s3://bucket-name/folder-name/` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html#cfn-personalize-dataset-datasource-datalocation */ readonly dataLocation?: string; } } /** * Properties for defining a `CfnDataset` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html */ export interface CfnDatasetProps { /** * The Amazon Resource Name (ARN) of the dataset group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasetgrouparn */ readonly datasetGroupArn: string; /** * Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. * * If you specify a dataset import job as part of a dataset, all dataset import job fields are required. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasetimportjob */ readonly datasetImportJob?: CfnDataset.DatasetImportJobProperty | cdk.IResolvable; /** * One of the following values:. * * - Interactions * - Items * - Users * * > You can't use CloudFormation to create an Action Interactions or Actions dataset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasettype */ readonly datasetType: string; /** * The name of the dataset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-name */ readonly name: string; /** * The ARN of the associated schema. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-schemaarn */ readonly schemaArn: string; /** * The tags used to organize, track, or control access for this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-tags */ readonly tags?: Array; } /** * A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). * * You create a dataset group by calling [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) . You then create a dataset and add it to a dataset group by calling [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) . The dataset group is used to create and train a solution by calling [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) . A dataset group can contain only one of each type of dataset. * * You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. * * @cloudformationResource AWS::Personalize::DatasetGroup * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html */ export declare class CfnDatasetGroup extends cdk.CfnResource implements cdk.IInspectable, IDatasetGroupRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDatasetGroup 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): CfnDatasetGroup; /** * Checks whether the given object is a CfnDatasetGroup */ static isCfnDatasetGroup(x: any): x is CfnDatasetGroup; static arnForDatasetGroup(resource: IDatasetGroupRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The domain of a Domain dataset group. */ private _domain?; /** * The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets. */ private _kmsKeyArn?; /** * The name of the dataset group. */ private _name; /** * The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. */ private _roleArn?; /** * The tags used to organize, track, or control access for this resource. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::DatasetGroup`. * * @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: CfnDatasetGroupProps); get datasetGroupRef(): DatasetGroupReference; /** * The domain of a Domain dataset group. */ get domain(): string | undefined; /** * The domain of a Domain dataset group. */ set domain(value: string | undefined); /** * The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets. */ get kmsKeyArn(): string | undefined; /** * The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets. */ set kmsKeyArn(value: string | undefined); /** * The name of the dataset group. */ get name(): string; /** * The name of the dataset group. */ set name(value: string); /** * The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. */ get roleArn(): string | undefined; /** * The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. */ set roleArn(value: string | undefined); /** * The tags used to organize, track, or control access for this resource. */ get tags(): Array | undefined; /** * The tags used to organize, track, or control access for this resource. */ set tags(value: Array | undefined); /** * The Amazon Resource Name (ARN) of the dataset group. * * @cloudformationAttribute DatasetGroupArn */ get attrDatasetGroupArn(): string; protected get cfnProperties(): Record; /** * 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): Record; } /** * Properties for defining a `CfnDatasetGroup` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html */ export interface CfnDatasetGroupProps { /** * The domain of a Domain dataset group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-domain */ readonly domain?: string; /** * The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-kmskeyarn */ readonly kmsKeyArn?: string; /** * The name of the dataset group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-name */ readonly name: string; /** * The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. * * Supplying an IAM role is only valid when also specifying a KMS key. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-rolearn */ readonly roleArn?: string; /** * The tags used to organize, track, or control access for this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-tags */ readonly tags?: Array; } /** * Creates an Amazon Personalize schema from the specified schema string. * * The schema you create must be in Avro JSON format. * * Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) . * * For more information on schemas, see [Datasets and schemas](https://docs.aws.amazon.com/personalize/latest/dg/how-it-works-dataset-schema.html) . * * **Related APIs** - [ListSchemas](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html) * - [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) * - [DeleteSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html) * * @cloudformationResource AWS::Personalize::Schema * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html */ export declare class CfnSchema extends cdk.CfnResource implements cdk.IInspectable, ISchemaRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnSchema 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): CfnSchema; /** * Checks whether the given object is a CfnSchema */ static isCfnSchema(x: any): x is CfnSchema; static arnForSchema(resource: ISchemaRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The domain of a schema that you created for a dataset in a Domain dataset group. */ private _domain?; /** * The name of the schema. */ private _name; /** * The schema. */ private _schema; /** * The tags used to organize, track, or control access for this resource. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::Schema`. * * @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: CfnSchemaProps); get schemaRef(): SchemaReference; /** * The domain of a schema that you created for a dataset in a Domain dataset group. */ get domain(): string | undefined; /** * The domain of a schema that you created for a dataset in a Domain dataset group. */ set domain(value: string | undefined); /** * The name of the schema. */ get name(): string; /** * The name of the schema. */ set name(value: string); /** * The schema. */ get schema(): string; /** * The schema. */ set schema(value: string); /** * The tags used to organize, track, or control access for this resource. */ get tags(): Array | undefined; /** * The tags used to organize, track, or control access for this resource. */ set tags(value: Array | undefined); /** * The Amazon Resource Name (ARN) of the schema. * * @cloudformationAttribute SchemaArn */ get attrSchemaArn(): string; protected get cfnProperties(): Record; /** * 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): Record; } /** * Properties for defining a `CfnSchema` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html */ export interface CfnSchemaProps { /** * The domain of a schema that you created for a dataset in a Domain dataset group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#cfn-personalize-schema-domain */ readonly domain?: string; /** * The name of the schema. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#cfn-personalize-schema-name */ readonly name: string; /** * The schema. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#cfn-personalize-schema-schema */ readonly schema: string; /** * The tags used to organize, track, or control access for this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#cfn-personalize-schema-tags */ readonly tags?: Array; } /** * > By default, all new solutions use automatic training. * * With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can [update the solution](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) to turn off automatic training. For information about training costs, see [Amazon Personalize pricing](https://docs.aws.amazon.com/https://aws.amazon.com/personalize/pricing/) . * * An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations. * * After you create a solution, you can’t change its configuration. If you need to make changes, you can [clone the solution](https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html) with the Amazon Personalize console or create a new one. * * @cloudformationResource AWS::Personalize::Solution * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html */ export declare class CfnSolution extends cdk.CfnResource implements cdk.IInspectable, ISolutionRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnSolution 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): CfnSolution; /** * Checks whether the given object is a CfnSolution */ static isCfnSolution(x: any): x is CfnSolution; static arnForSolution(resource: ISolutionRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The Amazon Resource Name (ARN) of the dataset group that provides the training data. */ private _datasetGroupArn; /** * The event type (for example, 'click' or 'like') that is used for training the model. */ private _eventType?; /** * The name of the solution. */ private _name; /** * > We don't recommend enabling automated machine learning. */ private _performAutoMl?; /** * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. */ private _performHpo?; /** * The ARN of the recipe used to create the solution. */ private _recipeArn?; /** * Describes the configuration properties for the solution. */ private _solutionConfig?; /** * The tags used to organize, track, or control access for this resource. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::Solution`. * * @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: CfnSolutionProps); get solutionRef(): SolutionReference; /** * The Amazon Resource Name (ARN) of the dataset group that provides the training data. */ get datasetGroupArn(): string; /** * The Amazon Resource Name (ARN) of the dataset group that provides the training data. */ set datasetGroupArn(value: string); /** * The event type (for example, 'click' or 'like') that is used for training the model. */ get eventType(): string | undefined; /** * The event type (for example, 'click' or 'like') that is used for training the model. */ set eventType(value: string | undefined); /** * The name of the solution. */ get name(): string; /** * The name of the solution. */ set name(value: string); /** * > We don't recommend enabling automated machine learning. */ get performAutoMl(): boolean | cdk.IResolvable | undefined; /** * > We don't recommend enabling automated machine learning. */ set performAutoMl(value: boolean | cdk.IResolvable | undefined); /** * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. */ get performHpo(): boolean | cdk.IResolvable | undefined; /** * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. */ set performHpo(value: boolean | cdk.IResolvable | undefined); /** * The ARN of the recipe used to create the solution. */ get recipeArn(): string | undefined; /** * The ARN of the recipe used to create the solution. */ set recipeArn(value: string | undefined); /** * Describes the configuration properties for the solution. */ get solutionConfig(): cdk.IResolvable | CfnSolution.SolutionConfigProperty | undefined; /** * Describes the configuration properties for the solution. */ set solutionConfig(value: cdk.IResolvable | CfnSolution.SolutionConfigProperty | undefined); /** * The tags used to organize, track, or control access for this resource. */ get tags(): Array | undefined; /** * The tags used to organize, track, or control access for this resource. */ set tags(value: Array | undefined); /** * The Amazon Resource Name (ARN) of the solution. * * @cloudformationAttribute SolutionArn */ get attrSolutionArn(): string; protected get cfnProperties(): Record; /** * 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): Record; } export declare namespace CfnSolution { /** * Describes the configuration properties for the solution. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html */ interface SolutionConfigProperty { /** * Lists the algorithm hyperparameters and their values. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-algorithmhyperparameters */ readonly algorithmHyperParameters?: cdk.IResolvable | Record; /** * The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-automlconfig */ readonly autoMlConfig?: any | cdk.IResolvable; /** * Only events with a value greater than or equal to this threshold are used for training a model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-eventvaluethreshold */ readonly eventValueThreshold?: string; /** * Lists the feature transformation parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-featuretransformationparameters */ readonly featureTransformationParameters?: cdk.IResolvable | Record; /** * Describes the properties for hyperparameter optimization (HPO). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-hpoconfig */ readonly hpoConfig?: any | cdk.IResolvable; } /** * Specifies the hyperparameters and their ranges. * * Hyperparameters can be categorical, continuous, or integer-valued. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html */ interface AlgorithmHyperParameterRangesProperty { /** * Provides the name and range of a categorical hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html#cfn-personalize-solution-algorithmhyperparameterranges-categoricalhyperparameterranges */ readonly categoricalHyperParameterRanges?: Array | cdk.IResolvable; /** * Provides the name and range of a continuous hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html#cfn-personalize-solution-algorithmhyperparameterranges-continuoushyperparameterranges */ readonly continuousHyperParameterRanges?: Array | cdk.IResolvable; /** * Provides the name and range of an integer-valued hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html#cfn-personalize-solution-algorithmhyperparameterranges-integerhyperparameterranges */ readonly integerHyperParameterRanges?: Array | cdk.IResolvable; } /** * Provides the name and range of an integer-valued hyperparameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html */ interface IntegerHyperParameterRangeProperty { /** * The maximum allowable value for the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-maxvalue */ readonly maxValue?: number; /** * The minimum allowable value for the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-minvalue */ readonly minValue?: number; /** * The name of the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-name */ readonly name?: string; } /** * Provides the name and range of a categorical hyperparameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html */ interface CategoricalHyperParameterRangeProperty { /** * The name of the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html#cfn-personalize-solution-categoricalhyperparameterrange-name */ readonly name?: string; /** * A list of the categories for the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html#cfn-personalize-solution-categoricalhyperparameterrange-values */ readonly values?: Array; } /** * Provides the name and range of a continuous hyperparameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html */ interface ContinuousHyperParameterRangeProperty { /** * The maximum allowable value for the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-maxvalue */ readonly maxValue?: number; /** * The minimum allowable value for the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-minvalue */ readonly minValue?: number; /** * The name of the hyperparameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-name */ readonly name?: string; } /** * When the solution performs AutoML ( `performAutoML` is true in [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) ), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html */ interface AutoMLConfigProperty { /** * The metric to optimize. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html#cfn-personalize-solution-automlconfig-metricname */ readonly metricName?: string; /** * The list of candidate recipes. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html#cfn-personalize-solution-automlconfig-recipelist */ readonly recipeList?: Array; } /** * Describes the properties for hyperparameter optimization (HPO). * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html */ interface HpoConfigProperty { /** * The hyperparameters and their allowable ranges. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-algorithmhyperparameterranges */ readonly algorithmHyperParameterRanges?: CfnSolution.AlgorithmHyperParameterRangesProperty | cdk.IResolvable; /** * The metric to optimize during HPO. * * > Amazon Personalize doesn't support configuring the `hpoObjective` at this time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-hpoobjective */ readonly hpoObjective?: CfnSolution.HpoObjectiveProperty | cdk.IResolvable; /** * Describes the resource configuration for HPO. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-hporesourceconfig */ readonly hpoResourceConfig?: CfnSolution.HpoResourceConfigProperty | cdk.IResolvable; } /** * Describes the resource configuration for hyperparameter optimization (HPO). * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html */ interface HpoResourceConfigProperty { /** * The maximum number of training jobs when you create a solution version. * * The maximum value for `maxNumberOfTrainingJobs` is `40` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html#cfn-personalize-solution-hporesourceconfig-maxnumberoftrainingjobs */ readonly maxNumberOfTrainingJobs?: string; /** * The maximum number of parallel training jobs when you create a solution version. * * The maximum value for `maxParallelTrainingJobs` is `10` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html#cfn-personalize-solution-hporesourceconfig-maxparalleltrainingjobs */ readonly maxParallelTrainingJobs?: string; } /** * The metric to optimize during hyperparameter optimization (HPO). * * > Amazon Personalize doesn't support configuring the `hpoObjective` at this time. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html */ interface HpoObjectiveProperty { /** * The name of the metric. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricname */ readonly metricName?: string; /** * A regular expression for finding the metric in the training job logs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricregex */ readonly metricRegex?: string; /** * The type of the metric. * * Valid values are `Maximize` and `Minimize` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-type */ readonly type?: string; } } /** * Properties for defining a `CfnSolution` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html */ export interface CfnSolutionProps { /** * The Amazon Resource Name (ARN) of the dataset group that provides the training data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-datasetgrouparn */ readonly datasetGroupArn: string; /** * The event type (for example, 'click' or 'like') that is used for training the model. * * If no `eventType` is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-eventtype */ readonly eventType?: string; /** * The name of the solution. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-name */ readonly name: string; /** * > We don't recommend enabling automated machine learning. * * Instead, match your use case to the available Amazon Personalize recipes. For more information, see [Determining your use case.](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html) * * When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration ( `recipeArn` must not be specified). When false (the default), Amazon Personalize uses `recipeArn` for training. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-performautoml */ readonly performAutoMl?: boolean | cdk.IResolvable; /** * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. * * The default is `false` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-performhpo */ readonly performHpo?: boolean | cdk.IResolvable; /** * The ARN of the recipe used to create the solution. * * This is required when `performAutoML` is false. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-recipearn */ readonly recipeArn?: string; /** * Describes the configuration properties for the solution. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-solutionconfig */ readonly solutionConfig?: cdk.IResolvable | CfnSolution.SolutionConfigProperty; /** * The tags used to organize, track, or control access for this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-tags */ readonly tags?: Array; } /** * A deployment of a solution version that provides real-time recommendations. * * @cloudformationResource AWS::Personalize::Campaign * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-campaign.html */ export declare class CfnCampaign extends cdk.CfnResource implements cdk.IInspectable, ICampaignRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnCampaign 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): CfnCampaign; /** * Checks whether the given object is a CfnCampaign */ static isCfnCampaign(x: any): x is CfnCampaign; static arnForCampaign(resource: ICampaignRef): string; /** * The configuration details of a campaign. */ private _campaignConfig?; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * Specifies the requested minimum provisioned transactions per second. */ private _minProvisionedTps?; /** * The name of the campaign. */ private _name; /** * The ARN of the solution version to deploy. */ private _solutionVersionArn; /** * Tags to associate with the campaign. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::Campaign`. * * @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: CfnCampaignProps); get campaignRef(): CampaignReference; /** * The configuration details of a campaign. */ get campaignConfig(): CfnCampaign.CampaignConfigProperty | cdk.IResolvable | undefined; /** * The configuration details of a campaign. */ set campaignConfig(value: CfnCampaign.CampaignConfigProperty | cdk.IResolvable | undefined); /** * Specifies the requested minimum provisioned transactions per second. */ get minProvisionedTps(): number | undefined; /** * Specifies the requested minimum provisioned transactions per second. */ set minProvisionedTps(value: number | undefined); /** * The name of the campaign. */ get name(): string; /** * The name of the campaign. */ set name(value: string); /** * The ARN of the solution version to deploy. */ get solutionVersionArn(): string; /** * The ARN of the solution version to deploy. */ set solutionVersionArn(value: string); /** * Tags to associate with the campaign. */ get tags(): Array | undefined; /** * Tags to associate with the campaign. */ set tags(value: Array | undefined); /** * The ARN of the campaign. * * @cloudformationAttribute CampaignArn */ get attrCampaignArn(): string; /** * The time at which the campaign was created. * * @cloudformationAttribute CreationDateTime */ get attrCreationDateTime(): string; /** * The time at which the campaign was last updated. * * @cloudformationAttribute LastUpdatedDateTime */ get attrLastUpdatedDateTime(): string; /** * The status of the campaign. * * @cloudformationAttribute Status */ get attrStatus(): string; protected get cfnProperties(): Record; /** * 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): Record; } export declare namespace CfnCampaign { /** * The configuration details of a campaign. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-campaign-campaignconfig.html */ interface CampaignConfigProperty { /** * Whether metadata with recommendations is enabled for the campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-campaign-campaignconfig.html#cfn-personalize-campaign-campaignconfig-enablemetadatawithrecommendations */ readonly enableMetadataWithRecommendations?: boolean | cdk.IResolvable; /** * Specifies the exploration configuration hyperparameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-campaign-campaignconfig.html#cfn-personalize-campaign-campaignconfig-itemexplorationconfig */ readonly itemExplorationConfig?: cdk.IResolvable | Record; /** * A map of ranking influence values for POPULARITY and FRESHNESS. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-campaign-campaignconfig.html#cfn-personalize-campaign-campaignconfig-rankinginfluence */ readonly rankingInfluence?: cdk.IResolvable | Record; /** * Whether the campaign automatically updates to use the latest solution version. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-campaign-campaignconfig.html#cfn-personalize-campaign-campaignconfig-syncwithlatestsolutionversion */ readonly syncWithLatestSolutionVersion?: boolean | cdk.IResolvable; } } /** * Properties for defining a `CfnCampaign` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-campaign.html */ export interface CfnCampaignProps { /** * The configuration details of a campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-campaign.html#cfn-personalize-campaign-campaignconfig */ readonly campaignConfig?: CfnCampaign.CampaignConfigProperty | cdk.IResolvable; /** * Specifies the requested minimum provisioned transactions per second. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-campaign.html#cfn-personalize-campaign-minprovisionedtps */ readonly minProvisionedTps?: number; /** * The name of the campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-campaign.html#cfn-personalize-campaign-name */ readonly name: string; /** * The ARN of the solution version to deploy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-campaign.html#cfn-personalize-campaign-solutionversionarn */ readonly solutionVersionArn: string; /** * Tags to associate with the campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-campaign.html#cfn-personalize-campaign-tags */ readonly tags?: Array; } /** * Resource schema for AWS::Personalize::EventTracker. * * @cloudformationResource AWS::Personalize::EventTracker * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-eventtracker.html */ export declare class CfnEventTracker extends cdk.CfnResource implements cdk.IInspectable, IEventTrackerRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnEventTracker 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): CfnEventTracker; /** * Checks whether the given object is a CfnEventTracker */ static isCfnEventTracker(x: any): x is CfnEventTracker; static arnForEventTracker(resource: IEventTrackerRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The Amazon Resource Name (ARN) of the dataset group that receives the event data. */ private _datasetGroupArn; /** * The name for the event tracker. */ private _name; /** * A list of tags to apply to the event tracker. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::EventTracker`. * * @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: CfnEventTrackerProps); get eventTrackerRef(): EventTrackerReference; /** * The Amazon Resource Name (ARN) of the dataset group that receives the event data. */ get datasetGroupArn(): string; /** * The Amazon Resource Name (ARN) of the dataset group that receives the event data. */ set datasetGroupArn(value: string); /** * The name for the event tracker. */ get name(): string; /** * The name for the event tracker. */ set name(value: string); /** * A list of tags to apply to the event tracker. */ get tags(): Array | undefined; /** * A list of tags to apply to the event tracker. */ set tags(value: Array | undefined); /** * The Amazon Resource Name (ARN) of the event tracker. * * @cloudformationAttribute EventTrackerArn */ get attrEventTrackerArn(): string; /** * The ID of the event tracker. Include this ID in requests to the PutEvents API. * * @cloudformationAttribute TrackingId */ get attrTrackingId(): string; protected get cfnProperties(): Record; /** * 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): Record; } /** * Properties for defining a `CfnEventTracker` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-eventtracker.html */ export interface CfnEventTrackerProps { /** * The Amazon Resource Name (ARN) of the dataset group that receives the event data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-eventtracker.html#cfn-personalize-eventtracker-datasetgrouparn */ readonly datasetGroupArn: string; /** * The name for the event tracker. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-eventtracker.html#cfn-personalize-eventtracker-name */ readonly name: string; /** * A list of tags to apply to the event tracker. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-eventtracker.html#cfn-personalize-eventtracker-tags */ readonly tags?: Array; } /** * A recommendation filter that defines which items are included or excluded from recommendations. * * @cloudformationResource AWS::Personalize::Filter * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-filter.html */ export declare class CfnFilter extends cdk.CfnResource implements cdk.IInspectable, IFilterRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFilter 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): CfnFilter; /** * Checks whether the given object is a CfnFilter */ static isCfnFilter(x: any): x is CfnFilter; static arnForFilter(resource: IFilterRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The ARN of the dataset group that the filter belongs to. */ private _datasetGroupArn; /** * The filter expression that defines which items are included or excluded from recommendations. */ private _filterExpression; /** * The name of the filter. */ private _name; /** * Tags to associate with the filter. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::Filter`. * * @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: CfnFilterProps); get filterRef(): FilterReference; /** * The ARN of the dataset group that the filter belongs to. */ get datasetGroupArn(): string; /** * The ARN of the dataset group that the filter belongs to. */ set datasetGroupArn(value: string); /** * The filter expression that defines which items are included or excluded from recommendations. */ get filterExpression(): string; /** * The filter expression that defines which items are included or excluded from recommendations. */ set filterExpression(value: string); /** * The name of the filter. */ get name(): string; /** * The name of the filter. */ set name(value: string); /** * Tags to associate with the filter. */ get tags(): Array | undefined; /** * Tags to associate with the filter. */ set tags(value: Array | undefined); /** * The time at which the filter was created. * * @cloudformationAttribute CreationDateTime */ get attrCreationDateTime(): string; /** * The ARN of the filter. * * @cloudformationAttribute FilterArn */ get attrFilterArn(): string; /** * The time at which the filter was last updated. * * @cloudformationAttribute LastUpdatedDateTime */ get attrLastUpdatedDateTime(): string; /** * The status of the filter. * * @cloudformationAttribute Status */ get attrStatus(): string; protected get cfnProperties(): Record; /** * 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): Record; } /** * Properties for defining a `CfnFilter` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-filter.html */ export interface CfnFilterProps { /** * The ARN of the dataset group that the filter belongs to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-filter.html#cfn-personalize-filter-datasetgrouparn */ readonly datasetGroupArn: string; /** * The filter expression that defines which items are included or excluded from recommendations. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-filter.html#cfn-personalize-filter-filterexpression */ readonly filterExpression: string; /** * The name of the filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-filter.html#cfn-personalize-filter-name */ readonly name: string; /** * Tags to associate with the filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-filter.html#cfn-personalize-filter-tags */ readonly tags?: Array; } /** * Creates a metric attribution for reporting on recommendation impact in Amazon Personalize. * * @cloudformationResource AWS::Personalize::MetricAttribution * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-metricattribution.html */ export declare class CfnMetricAttribution extends cdk.CfnResource implements cdk.IInspectable, IMetricAttributionRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnMetricAttribution 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): CfnMetricAttribution; /** * Checks whether the given object is a CfnMetricAttribution */ static isCfnMetricAttribution(x: any): x is CfnMetricAttribution; static arnForMetricAttribution(resource: IMetricAttributionRef): string; /** * The ARN of the destination dataset group. */ private _datasetGroupArn; /** * A list of metric attributes for the metric attribution. */ private _metrics; /** * The output configuration details for the metric attribution. */ private _metricsOutputConfig; /** * The name of the metric attribution. */ private _name; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::Personalize::MetricAttribution`. * * @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: CfnMetricAttributionProps); get metricAttributionRef(): MetricAttributionReference; /** * The ARN of the destination dataset group. */ get datasetGroupArn(): string; /** * The ARN of the destination dataset group. */ set datasetGroupArn(value: string); /** * A list of metric attributes for the metric attribution. */ get metrics(): Array | cdk.IResolvable; /** * A list of metric attributes for the metric attribution. */ set metrics(value: Array | cdk.IResolvable); /** * The output configuration details for the metric attribution. */ get metricsOutputConfig(): cdk.IResolvable | CfnMetricAttribution.MetricsOutputConfigProperty; /** * The output configuration details for the metric attribution. */ set metricsOutputConfig(value: cdk.IResolvable | CfnMetricAttribution.MetricsOutputConfigProperty); /** * The name of the metric attribution. */ get name(): string; /** * The name of the metric attribution. */ set name(value: string); /** * The ARN of the metric attribution. * * @cloudformationAttribute MetricAttributionArn */ get attrMetricAttributionArn(): string; /** * The status of the metric attribution. * * @cloudformationAttribute Status */ get attrStatus(): string; protected get cfnProperties(): Record; /** * 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): Record; } export declare namespace CfnMetricAttribution { /** * A metric attribute for the metric attribution. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.html */ interface MetricAttributeProperty { /** * The metric's event type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.html#cfn-personalize-metricattribution-metricattribute-eventtype */ readonly eventType: string; /** * The attribute's expression. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.html#cfn-personalize-metricattribution-metricattribute-expression */ readonly expression: string; /** * The metric's name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.html#cfn-personalize-metricattribution-metricattribute-metricname */ readonly metricName: string; } /** * The output configuration details for the metric attribution. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricsoutputconfig.html */ interface MetricsOutputConfigProperty { /** * The ARN of the IAM role for the metric attribution. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricsoutputconfig.html#cfn-personalize-metricattribution-metricsoutputconfig-rolearn */ readonly roleArn: string; /** * The configuration details of an Amazon S3 output bucket. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricsoutputconfig.html#cfn-personalize-metricattribution-metricsoutputconfig-s3datadestination */ readonly s3DataDestination?: cdk.IResolvable | CfnMetricAttribution.S3DataDestinationProperty; } /** * The configuration details of an Amazon S3 output bucket. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-s3datadestination.html */ interface S3DataDestinationProperty { /** * The ARN of the KMS key. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-s3datadestination.html#cfn-personalize-metricattribution-s3datadestination-kmskeyarn */ readonly kmsKeyArn?: string; /** * The file path of the Amazon S3 bucket. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-s3datadestination.html#cfn-personalize-metricattribution-s3datadestination-path */ readonly path: string; } } /** * Properties for defining a `CfnMetricAttribution` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-metricattribution.html */ export interface CfnMetricAttributionProps { /** * The ARN of the destination dataset group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-metricattribution.html#cfn-personalize-metricattribution-datasetgrouparn */ readonly datasetGroupArn: string; /** * A list of metric attributes for the metric attribution. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-metricattribution.html#cfn-personalize-metricattribution-metrics */ readonly metrics: Array | cdk.IResolvable; /** * The output configuration details for the metric attribution. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-metricattribution.html#cfn-personalize-metricattribution-metricsoutputconfig */ readonly metricsOutputConfig: cdk.IResolvable | CfnMetricAttribution.MetricsOutputConfigProperty; /** * The name of the metric attribution. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-metricattribution.html#cfn-personalize-metricattribution-name */ readonly name: string; } export type { IDatasetRef, DatasetReference }; export type { IDatasetGroupRef, DatasetGroupReference }; export type { ISchemaRef, SchemaReference }; export type { ISolutionRef, SolutionReference }; export type { ICampaignRef, CampaignReference }; export type { IEventTrackerRef, EventTrackerReference }; export type { IFilterRef, FilterReference }; export type { IMetricAttributionRef, MetricAttributionReference };