AWS::Personalize::DatasetGroup - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Personalize::DatasetGroup

A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.

You can specify an Amazon Key Management Service (KMS) key to encrypt the datasets in the group.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Personalize::DatasetGroup",
  "Properties" : {
      "Domain" : String,
      "KmsKeyArn" : String,
      "Name" : String,
      "RoleArn" : String
    }
}

YAML

Type: AWS::Personalize::DatasetGroup
Properties:
  Domain: String
  KmsKeyArn: String
  Name: String
  RoleArn: String

Properties

Domain

The domain of a Domain dataset group.

Required: No

Type: String

Allowed values: ECOMMERCE | VIDEO_ON_DEMAND

Update requires: Replacement

KmsKeyArn

The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key used to encrypt the datasets.

Required: No

Type: String

Pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.*

Maximum: 2048

Update requires: Replacement

Name

The name of the dataset group.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Minimum: 1

Maximum: 63

Update requires: Replacement

RoleArn

The ARN of the Amazon Identity and Access Management (IAM) role that has permissions to access the Amazon Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

Required: No

Type: String

Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Minimum: 0

Maximum: 256

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the resource.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

DatasetGroupArn

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

Examples

Creating a dataset group

The following example creates an Amazon Personalize dataset group.

JSON

{
   "AWSTemplateFormatVersion":"2010-09-09",
   "Resources":{
      "MyDatasetGroup": {
            "Type": "AWS::Personalize::DatasetGroup",
            "Properties": {
               "Name": "my-dataset-group-name"
            }
      }
   }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Resources:
  MyDatasetGroup:
    Type: 'AWS::Personalize::DatasetGroup'
    Properties:
      Name: my-dataset-group-name