software.amazon.awscdk.services.forecast

Interface CfnDatasetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.397Z")
 @Stability(value=Stable)
public interface CfnDatasetProps
extends software.amazon.jsii.JsiiSerializable

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 String	getDataFrequency() The frequency of data collection.
String	getDatasetName() The name of the dataset.
String	getDatasetType() The dataset type.
String	getDomain() The domain associated with the dataset.
default 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.
Object	getSchema() The schema for the dataset.
default List<Object>	getTags() An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDatasetName

@Stability(value=Stable)
 @NotNull
String getDatasetName()

The name of the dataset.

getDatasetType

@Stability(value=Stable)
 @NotNull
String getDatasetType()

The dataset type.

getDomain

@Stability(value=Stable)
 @NotNull
String getDomain()

The domain associated with the dataset.

getSchema

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @Nullable
default String getDataFrequency()

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

getEncryptionConfig

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default List<Object> getTags()

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

For more information, see Tag .

builder

@Stability(value=Stable)
static CfnDatasetProps.Builder builder()

Returns:

a CfnDatasetProps.Builder of CfnDatasetProps