Package 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.103.1 (build bef2dea)",
           date="2024-10-11T15:55:59.387Z")
@Stability(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;
 CfnDatasetProps cfnDatasetProps = CfnDatasetProps.builder()
         .datasetName("datasetName")
         .datasetType("datasetType")
         .domain("domain")
         .schema(schema)
         // the properties below are optional
         .dataFrequency("dataFrequency")
         .encryptionConfig(encryptionConfig)
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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<CfnDataset.TagsItemsProperty>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasetName

@Stability(Stable)
@NotNull
String getDatasetName()

The name of the dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datasetname

getDatasetType

@Stability(Stable)
@NotNull
String getDatasetType()

The dataset type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datasettype

getDomain

@Stability(Stable)
@NotNull
String getDomain()

The domain associated with the dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-domain

getSchema

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-schema

getDataFrequency

@Stability(Stable)
@Nullable
default 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".

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datafrequency

getEncryptionConfig

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-encryptionconfig

getTags

@Stability(Stable)
@Nullable
default List<CfnDataset.TagsItemsProperty> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-tags

builder

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

Returns:

a CfnDatasetProps.Builder of CfnDatasetProps