Class CfnDatasetMixinProps

Properties for CfnDatasetPropsMixin.

Inheritance

object

CfnDatasetMixinProps

Implements

ICfnDatasetMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Forecast.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDatasetMixinProps : ICfnDatasetMixinProps

Syntax (vb)

Public Class CfnDatasetMixinProps Implements ICfnDatasetMixinProps

Remarks

See: 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.Mixins.Preview.AWS.Forecast.Mixins;

             var encryptionConfig;
             var schema;

             var cfnDatasetMixinProps = new CfnDatasetMixinProps {
                 DataFrequency = "dataFrequency",
                 DatasetName = "datasetName",
                 DatasetType = "datasetType",
                 Domain = "domain",
                 EncryptionConfig = encryptionConfig,
                 Schema = schema,
                 Tags = new [] { new TagsItemsProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnDatasetMixinProps()

Properties for CfnDatasetPropsMixin.

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

CfnDatasetMixinProps()

Properties for CfnDatasetPropsMixin.

public CfnDatasetMixinProps()

Remarks

See: 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.Mixins.Preview.AWS.Forecast.Mixins;

             var encryptionConfig;
             var schema;

             var cfnDatasetMixinProps = new CfnDatasetMixinProps {
                 DataFrequency = "dataFrequency",
                 DatasetName = "datasetName",
                 DatasetType = "datasetType",
                 Domain = "domain",
                 EncryptionConfig = encryptionConfig,
                 Schema = schema,
                 Tags = new [] { new TagsItemsProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DataFrequency

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

public string? DataFrequency { get; set; }

Property Value

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

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

DatasetName

The name of the dataset.

public string? DatasetName { get; set; }

Property Value

string

Remarks

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

DatasetType

The dataset type.

public string? DatasetType { get; set; }

Property Value

string

Remarks

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

Domain

The domain associated with the dataset.

public string? Domain { get; set; }

Property Value

string

Remarks

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

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

object

Remarks

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

Schema

The schema for the dataset.

public object? Schema { get; set; }

Property Value

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 .

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

Tags

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

public CfnDatasetPropsMixin.ITagsItemsProperty[]? Tags { get; set; }

Property Value

ITagsItemsProperty[]

Remarks

For more information, see Tag .

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

Implements

ICfnDatasetMixinProps