software.amazon.awscdk.services.personalize

Interface CfnSolutionProps

All Known Implementing Classes:

CfnSolutionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:35.101Z")
public interface CfnSolutionProps

Properties for defining a `CfnSolution`.

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.personalize.*;
 Object autoMlConfig;
 Object hpoConfig;
 CfnSolutionProps cfnSolutionProps = CfnSolutionProps.builder()
         .datasetGroupArn("datasetGroupArn")
         .name("name")
         // the properties below are optional
         .eventType("eventType")
         .performAutoMl(false)
         .performHpo(false)
         .recipeArn("recipeArn")
         .solutionConfig(SolutionConfigProperty.builder()
                 .algorithmHyperParameters(Map.of(
                         "algorithmHyperParametersKey", "algorithmHyperParameters"))
                 .autoMlConfig(autoMlConfig)
                 .eventValueThreshold("eventValueThreshold")
                 .featureTransformationParameters(Map.of(
                         "featureTransformationParametersKey", "featureTransformationParameters"))
                 .hpoConfig(hpoConfig)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSolutionProps.Builder A builder for CfnSolutionProps
static class	CfnSolutionProps.Jsii$Proxy An implementation for CfnSolutionProps

Method Summary

Modifier and Type	Method and Description
static CfnSolutionProps.Builder	builder()
java.lang.String	getDatasetGroupArn() The Amazon Resource Name (ARN) of the dataset group that provides the training data.
default java.lang.String	getEventType() The event type (for example, 'click' or 'like') that is used for training the model.
java.lang.String	getName() The name of the solution.
default java.lang.Object	getPerformAutoMl() 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).
default java.lang.Object	getPerformHpo() Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
default java.lang.String	getRecipeArn() The ARN of the recipe used to create the solution.
default java.lang.Object	getSolutionConfig() Describes the configuration properties for the solution.

Method Detail

getDatasetGroupArn

java.lang.String getDatasetGroupArn()

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

getName

java.lang.String getName()

The name of the solution.

getEventType

default java.lang.String getEventType()

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.

getPerformAutoMl

default java.lang.Object getPerformAutoMl()

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.

getPerformHpo

default java.lang.Object getPerformHpo()

Whether to perform hyperparameter optimization (HPO) on the chosen recipe.

The default is false .

getRecipeArn

default java.lang.String getRecipeArn()

The ARN of the recipe used to create the solution.

getSolutionConfig

default java.lang.Object getSolutionConfig()

Describes the configuration properties for the solution.

builder

static CfnSolutionProps.Builder builder()

Returns:

a CfnSolutionProps.Builder of CfnSolutionProps