software.amazon.awscdk.services.forecast

Class CfnDatasetGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.forecast.CfnDatasetGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.395Z")
 @Stability(value=Stable)
public class CfnDatasetGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Forecast::DatasetGroup`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.forecast.*;
 CfnDatasetGroup cfnDatasetGroup = CfnDatasetGroup.Builder.create(this, "MyCfnDatasetGroup")
         .datasetGroupName("datasetGroupName")
         .domain("domain")
         // the properties below are optional
         .datasetArns(List.of("datasetArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDatasetGroup.Builder A fluent builder for CfnDatasetGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDatasetGroup(software.constructs.Construct scope, String id, CfnDatasetGroupProps props) Create a new `AWS::Forecast::DatasetGroup`.
protected	CfnDatasetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDatasetGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDatasetGroupArn() The Amazon Resource Name (ARN) of the dataset group.
protected Map<String,Object>	getCfnProperties()
List<String>	getDatasetArns() An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
String	getDatasetGroupName() The name of the dataset group.
String	getDomain() The domain associated with the dataset group.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatasetArns(List<String> value) An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
void	setDatasetGroupName(String value) The name of the dataset group.
void	setDomain(String value) The domain associated with the dataset group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDatasetGroup

protected CfnDatasetGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnDatasetGroup

protected CfnDatasetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDatasetGroup

@Stability(value=Stable)
public CfnDatasetGroup(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnDatasetGroupProps props)

Create a new `AWS::Forecast::DatasetGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDatasetGroupArn

@Stability(value=Stable)
 @NotNull
public String getAttrDatasetGroupArn()

The Amazon Resource Name (ARN) of the dataset group.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDatasetGroupName

@Stability(value=Stable)
 @NotNull
public String getDatasetGroupName()

The name of the dataset group.

setDatasetGroupName

@Stability(value=Stable)
public void setDatasetGroupName(@NotNull
                                                         String value)

The name of the dataset group.

getDomain

@Stability(value=Stable)
 @NotNull
public String getDomain()

The domain associated with the dataset group.

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 .

setDomain

@Stability(value=Stable)
public void setDomain(@NotNull
                                               String value)

The domain associated with the dataset group.

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 .

getDatasetArns

@Stability(value=Stable)
 @Nullable
public List<String> getDatasetArns()

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

setDatasetArns

@Stability(value=Stable)
public void setDatasetArns(@Nullable
                                                    List<String> value)

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.