Class CfnDataset
Creates an Amazon Forecast dataset.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Forecast
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataset : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDataset
Inherits CfnResource
Implements IInspectable
Remarks
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. Learn more"
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html
CloudformationResource: AWS::Forecast::Dataset
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(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 |
CfnDataset(Construct, String, ICfnDatasetProps) |
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. |
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(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
CfnDataset(Construct, String, ICfnDatasetProps)
public CfnDataset(Construct scope, string id, ICfnDatasetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDatasetProps
Resource properties.
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
DataFrequency
The frequency of data collection.
public virtual string DataFrequency { get; set; }
Property Value
System.String
Remarks
This parameter is required for RELATED_TIME_SERIES datasets.
DatasetName
The name of the dataset.
public virtual string DatasetName { get; set; }
Property Value
System.String
DatasetType
The dataset type.
public virtual string DatasetType { get; set; }
Property Value
System.String
Domain
The domain associated with the dataset.
public virtual string Domain { get; set; }
Property Value
System.String
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
Schema
The schema for the dataset.
public virtual object Schema { get; set; }
Property Value
System.Object
Tags
An array of key-value pairs to apply to this resource.
public virtual CfnDataset.ITagsItemsProperty[] Tags { get; set; }
Property Value
CfnDataset.ITagsItemsProperty[]
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>