class CfnDatasetPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Forecast.Mixins.CfnDatasetPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsforecast/mixins#CfnDatasetPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.forecast.mixins.CfnDatasetPropsMixin
Python	aws_cdk.mixins_preview.aws_forecast.mixins.CfnDatasetPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_forecast » mixins » CfnDatasetPropsMixin

Implements IMixin

Extends Mixin

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"

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 .

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository .

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html

Example

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

declare const encryptionConfig: any;
declare const schema: any;
const cfnDatasetPropsMixin = new forecast_mixins.CfnDatasetPropsMixin({
  dataFrequency: 'dataFrequency',
  datasetName: 'datasetName',
  datasetType: 'datasetType',
  domain: 'domain',
  encryptionConfig: encryptionConfig,
  schema: schema,
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDatasetPropsMixin(props: CfnDatasetMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDatasetMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Forecast::Dataset.

Properties

Name	Type	Description
props	CfnDatasetMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDatasetMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.