Class CfnDataset

A CloudFormation AWS::Forecast::Dataset.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnDataset

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Forecast

Assembly: Amazon.CDK.AWS.Forecast.dll

Syntax (csharp)

public class CfnDataset : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnDataset
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

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:

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 <code>Status</code> of a dataset must be <code>ACTIVE</code> before you can import training data. Use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation to get the status.

CloudformationResource: AWS::Forecast::Dataset

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 cfnDataset = new CfnDataset(this, "MyCfnDataset", 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

CfnDataset(Construct, String, ICfnDatasetProps)	Create a new `AWS::Forecast::Dataset`.
CfnDataset(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnDataset(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn	The Amazon Resource Name (ARN) of the dataset.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDataset(Construct, String, ICfnDatasetProps)

Create a new AWS::Forecast::Dataset.

public CfnDataset(Construct scope, string id, ICfnDatasetProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnDatasetProps

resource properties.

CfnDataset(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnDataset(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnDataset(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnDataset(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) of the dataset.

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

DataFrequency

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

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

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

DatasetName

The name of the dataset.

public virtual string DatasetName { get; set; }

Property Value

System.String

Remarks

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

DatasetType

The dataset type.

public virtual string DatasetType { get; set; }

Property Value

System.String

Remarks

Link: 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 virtual string Domain { get; set; }

Property Value

System.String

Remarks

Link: 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 virtual object EncryptionConfig { get; set; }

Property Value

System.Object

Remarks

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

Schema

The schema for the dataset.

public virtual 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 .

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable