AWS::Personalize::Solution - Amazon CloudFormation
SyntaxPropertiesReturn values
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::Solution

An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.

Syntax

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

JSON

{
  "Type" : "AWS::Personalize::Solution",
  "Properties" : {
      "DatasetGroupArn" : String,
      "EventType" : String,
      "Name" : String,
      "PerformAutoML" : Boolean,
      "PerformHPO" : Boolean,
      "RecipeArn" : String,
      "SolutionConfig" : SolutionConfig
    }
}

YAML

Type: AWS::Personalize::Solution
Properties: 
  DatasetGroupArn: String
  EventType: String
  Name: String
  PerformAutoML: Boolean
  PerformHPO: Boolean
  RecipeArn: String
  SolutionConfig: 
    SolutionConfig

Properties

DatasetGroupArn

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

Required: Yes

Type: String

Maximum: 256

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Update requires: Replacement

EventType

The event type (for example, 'click' or 'like') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.

Required: No

Type: String

Maximum: 256

Update requires: Replacement

Name

The name of the solution.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

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

Update requires: Replacement

PerformAutoML
Important

We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

Required: No

Type: Boolean

Update requires: Replacement

PerformHPO

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

Required: No

Type: Boolean

Update requires: Replacement

RecipeArn

The ARN of the recipe used to create the solution.

Required: No

Type: String

Maximum: 256

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Update requires: Replacement

SolutionConfig

Describes the configuration properties for the solution.

Required: No

Type: SolutionConfig

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the name of the resource.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

SolutionArn

The Amazon Resource Name (ARN) of the solution.