464 lines
21 KiB
TypeScript
464 lines
21 KiB
TypeScript
import * as cdk from "../../core/lib";
|
|
import * as constructs from "constructs";
|
|
import * as cfn_parse from "../../core/lib/helpers-internal";
|
|
import { DatasetGroupReference, DatasetReference, IDatasetGroupRef, IDatasetRef } from "../../interfaces/generated/aws-forecast-interfaces.generated";
|
|
/**
|
|
* Creates an Amazon Forecast dataset.
|
|
*
|
|
* > Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](https://docs.aws.amazon.com/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)
|
|
*
|
|
* The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:
|
|
*
|
|
* - *`DataFrequency`* - How frequently your historical time-series data is collected.
|
|
* - *`Domain`* and *`DatasetType`* - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.
|
|
* - *`Schema`* - A schema specifies the fields in the dataset, including the field name and data type.
|
|
*
|
|
* After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see [Importing datasets](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) .
|
|
*
|
|
* To get a list of all your datasets, use the [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation.
|
|
*
|
|
* For example Forecast datasets, see the [Amazon Forecast Sample GitHub repository](https://docs.aws.amazon.com/https://github.com/aws-samples/amazon-forecast-samples) .
|
|
*
|
|
* > The `Status` of a dataset must be `ACTIVE` before you can import training data. Use the [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation to get the status.
|
|
*
|
|
* @cloudformationResource AWS::Forecast::Dataset
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html
|
|
*/
|
|
export declare class CfnDataset extends cdk.CfnResource implements cdk.IInspectable, IDatasetRef {
|
|
/**
|
|
* 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;
|
|
/**
|
|
* The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
|
|
*/
|
|
private _dataFrequency?;
|
|
/**
|
|
* The name of the dataset.
|
|
*/
|
|
private _datasetName;
|
|
/**
|
|
* The dataset type.
|
|
*/
|
|
private _datasetType;
|
|
/**
|
|
* The domain associated with the dataset.
|
|
*/
|
|
private _domain;
|
|
/**
|
|
* A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
|
|
*/
|
|
private _encryptionConfig?;
|
|
/**
|
|
* The schema for the dataset.
|
|
*/
|
|
private _schema;
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*/
|
|
private _tags?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::Forecast::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 frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
|
|
*/
|
|
get dataFrequency(): string | undefined;
|
|
/**
|
|
* The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
|
|
*/
|
|
set dataFrequency(value: string | undefined);
|
|
/**
|
|
* The name of the dataset.
|
|
*/
|
|
get datasetName(): string;
|
|
/**
|
|
* The name of the dataset.
|
|
*/
|
|
set datasetName(value: string);
|
|
/**
|
|
* The dataset type.
|
|
*/
|
|
get datasetType(): string;
|
|
/**
|
|
* The dataset type.
|
|
*/
|
|
set datasetType(value: string);
|
|
/**
|
|
* The domain associated with the dataset.
|
|
*/
|
|
get domain(): string;
|
|
/**
|
|
* The domain associated with the dataset.
|
|
*/
|
|
set domain(value: string);
|
|
/**
|
|
* A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
|
|
*/
|
|
get encryptionConfig(): any | cdk.IResolvable | undefined;
|
|
/**
|
|
* A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
|
|
*/
|
|
set encryptionConfig(value: any | cdk.IResolvable | undefined);
|
|
/**
|
|
* The schema for the dataset.
|
|
*/
|
|
get schema(): any | cdk.IResolvable;
|
|
/**
|
|
* The schema for the dataset.
|
|
*/
|
|
set schema(value: any | cdk.IResolvable);
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*/
|
|
get tags(): Array<CfnDataset.TagsItemsProperty> | undefined;
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*/
|
|
set tags(value: Array<CfnDataset.TagsItemsProperty> | undefined);
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the dataset.
|
|
*
|
|
* @cloudformationAttribute Arn
|
|
*/
|
|
get attrArn(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
export declare namespace CfnDataset {
|
|
/**
|
|
* Defines the fields of a dataset.
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-schema.html
|
|
*/
|
|
interface SchemaProperty {
|
|
/**
|
|
* An array of attributes specifying the name and type of each field in a dataset.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-schema.html#cfn-forecast-dataset-schema-attributes
|
|
*/
|
|
readonly attributes?: Array<CfnDataset.AttributesItemsProperty | cdk.IResolvable> | cdk.IResolvable;
|
|
}
|
|
/**
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html
|
|
*/
|
|
interface AttributesItemsProperty {
|
|
/**
|
|
* Name of the dataset field.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html#cfn-forecast-dataset-attributesitems-attributename
|
|
*/
|
|
readonly attributeName?: string;
|
|
/**
|
|
* Data type of the field.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html#cfn-forecast-dataset-attributesitems-attributetype
|
|
*/
|
|
readonly attributeType?: string;
|
|
}
|
|
/**
|
|
* An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
|
|
*
|
|
* You can specify this optional object in the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) and [CreatePredictor](https://docs.aws.amazon.com/forecast/latest/dg/API_CreatePredictor.html) requests.
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html
|
|
*/
|
|
interface EncryptionConfigProperty {
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the KMS key.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html#cfn-forecast-dataset-encryptionconfig-kmskeyarn
|
|
*/
|
|
readonly kmsKeyArn?: string;
|
|
/**
|
|
* The ARN of the IAM role that Amazon Forecast can assume to access the AWS key.
|
|
*
|
|
* Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an `InvalidInputException` error.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html#cfn-forecast-dataset-encryptionconfig-rolearn
|
|
*/
|
|
readonly roleArn?: string;
|
|
}
|
|
/**
|
|
* A key-value pair to associate with a resource.
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html
|
|
*/
|
|
interface TagsItemsProperty {
|
|
/**
|
|
* The key name of the tag.
|
|
*
|
|
* You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html#cfn-forecast-dataset-tagsitems-key
|
|
*/
|
|
readonly key: string;
|
|
/**
|
|
* The value for the tag.
|
|
*
|
|
* You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html#cfn-forecast-dataset-tagsitems-value
|
|
*/
|
|
readonly value: string;
|
|
}
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnDataset`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html
|
|
*/
|
|
export interface CfnDatasetProps {
|
|
/**
|
|
* The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
|
|
*
|
|
* Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
|
|
*
|
|
* - Minute - 1-59
|
|
* - Hour - 1-23
|
|
* - Day - 1-6
|
|
* - Week - 1-4
|
|
* - Month - 1-11
|
|
* - Year - 1
|
|
*
|
|
* Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datafrequency
|
|
*/
|
|
readonly dataFrequency?: string;
|
|
/**
|
|
* The name of the dataset.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datasetname
|
|
*/
|
|
readonly datasetName: string;
|
|
/**
|
|
* The dataset type.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datasettype
|
|
*/
|
|
readonly datasetType: string;
|
|
/**
|
|
* The domain associated with the dataset.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-domain
|
|
*/
|
|
readonly domain: string;
|
|
/**
|
|
* A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-encryptionconfig
|
|
*/
|
|
readonly encryptionConfig?: any | cdk.IResolvable;
|
|
/**
|
|
* The schema for the dataset.
|
|
*
|
|
* The schema attributes and their order must match the fields in your data. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html) .
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-schema
|
|
*/
|
|
readonly schema: any | cdk.IResolvable;
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*
|
|
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-tags
|
|
*/
|
|
readonly tags?: Array<CfnDataset.TagsItemsProperty>;
|
|
}
|
|
/**
|
|
* Creates a dataset group, which holds a collection of related datasets.
|
|
*
|
|
* You can add datasets to the dataset group when you create the dataset group, or later by using the [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation.
|
|
*
|
|
* > Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](https://docs.aws.amazon.com/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)
|
|
*
|
|
* After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see [Dataset groups](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) .
|
|
*
|
|
* To get a list of all your datasets groups, use the [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) operation.
|
|
*
|
|
* > The `Status` of a dataset group must be `ACTIVE` before you can use the dataset group to create a predictor. To get the status, use the [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation.
|
|
*
|
|
* @cloudformationResource AWS::Forecast::DatasetGroup
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html
|
|
*/
|
|
export declare class CfnDatasetGroup extends cdk.CfnResource implements cdk.IInspectable, IDatasetGroupRef, cdk.ITaggable {
|
|
/**
|
|
* 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;
|
|
/**
|
|
* An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
|
|
*/
|
|
private _datasetArns?;
|
|
/**
|
|
* The name of the dataset group.
|
|
*/
|
|
private _datasetGroupName;
|
|
/**
|
|
* The domain associated with the dataset group.
|
|
*/
|
|
private _domain;
|
|
/**
|
|
* Tag Manager which manages the tags for this resource
|
|
*/
|
|
readonly tags: cdk.TagManager;
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*/
|
|
private _tagsRaw?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::Forecast::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;
|
|
/**
|
|
* An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
|
|
*/
|
|
get datasetArns(): Array<string> | undefined;
|
|
/**
|
|
* An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
|
|
*/
|
|
set datasetArns(value: Array<string> | undefined);
|
|
/**
|
|
* The name of the dataset group.
|
|
*/
|
|
get datasetGroupName(): string;
|
|
/**
|
|
* The name of the dataset group.
|
|
*/
|
|
set datasetGroupName(value: string);
|
|
/**
|
|
* The domain associated with the dataset group.
|
|
*/
|
|
get domain(): string;
|
|
/**
|
|
* The domain associated with the dataset group.
|
|
*/
|
|
set domain(value: string);
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*/
|
|
get tagsRaw(): Array<cdk.CfnTag> | undefined;
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*/
|
|
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the dataset group.
|
|
*
|
|
* @cloudformationAttribute DatasetGroupArn
|
|
*/
|
|
get attrDatasetGroupArn(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnDatasetGroup`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html
|
|
*/
|
|
export interface CfnDatasetGroupProps {
|
|
/**
|
|
* An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-datasetarns
|
|
*/
|
|
readonly datasetArns?: Array<string>;
|
|
/**
|
|
* The name of the dataset group.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-datasetgroupname
|
|
*/
|
|
readonly datasetGroupName: string;
|
|
/**
|
|
* The domain associated with the dataset group.
|
|
*
|
|
* When you add a dataset to a dataset group, this value and the value specified for the `Domain` parameter of the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation must match.
|
|
*
|
|
* The `Domain` and `DatasetType` that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the `RETAIL` domain and `TARGET_TIME_SERIES` as the `DatasetType` , Amazon Forecast requires that `item_id` , `timestamp` , and `demand` fields are present in your data. For more information, see [Dataset groups](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) .
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-domain
|
|
*/
|
|
readonly domain: string;
|
|
/**
|
|
* An array of key-value pairs to apply to this resource.
|
|
*
|
|
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-tags
|
|
*/
|
|
readonly tags?: Array<cdk.CfnTag>;
|
|
}
|
|
export type { IDatasetRef, DatasetReference };
|
|
export type { IDatasetGroupRef, DatasetGroupReference };
|