Package software.amazon.awscdk.services.forecast

Interface CfnDatasetGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:17.205Z")
@Stability(Stable)
public interface CfnDatasetGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDatasetGroup.

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.*;
 CfnDatasetGroupProps cfnDatasetGroupProps = CfnDatasetGroupProps.builder()
         .datasetGroupName("datasetGroupName")
         .domain("domain")
         // the properties below are optional
         .datasetArns(List.of("datasetArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDatasetGroupProps.Builder	A builder for CfnDatasetGroupProps
static final class	CfnDatasetGroupProps.Jsii$Proxy	An implementation for CfnDatasetGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnDatasetGroupProps.Builder	builder()
default 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.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasetGroupName

@Stability(Stable)
@NotNull
String getDatasetGroupName()

The name of the dataset group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-datasetgroupname

getDomain

@Stability(Stable)
@NotNull
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 .

See Also:

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

getDatasetArns

@Stability(Stable)
@Nullable
default List<String> getDatasetArns()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-datasetarns

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnDatasetGroupProps.Builder builder()

Returns:

a CfnDatasetGroupProps.Builder of CfnDatasetGroupProps