@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:36.217Z")
public class CfnDatasetGroup
extends CfnResource
implements IInspectable
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
Statusof a dataset group must beACTIVEbefore 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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnDatasetGroup.Builder
A fluent builder for
CfnDatasetGroup. |
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnDatasetGroup(Construct scope,
java.lang.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) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAttrDatasetGroupArn()
The Amazon Resource Name (ARN) of the dataset group.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.util.List<java.lang.String> |
getDatasetArns()
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
|
java.lang.String |
getDatasetGroupName()
The name of the dataset group.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDatasetArns(java.util.List<java.lang.String> value)
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
|
void |
setDatasetGroupName(java.lang.String value)
The name of the dataset group.
|
void |
setDomain(java.lang.String value)
The domain associated with the dataset group.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDatasetGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDatasetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDatasetGroup(Construct scope, java.lang.String id, CfnDatasetGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public java.lang.String getAttrDatasetGroupArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic TagManager getTags()
For more information, see Tag .
public java.lang.String getDatasetGroupName()
public void setDatasetGroupName(java.lang.String value)
public java.lang.String getDomain()
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 .
public void setDomain(java.lang.String value)
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 .
public java.util.List<java.lang.String> getDatasetArns()
public void setDatasetArns(java.util.List<java.lang.String> value)