Class CfnDatasetGroup
A CloudFormation AWS::Forecast::DatasetGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.Forecast
Assembly: Amazon.CDK.AWS.Forecast.dll
Syntax (csharp)
public class CfnDatasetGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDatasetGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups .
To get a list of all your datasets groups, use the ListDatasetGroups operation.
The Status
of a dataset group must be ACTIVE
before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
CloudformationResource: AWS::Forecast::DatasetGroup
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 cfnDatasetGroup = new CfnDatasetGroup(this, "MyCfnDatasetGroup", new CfnDatasetGroupProps {
DatasetGroupName = "datasetGroupName",
Domain = "domain",
// the properties below are optional
DatasetArns = new [] { "datasetArns" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDatasetGroup(Construct, String, ICfnDatasetGroupProps) | Create a new |
CfnDatasetGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDatasetGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrDatasetGroupArn | The Amazon Resource Name (ARN) of the dataset group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DatasetArns | An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group. |
DatasetGroupName | The name of the dataset group. |
Domain | The domain associated with the dataset group. |
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
CfnDatasetGroup(Construct, String, ICfnDatasetGroupProps)
Create a new AWS::Forecast::DatasetGroup
.
public CfnDatasetGroup(Construct scope, string id, ICfnDatasetGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDatasetGroupProps
- resource properties.
CfnDatasetGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDatasetGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDatasetGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDatasetGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrDatasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
public virtual string AttrDatasetGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DatasetGroupArn
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
DatasetArns
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
public virtual string[] DatasetArns { get; set; }
Property Value
System.String[]
Remarks
DatasetGroupName
The name of the dataset group.
public virtual string DatasetGroupName { get; set; }
Property Value
System.String
Remarks
Domain
The domain associated with the dataset group.
public virtual string Domain { get; set; }
Property Value
System.String
Remarks
When you add a dataset to a dataset group, this value and the value specified for the Domain
parameter of the CreateDataset operation must match.
The Domain
and DatasetType
that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as the DatasetType
, Amazon Forecast requires that item_id
, timestamp
, and demand
fields are present in your data. For more information, see Dataset groups .
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
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>