Class CfnSolution
A CloudFormation AWS::Personalize::Solution
.
Inherited Members
Namespace: Amazon.CDK.AWS.Personalize
Assembly: Amazon.CDK.AWS.Personalize.dll
Syntax (csharp)
public class CfnSolution : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSolution
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.
CloudformationResource: AWS::Personalize::Solution
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Personalize;
var autoMlConfig;
var hpoConfig;
var cfnSolution = new CfnSolution(this, "MyCfnSolution", new CfnSolutionProps {
DatasetGroupArn = "datasetGroupArn",
Name = "name",
// the properties below are optional
EventType = "eventType",
PerformAutoMl = false,
PerformHpo = false,
RecipeArn = "recipeArn",
SolutionConfig = new SolutionConfigProperty {
AlgorithmHyperParameters = new Dictionary<string, string> {
{ "algorithmHyperParametersKey", "algorithmHyperParameters" }
},
AutoMlConfig = autoMlConfig,
EventValueThreshold = "eventValueThreshold",
FeatureTransformationParameters = new Dictionary<string, string> {
{ "featureTransformationParametersKey", "featureTransformationParameters" }
},
HpoConfig = hpoConfig
}
});
Synopsis
Constructors
CfnSolution(Construct, String, ICfnSolutionProps) | Create a new |
CfnSolution(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSolution(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrSolutionArn | The Amazon Resource Name (ARN) of the solution. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DatasetGroupArn | The Amazon Resource Name (ARN) of the dataset group that provides the training data. |
EventType | The event type (for example, 'click' or 'like') that is used for training the model. |
Name | The name of the solution. |
PerformAutoMl | We don't recommend enabling automated machine learning. |
PerformHpo | Whether to perform hyperparameter optimization (HPO) on the chosen recipe. |
RecipeArn | The ARN of the recipe used to create the solution. |
SolutionConfig | Describes the configuration properties for the solution. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSolution(Construct, String, ICfnSolutionProps)
Create a new AWS::Personalize::Solution
.
public CfnSolution(Construct scope, string id, ICfnSolutionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSolutionProps
- resource properties.
CfnSolution(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSolution(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSolution(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSolution(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrSolutionArn
The Amazon Resource Name (ARN) of the solution.
public virtual string AttrSolutionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SolutionArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DatasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
public virtual string DatasetGroupArn { get; set; }
Property Value
System.String
Remarks
EventType
The event type (for example, 'click' or 'like') that is used for training the model.
public virtual string EventType { get; set; }
Property Value
System.String
Remarks
If no eventType
is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
Name
The name of the solution.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
PerformAutoMl
We don't recommend enabling automated machine learning.
public virtual object PerformAutoMl { get; set; }
Property Value
System.Object
Remarks
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.
PerformHpo
Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
public virtual object PerformHpo { get; set; }
Property Value
System.Object
Remarks
RecipeArn
The ARN of the recipe used to create the solution.
public virtual string RecipeArn { get; set; }
Property Value
System.String
Remarks
SolutionConfig
Describes the configuration properties for the solution.
public virtual object SolutionConfig { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>