software.amazon.awscdk.services.personalize

Class CfnSolution

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.personalize.CfnSolution

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:16.191Z")
 @Stability(value=Stable)
public class CfnSolution
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Personalize::Solution`.

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

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;
 CfnSolution cfnSolution = CfnSolution.Builder.create(this, "MyCfnSolution")
         .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	Class and Description
static interface	CfnSolution.AlgorithmHyperParameterRangesProperty Example:
static interface	CfnSolution.AutoMLConfigProperty When the solution performs AutoML ( `performAutoML` is true in [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) ), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric.
static class	CfnSolution.Builder A fluent builder for CfnSolution.
static interface	CfnSolution.CategoricalHyperParameterRangeProperty Provides the name and range of a categorical hyperparameter.
static interface	CfnSolution.ContinuousHyperParameterRangeProperty Provides the name and range of a continuous hyperparameter.
static interface	CfnSolution.HpoConfigProperty Describes the properties for hyperparameter optimization (HPO).
static interface	CfnSolution.HpoObjectiveProperty The metric to optimize during hyperparameter optimization (HPO).
static interface	CfnSolution.HpoResourceConfigProperty Describes the resource configuration for hyperparameter optimization (HPO).
static interface	CfnSolution.IntegerHyperParameterRangeProperty Provides the name and range of an integer-valued hyperparameter.
static interface	CfnSolution.SolutionConfigProperty Describes the configuration properties for the solution.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSolution(Construct scope, String id, CfnSolutionProps props) Create a new `AWS::Personalize::Solution`.
protected	CfnSolution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSolution(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrSolutionArn() The Amazon Resource Name (ARN) of the solution.
protected Map<String,Object>	getCfnProperties()
String	getDatasetGroupArn() The Amazon Resource Name (ARN) of the dataset group that provides the training data.
String	getEventType() The event type (for example, 'click' or 'like') that is used for training the model.
String	getName() The name of the solution.
Object	getPerformAutoMl() > We don't recommend enabling automated machine learning.
Object	getPerformHpo() Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
String	getRecipeArn() The ARN of the recipe used to create the solution.
Object	getSolutionConfig() Describes the configuration properties for the solution.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatasetGroupArn(String value) The Amazon Resource Name (ARN) of the dataset group that provides the training data.
void	setEventType(String value) The event type (for example, 'click' or 'like') that is used for training the model.
void	setName(String value) The name of the solution.
void	setPerformAutoMl(Boolean value) > We don't recommend enabling automated machine learning.
void	setPerformAutoMl(IResolvable value) > We don't recommend enabling automated machine learning.
void	setPerformHpo(Boolean value) Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
void	setPerformHpo(IResolvable value) Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
void	setRecipeArn(String value) The ARN of the recipe used to create the solution.
void	setSolutionConfig(CfnSolution.SolutionConfigProperty value) Describes the configuration properties for the solution.
void	setSolutionConfig(IResolvable value) Describes the configuration properties for the solution.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSolution

protected CfnSolution(software.amazon.jsii.JsiiObjectRef objRef)

CfnSolution

protected CfnSolution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSolution

@Stability(value=Stable)
public CfnSolution(@NotNull
                                            Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnSolutionProps props)

Create a new `AWS::Personalize::Solution`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrSolutionArn

@Stability(value=Stable)
 @NotNull
public String getAttrSolutionArn()

The Amazon Resource Name (ARN) of the solution.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDatasetGroupArn

@Stability(value=Stable)
 @NotNull
public String getDatasetGroupArn()

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

setDatasetGroupArn

@Stability(value=Stable)
public void setDatasetGroupArn(@NotNull
                                                        String value)

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

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the solution.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the solution.

getEventType

@Stability(value=Stable)
 @Nullable
public 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.

setEventType

@Stability(value=Stable)
public void setEventType(@Nullable
                                                  String value)

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(value=Stable)
 @Nullable
public 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.

setPerformAutoMl

@Stability(value=Stable)
public void setPerformAutoMl(@Nullable
                                                      Boolean value)

> 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.

setPerformAutoMl

@Stability(value=Stable)
public void setPerformAutoMl(@Nullable
                                                      IResolvable value)

> 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(value=Stable)
 @Nullable
public Object getPerformHpo()

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

The default is false .

setPerformHpo

@Stability(value=Stable)
public void setPerformHpo(@Nullable
                                                   Boolean value)

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

The default is false .

setPerformHpo

@Stability(value=Stable)
public void setPerformHpo(@Nullable
                                                   IResolvable value)

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

The default is false .

getRecipeArn

@Stability(value=Stable)
 @Nullable
public String getRecipeArn()

The ARN of the recipe used to create the solution.

setRecipeArn

@Stability(value=Stable)
public void setRecipeArn(@Nullable
                                                  String value)

The ARN of the recipe used to create the solution.

getSolutionConfig

@Stability(value=Stable)
 @Nullable
public Object getSolutionConfig()

Describes the configuration properties for the solution.

setSolutionConfig

@Stability(value=Stable)
public void setSolutionConfig(@Nullable
                                                       IResolvable value)

Describes the configuration properties for the solution.

setSolutionConfig

@Stability(value=Stable)
public void setSolutionConfig(@Nullable
                                                       CfnSolution.SolutionConfigProperty value)

Describes the configuration properties for the solution.