Skip to content
v2.276.0

CfnRecommenderProps Struct Added in v2.276.0 ​

Properties for defining a CfnRecommender.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_personalize as personalize } from 'aws-cdk-lib';
const cfnRecommenderProps: personalize.CfnRecommenderProps = {
  datasetGroupArn: 'datasetGroupArn',
  name: 'name',
  recipeArn: 'recipeArn',

  // the properties below are optional
  recommenderConfig: {
    enableMetadataWithRecommendations: false,
    itemExplorationConfig: {
      itemExplorationConfigKey: 'itemExplorationConfig',
    },
    minRecommendationRequestsPerSecond: 123,
    trainingDataConfig: {
      excludedDatasetColumns: {
        excludedDatasetColumnsKey: ['excludedDatasetColumns'],
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_personalize as personalize

cfn_recommender_props = personalize.CfnRecommenderProps(
    dataset_group_arn="datasetGroupArn",
    name="name",
    recipe_arn="recipeArn",

    # the properties below are optional
    recommender_config=personalize.CfnRecommender.RecommenderConfigProperty(
        enable_metadata_with_recommendations=False,
        item_exploration_config={
            "item_exploration_config_key": "itemExplorationConfig"
        },
        min_recommendation_requests_per_second=123,
        training_data_config=personalize.CfnRecommender.TrainingDataConfigProperty(
            excluded_dataset_columns={
                "excluded_dataset_columns_key": ["excludedDatasetColumns"]
            }
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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.*;

CfnRecommenderProps cfnRecommenderProps = CfnRecommenderProps.builder()
        .datasetGroupArn("datasetGroupArn")
        .name("name")
        .recipeArn("recipeArn")

        // the properties below are optional
        .recommenderConfig(RecommenderConfigProperty.builder()
                .enableMetadataWithRecommendations(false)
                .itemExplorationConfig(Map.of(
                        "itemExplorationConfigKey", "itemExplorationConfig"))
                .minRecommendationRequestsPerSecond(123)
                .trainingDataConfig(TrainingDataConfigProperty.builder()
                        .excludedDatasetColumns(Map.of(
                                "excludedDatasetColumnsKey", List.of("excludedDatasetColumns")))
                        .build())
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnRecommenderProps = new CfnRecommenderProps {
    DatasetGroupArn = "datasetGroupArn",
    Name = "name",
    RecipeArn = "recipeArn",

    // the properties below are optional
    RecommenderConfig = new RecommenderConfigProperty {
        EnableMetadataWithRecommendations = false,
        ItemExplorationConfig = new Dictionary<string, string> {
            { "itemExplorationConfigKey", "itemExplorationConfig" }
        },
        MinRecommendationRequestsPerSecond = 123,
        TrainingDataConfig = new TrainingDataConfigProperty {
            ExcludedDatasetColumns = new Dictionary<string, string[]> {
                { "excludedDatasetColumnsKey", new [] { "excludedDatasetColumns" } }
            }
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnRecommenderProps := &CfnRecommenderProps{
	DatasetGroupArn: jsii.String("datasetGroupArn"),
	Name: jsii.String("name"),
	RecipeArn: jsii.String("recipeArn"),

	// the properties below are optional
	RecommenderConfig: &RecommenderConfigProperty{
		EnableMetadataWithRecommendations: jsii.Boolean(false),
		ItemExplorationConfig: map[string]*string{
			"itemExplorationConfigKey": jsii.String("itemExplorationConfig"),
		},
		MinRecommendationRequestsPerSecond: jsii.Number(123),
		TrainingDataConfig: &TrainingDataConfigProperty{
			ExcludedDatasetColumns: map[string][]*string{
				"excludedDatasetColumnsKey": []*string{
					jsii.String("excludedDatasetColumns"),
				},
			},
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

datasetGroupArnstringdataset_group_arnstrdatasetGroupArnStringDatasetGroupArnstringDatasetGroupArn*stringrequired#
The ARN of the Domain dataset group that the recommender is created for.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the recommender.
recipeArnstringrecipe_arnstrrecipeArnStringRecipeArnstringRecipeArn*stringrequired#
The ARN of the recipe (Domain dataset group use case) that the recommender uses.
recommenderConfigoptionalIResolvable | CfnRecommender.RecommenderConfigPropertyrecommender_configoptionaltyping.Union[IResolvable, RecommenderConfigProperty]recommenderConfigoptionalIResolvableRecommenderConfigoptionalIResolvableRecommenderConfigoptionalinterface{}#
The configuration details of the recommender.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Tags to associate with the recommender.