@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:49.456Z") public class CfnSolution extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnSolution(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrSolutionArn()
The Amazon Resource Name (ARN) of the solution.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDatasetGroupArn()
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
|
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.
|
java.lang.Object |
getPerformAutoMl()
> We don't recommend enabling automated machine learning.
|
java.lang.Object |
getPerformHpo()
Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
|
java.lang.String |
getRecipeArn()
The ARN of the recipe used to create the solution.
|
java.lang.Object |
getSolutionConfig()
Describes the configuration properties for the solution.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDatasetGroupArn(java.lang.String value)
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
|
void |
setEventType(java.lang.String value)
The event type (for example, 'click' or 'like') that is used for training the model.
|
void |
setName(java.lang.String value)
The name of the solution.
|
void |
setPerformAutoMl(java.lang.Boolean value)
> We don't recommend enabling automated machine learning.
|
void |
setPerformAutoMl(IResolvable value)
> We don't recommend enabling automated machine learning.
|
void |
setPerformHpo(java.lang.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(java.lang.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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnSolution(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnSolution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnSolution(Construct scope, java.lang.String id, CfnSolutionProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrSolutionArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDatasetGroupArn()
public void setDatasetGroupArn(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getEventType()
If no eventType
is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
public void setEventType(java.lang.String value)
If no eventType
is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
public java.lang.Object getPerformAutoMl()
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.
public void setPerformAutoMl(java.lang.Boolean value)
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.
public void setPerformAutoMl(IResolvable value)
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.
public java.lang.Object getPerformHpo()
The default is false
.
public void setPerformHpo(java.lang.Boolean value)
The default is false
.
public void setPerformHpo(IResolvable value)
The default is false
.
public java.lang.String getRecipeArn()
public void setRecipeArn(java.lang.String value)
public java.lang.Object getSolutionConfig()
public void setSolutionConfig(IResolvable value)
public void setSolutionConfig(CfnSolution.SolutionConfigProperty value)