dataset_groups

Creates, updates, deletes or gets a dataset_group resource or lists dataset_groups in a region

Overview

Name	dataset_groups
Type	Resource
Description	Represents a dataset group that holds a collection of related datasets
Id	aws.forecast.dataset_groups

Fields

Name	Datatype	Description
dataset_arns	array	An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
dataset_group_name	string	A name for the dataset group.
domain	string	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.
tags	array	The tags of Application Insights application.
dataset_group_arn	string	The Amazon Resource Name (ARN) of the dataset group to delete.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DatasetGroupName, Domain, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all dataset_groups in a region.

SELECT
region,
dataset_arns,
dataset_group_name,
domain,
tags,
dataset_group_arn
FROM aws.forecast.dataset_groups
WHERE region = 'us-east-1';

Gets all properties from an individual dataset_group.

SELECT
region,
dataset_arns,
dataset_group_name,
domain,
tags,
dataset_group_arn
FROM aws.forecast.dataset_groups
WHERE region = 'us-east-1' AND data__Identifier = '<DatasetGroupArn>';

INSERT example

Use the following StackQL query and manifest file to create a new dataset_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.forecast.dataset_groups (
 DatasetGroupName,
 Domain,
 region
)
SELECT 
'{{ DatasetGroupName }}',
 '{{ Domain }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.forecast.dataset_groups (
 DatasetArns,
 DatasetGroupName,
 Domain,
 Tags,
 region
)
SELECT 
 '{{ DatasetArns }}',
 '{{ DatasetGroupName }}',
 '{{ Domain }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: dataset_group
    props:
      - name: DatasetArns
        value:
          - '{{ DatasetArns[0] }}'
      - name: DatasetGroupName
        value: '{{ DatasetGroupName }}'
      - name: Domain
        value: '{{ Domain }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.forecast.dataset_groups
WHERE data__Identifier = '<DatasetGroupArn>'
AND region = 'us-east-1';

Permissions

To operate on the dataset_groups resource, the following permissions are required:

Create

forecast:CreateDatasetGroup

Read

forecast:DescribeDatasetGroup

Update

forecast:UpdateDatasetGroup

Delete

forecast:DeleteDatasetGroup

List

forecast:ListDatasetGroups