Class CfnDatasetProps
Properties for defining a CfnDataset
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Forecast
Assembly: Amazon.CDK.AWS.Forecast.dll
Syntax (csharp)
public class CfnDatasetProps : Object, ICfnDatasetProps
Syntax (vb)
Public Class CfnDatasetProps
Inherits Object
Implements ICfnDatasetProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Forecast;
var encryptionConfig;
var schema;
var cfnDatasetProps = new CfnDatasetProps {
DatasetName = "datasetName",
DatasetType = "datasetType",
Domain = "domain",
Schema = schema,
// the properties below are optional
DataFrequency = "dataFrequency",
EncryptionConfig = encryptionConfig,
Tags = new [] { new TagsItemsProperty {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnDatasetProps() |
Properties
DataFrequency | The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets. |
DatasetName | The name of the dataset. |
DatasetType | The dataset type. |
Domain | The domain associated with the dataset. |
EncryptionConfig | A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. |
Schema | The schema for the dataset. |
Tags | An array of key-value pairs to apply to this resource. |
Constructors
CfnDatasetProps()
public CfnDatasetProps()
Properties
DataFrequency
The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
public string DataFrequency { get; set; }
Property Value
System.String
Remarks
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:
Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".
DatasetName
The name of the dataset.
public string DatasetName { get; set; }
Property Value
System.String
Remarks
DatasetType
The dataset type.
public string DatasetType { get; set; }
Property Value
System.String
Remarks
Domain
The domain associated with the dataset.
public string Domain { get; set; }
Property Value
System.String
Remarks
EncryptionConfig
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
public object EncryptionConfig { get; set; }
Property Value
System.Object
Remarks
Schema
The schema for the dataset.
public object Schema { get; set; }
Property Value
System.Object
Remarks
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 .
Tags
An array of key-value pairs to apply to this resource.
public CfnDataset.ITagsItemsProperty[] Tags { get; set; }
Property Value
CfnDataset.ITagsItemsProperty[]
Remarks
For more information, see Tag .