Package 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, IDatasetGroupRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.169Z") @Stability(Stable) public class CfnDatasetGroup extends CfnResource implements IInspectable, IDatasetGroupRef, ITaggable
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.

Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. Learn more"

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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDatasetGroup

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

    • CfnDatasetGroup

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

    • CfnDatasetGroup

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForDatasetGroup

      @Stability(Stable) @NotNull public static String arnForDatasetGroup(@NotNull IDatasetGroupRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDatasetGroup

      @Stability(Stable) @NotNull public static Boolean isCfnDatasetGroup(@NotNull Object x)
      Checks whether the given object is a CfnDatasetGroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrDatasetGroupArn()
      The Amazon Resource Name (ARN) of the dataset group.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDatasetGroupRef

      @Stability(Stable) @NotNull public DatasetGroupReference getDatasetGroupRef()
      A reference to a DatasetGroup resource.
      Specified by:
      getDatasetGroupRef in interface IDatasetGroupRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDatasetGroupName

      @Stability(Stable) @NotNull public String getDatasetGroupName()
      The name of the dataset group.

    • setDatasetGroupName

      @Stability(Stable) public void setDatasetGroupName(@NotNull String value)
      The name of the dataset group.

    • getDomain

      @Stability(Stable) @NotNull public String getDomain()
      The domain associated with the dataset group.

    • setDomain

      @Stability(Stable) public void setDomain(@NotNull String value)
      The domain associated with the dataset group.

    • getDatasetArns

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.