Package software.amazon.awscdk.services.forecast

Class CfnDataset.Builder

java.lang.Object
software.amazon.awscdk.services.forecast.CfnDataset.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataset>
Enclosing class:
CfnDataset
@Stability(Stable) public static final class CfnDataset.Builder extends Object implements software.amazon.jsii.Builder<CfnDataset>
A fluent builder for CfnDataset.

  • Method Details

    • create

      @Stability(Stable) public static CfnDataset.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnDataset.Builder.

    • datasetName

      @Stability(Stable) public CfnDataset.Builder datasetName(String datasetName)
      The name of the dataset.

      Parameters:
      datasetName - The name of the dataset. This parameter is required.
      Returns:
      this

    • datasetType

      @Stability(Stable) public CfnDataset.Builder datasetType(String datasetType)
      The dataset type.

      Parameters:
      datasetType - The dataset type. This parameter is required.
      Returns:
      this

    • domain

      @Stability(Stable) public CfnDataset.Builder domain(String domain)
      The domain associated with the dataset.

      Parameters:
      domain - The domain associated with the dataset. This parameter is required.
      Returns:
      this

    • schema

      @Stability(Stable) public CfnDataset.Builder schema(Object schema)
      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 .

      Parameters:
      schema - The schema for the dataset. This parameter is required.
      Returns:
      this

    • dataFrequency

      @Stability(Stable) public CfnDataset.Builder dataFrequency(String dataFrequency)
      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".

      Parameters:
      dataFrequency - The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets. This parameter is required.
      Returns:
      this

    • encryptionConfig

      @Stability(Stable) public CfnDataset.Builder encryptionConfig(Object encryptionConfig)
      A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

      Parameters:
      encryptionConfig - A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnDataset.Builder tags(List<? extends CfnDataset.TagsItemsProperty> tags)
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

      Parameters:
      tags - An array of key-value pairs to apply to this resource. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDataset build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDataset>
      Returns:
      a newly built instance of CfnDataset.