Package software.amazon.awscdk.cfnpropertymixins.services.forecast

Class CfnDatasetPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.forecast.CfnDatasetPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:59.484Z") @Stability(Stable) public class CfnDatasetPropsMixin extends Mixin implements software.constructs.IMixin
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.forecast.*;
 import software.amazon.awscdk.*;
 Object encryptionConfig;
 IMergeStrategy mergeStrategy;
 Object schema;
 CfnDatasetPropsMixin cfnDatasetPropsMixin = CfnDatasetPropsMixin.Builder.create(CfnDatasetMixinProps.builder()
         .dataFrequency("dataFrequency")
         .datasetName("datasetName")
         .datasetType("datasetType")
         .domain("domain")
         .encryptionConfig(encryptionConfig)
         .schema(schema)
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDatasetPropsMixin

      protected CfnDatasetPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDatasetPropsMixin

      protected CfnDatasetPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDatasetPropsMixin

      @Stability(Stable) public CfnDatasetPropsMixin(@NotNull CfnDatasetMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Forecast::Dataset.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDatasetPropsMixin

      @Stability(Stable) public CfnDatasetPropsMixin(@NotNull CfnDatasetMixinProps props)
      Create a mixin to apply properties to AWS::Forecast::Dataset.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDatasetMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()