software.amazon.awscdk.services.forecast

Interface CfnDatasetProps

All Known Implementing Classes:

CfnDatasetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:34.973Z")
public interface 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 software.amazon.awscdk.services.forecast.*;
 Object encryptionConfig;
 Object schema;
 Object tags;
 CfnDatasetProps cfnDatasetProps = CfnDatasetProps.builder()
         .datasetName("datasetName")
         .datasetType("datasetType")
         .domain("domain")
         .schema(schema)
         // the properties below are optional
         .dataFrequency("dataFrequency")
         .encryptionConfig(encryptionConfig)
         .tags(List.of(tags))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDatasetProps.Builder A builder for CfnDatasetProps
static class	CfnDatasetProps.Jsii$Proxy An implementation for CfnDatasetProps

Method Summary

Modifier and Type	Method and Description
static CfnDatasetProps.Builder	builder()
default java.lang.String	getDataFrequency() The frequency of data collection.
java.lang.String	getDatasetName() The name of the dataset.
java.lang.String	getDatasetType() The dataset type.
java.lang.String	getDomain() The domain associated with the dataset.
default java.lang.Object	getEncryptionConfig() A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
java.lang.Object	getSchema() The schema for the dataset.
default java.util.List<java.lang.Object>	getTags() An array of key-value pairs to apply to this resource.

Method Detail

getDatasetName

java.lang.String getDatasetName()

The name of the dataset.

getDatasetType

java.lang.String getDatasetType()

The dataset type.

getDomain

java.lang.String getDomain()

The domain associated with the dataset.

getSchema

java.lang.Object getSchema()

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 .

getDataFrequency

default java.lang.String getDataFrequency()

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

getEncryptionConfig

default java.lang.Object getEncryptionConfig()

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

getTags

default java.util.List<java.lang.Object> getTags()

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

For more information, see Tag .

builder

static CfnDatasetProps.Builder builder()

Returns:

a CfnDatasetProps.Builder of CfnDatasetProps