Package software.amazon.awscdk.services.personalize

Interface CfnSolutionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSolutionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:00.716Z")
@Stability(Stable)
public interface CfnSolutionProps
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	CfnSolutionProps.Builder	A builder for CfnSolutionProps
static final class	CfnSolutionProps.Jsii$Proxy	An implementation for CfnSolutionProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasetGroupArn

@Stability(Stable)
@NotNull
String getDatasetGroupArn()

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the solution.

getEventType

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default Object getPerformAutoMl()

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.

getPerformHpo

@Stability(Stable)
@Nullable
default Object getPerformHpo()

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

The default is false .

getRecipeArn

@Stability(Stable)
@Nullable
default String getRecipeArn()

The ARN of the recipe used to create the solution.

getSolutionConfig

@Stability(Stable)
@Nullable
default Object getSolutionConfig()

Describes the configuration properties for the solution.

builder

@Stability(Stable)
static CfnSolutionProps.Builder builder()

Returns:

a CfnSolutionProps.Builder of CfnSolutionProps