Package software.amazon.awscdk.services.customerprofiles

Interface CfnRecommenderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRecommenderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:08.022Z")
@Stability(Stable)
public interface CfnRecommenderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRecommender.

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.customerprofiles.*;
 CfnRecommenderProps cfnRecommenderProps = CfnRecommenderProps.builder()
         .domainName("domainName")
         .recommenderName("recommenderName")
         .recommenderRecipeName("recommenderRecipeName")
         // the properties below are optional
         .description("description")
         .recommenderConfig(RecommenderConfigProperty.builder()
                 .eventsConfig(EventsConfigProperty.builder()
                         .eventParametersList(List.of(EventParametersProperty.builder()
                                 .eventType("eventType")
                                 // the properties below are optional
                                 .eventValueThreshold(123)
                                 .build()))
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRecommenderProps.Builder	A builder for CfnRecommenderProps
static final class	CfnRecommenderProps.Jsii$Proxy	An implementation for CfnRecommenderProps

Method Summary

Modifier and Type	Method	Description
static CfnRecommenderProps.Builder	builder()
default String	getDescription()	The description of the recommender.
String	getDomainName()	The name of the domain for which the recommender will be created.
default Object	getRecommenderConfig()	Configuration for the recommender.
String	getRecommenderName()	The name of the recommender.
String	getRecommenderRecipeName()	The name of the recommender recipe.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The name of the domain for which the recommender will be created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-domainname

getRecommenderName

@Stability(Stable)
@NotNull
String getRecommenderName()

The name of the recommender.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommendername

getRecommenderRecipeName

@Stability(Stable)
@NotNull
String getRecommenderRecipeName()

The name of the recommender recipe.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommenderrecipename

getDescription

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

The description of the recommender.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-description

getRecommenderConfig

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

Configuration for the recommender.

Returns union: either IResolvable or CfnRecommender.RecommenderConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommenderconfig

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags used to organize, track, or control access for this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-tags

builder

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

Returns:

a CfnRecommenderProps.Builder of CfnRecommenderProps