Package software.amazon.awscdk.services.forecast

Class CfnDataset

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.forecast.CfnDataset

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.806Z")
@Stability(Stable)
public class CfnDataset
extends CfnResource
implements IInspectable

A CloudFormation AWS::Forecast::Dataset.

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

• DataFrequency - How frequently your historical time-series data is collected.
• Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.
• Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets .

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository .

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

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;
 CfnDataset cfnDataset = CfnDataset.Builder.create(this, "MyCfnDataset")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDataset.AttributesItemsProperty	Example:
static final class	CfnDataset.Builder	A fluent builder for CfnDataset.
static interface	CfnDataset.EncryptionConfigProperty	An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
static interface	CfnDataset.SchemaProperty	Defines the fields of a dataset.
static interface	CfnDataset.TagsItemsProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDataset(Construct scope, String id, CfnDatasetProps props)	Create a new AWS::Forecast::Dataset.
protected	CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the dataset.
protected Map<String,Object>	getCfnProperties()
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.
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.
List<CfnDataset.TagsItemsProperty>	getTags()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataFrequency(String value)	The frequency of data collection.
void	setDatasetName(String value)	The name of the dataset.
void	setDatasetType(String value)	The dataset type.
void	setDomain(String value)	The domain associated with the dataset.
void	setEncryptionConfig(Object value)	A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
void	setSchema(Object value)	The schema for the dataset.
void	setTags(List<CfnDataset.TagsItemsProperty> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataset

protected CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataset

protected CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataset

@Stability(Stable)
public CfnDataset(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDatasetProps props)

Create a new AWS::Forecast::Dataset.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the dataset.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDatasetName

@Stability(Stable)
@NotNull
public String getDatasetName()

The name of the dataset.

setDatasetName

@Stability(Stable)
public void setDatasetName(@NotNull
 String value)

The name of the dataset.

getDatasetType

@Stability(Stable)
@NotNull
public String getDatasetType()

The dataset type.

setDatasetType

@Stability(Stable)
public void setDatasetType(@NotNull
 String value)

The dataset type.

getDomain

@Stability(Stable)
@NotNull
public String getDomain()

The domain associated with the dataset.

setDomain

@Stability(Stable)
public void setDomain(@NotNull
 String value)

The domain associated with the dataset.

getEncryptionConfig

@Stability(Stable)
@NotNull
public 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.

setEncryptionConfig

@Stability(Stable)
public void setEncryptionConfig(@NotNull
 Object value)

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

getSchema

@Stability(Stable)
@NotNull
public 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 .

setSchema

@Stability(Stable)
public void setSchema(@NotNull
 Object value)

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

setDataFrequency

@Stability(Stable)
public void setDataFrequency(@Nullable
 String value)

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

getTags

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

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

For more information, see Tag .

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnDataset.TagsItemsProperty> value)

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

For more information, see Tag .