Package software.amazon.awscdk.services.forecast

Class CfnDatasetProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • datasetName

      @Stability(Stable) public CfnDatasetProps.Builder datasetName(String datasetName)
      Sets the value of CfnDatasetProps.getDatasetName()
      Parameters:
      datasetName - The name of the dataset. This parameter is required.
      Returns:
      this

    • datasetType

      @Stability(Stable) public CfnDatasetProps.Builder datasetType(String datasetType)
      Sets the value of CfnDatasetProps.getDatasetType()
      Parameters:
      datasetType - The dataset type. This parameter is required.
      Returns:
      this

    • domain

      @Stability(Stable) public CfnDatasetProps.Builder domain(String domain)
      Sets the value of CfnDatasetProps.getDomain()
      Parameters:
      domain - The domain associated with the dataset. This parameter is required.
      Returns:
      this

    • schema

      @Stability(Stable) public CfnDatasetProps.Builder schema(Object schema)
      Sets the value of CfnDatasetProps.getSchema()
      Parameters:
      schema - The schema for the dataset. This parameter is required. 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 .
      Returns:
      this

    • dataFrequency

      @Stability(Stable) public CfnDatasetProps.Builder dataFrequency(String dataFrequency)
      Sets the value of CfnDatasetProps.getDataFrequency()
      Parameters:
      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".

      Returns:
      this

    • encryptionConfig

      @Stability(Stable) public CfnDatasetProps.Builder encryptionConfig(Object encryptionConfig)
      Sets the value of CfnDatasetProps.getEncryptionConfig()
      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.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnDatasetProps.Builder tags(List<? extends CfnDataset.TagsItemsProperty> tags)
      Sets the value of CfnDatasetProps.getTags()
      Parameters:
      tags - An array of key-value pairs to apply to this resource. For more information, see Tag .
      Returns:
      this

    • build

      @Stability(Stable) public CfnDatasetProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDatasetProps>
      Returns:
      a new instance of CfnDatasetProps
      Throws:
      NullPointerException - if any required attribute was not provided