1.204.0

interface CfnDatasetProps

LanguageType name
.NETAmazon.CDK.AWS.Forecast.CfnDatasetProps
Javasoftware.amazon.awscdk.services.forecast.CfnDatasetProps
Pythonaws_cdk.aws_forecast.CfnDatasetProps
TypeScript @aws-cdk/aws-forecast » CfnDatasetProps

Properties for defining a CfnDataset.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as forecast from '@aws-cdk/aws-forecast';

declare const encryptionConfig: any;
declare const schema: any;
const cfnDatasetProps: forecast.CfnDatasetProps = {
  datasetName: 'datasetName',
  datasetType: 'datasetType',
  domain: 'domain',
  schema: schema,

  // the properties below are optional
  dataFrequency: 'dataFrequency',
  encryptionConfig: encryptionConfig,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
datasetNamestringThe name of the dataset.
datasetTypestringThe dataset type.
domainstringThe domain associated with the dataset.
schemaanyThe schema for the dataset.
dataFrequency?stringThe frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
encryptionConfig?anyA Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
tags?TagsItemsProperty[]An array of key-value pairs to apply to this resource.

datasetName

Type: string

The name of the dataset.

datasetType

Type: string

The dataset type.

domain

Type: string

The domain associated with the dataset.

schema

Type: any

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 .

dataFrequency?

Type: string (optional)

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".

encryptionConfig?

Type: any (optional)

A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

tags?

Type: TagsItemsProperty[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

← PreviousNext →