CfnDataset

java.lang.Object
- 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
```
@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:50.388Z")
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;
 Object tags;
 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(tags))
         .build();
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnDataset.Builder
A fluent builder for CfnDataset.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnDataset.Builder` A fluent builder for `CfnDataset`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDataset(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the dataset.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`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.
`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.
`java.util.List<java.lang.Object>`	`getTags()` An array of key-value pairs to apply to this resource.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDataFrequency(java.lang.String value)` The frequency of data collection.
`void`	`setDatasetName(java.lang.String value)` The name of the dataset.
`void`	`setDatasetType(java.lang.String value)` The dataset type.
`void`	`setDomain(java.lang.String value)` The domain associated with the dataset.
`void`	`setEncryptionConfig(java.lang.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(java.lang.Object value)` The schema for the dataset.
`void`	`setTags(java.util.List<java.lang.Object> 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDataset
```
protected CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDataset
```
protected CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDataset
```
public CfnDataset(Construct scope,
                  java.lang.String id,
                  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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the dataset.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getDatasetName
```
public java.lang.String getDatasetName()
```
    The name of the dataset.
  - setDatasetName
```
public void setDatasetName(java.lang.String value)
```
    The name of the dataset.
  - getDatasetType
```
public java.lang.String getDatasetType()
```
    The dataset type.
  - setDatasetType
```
public void setDatasetType(java.lang.String value)
```
    The dataset type.
  - getDomain
```
public java.lang.String getDomain()
```
    The domain associated with the dataset.
  - setDomain
```
public void setDomain(java.lang.String value)
```
    The domain associated with the dataset.
  - getEncryptionConfig
```
public 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.
  - setEncryptionConfig
```
public void setEncryptionConfig(java.lang.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
```
public 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 .
  - setSchema
```
public void setSchema(java.lang.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
```
public java.lang.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.
  - setDataFrequency
```
public void setDataFrequency(java.lang.String value)
```
    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.
  - getTags
```
public java.util.List<java.lang.Object> getTags()
```
    An array of key-value pairs to apply to this resource.
    For more information, see Tag .
  - setTags
```
public void setTags(java.util.List<java.lang.Object> value)
```
    An array of key-value pairs to apply to this resource.
    For more information, see Tag .

Class CfnDataset

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDataset

CfnDataset

CfnDataset

Method Detail

inspect

renderProperties

getAttrArn

getCfnProperties

getDatasetName

setDatasetName

getDatasetType

setDatasetType

getDomain

setDomain

getEncryptionConfig

setEncryptionConfig

getSchema

setSchema

getDataFrequency

setDataFrequency

getTags

setTags