Package software.amazon.awscdk.services.customerprofiles

Class CfnRecommender

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.customerprofiles.CfnRecommender
All Implemented Interfaces:
IInspectable, IRecommenderRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T21:55:08.018Z") @Stability(Stable) public class CfnRecommender extends CfnResource implements IInspectable, IRecommenderRef, ITaggableV2
Resource Type definition for AWS::CustomerProfiles::Recommender.

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.*;
 CfnRecommender cfnRecommender = CfnRecommender.Builder.create(this, "MyCfnRecommender")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRecommender

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

    • CfnRecommender

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

    • CfnRecommender

      @Stability(Stable) public CfnRecommender(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRecommenderProps props)
      Create a new AWS::CustomerProfiles::Recommender.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForRecommender

      @Stability(Stable) @NotNull public static String arnForRecommender(@NotNull IRecommenderRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnRecommender

      @Stability(Stable) @NotNull public static Boolean isCfnRecommender(@NotNull Object x)
      Checks whether the given object is a CfnRecommender.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the recommender was created.

    • getAttrFailureReason

      @Stability(Stable) @NotNull public String getAttrFailureReason()
      The reason for recommender failure.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The timestamp of when the recommender was last updated.

    • getAttrLatestRecommenderUpdate

      @Stability(Stable) @NotNull public IResolvable getAttrLatestRecommenderUpdate()
      Information about the latest recommender update.

    • getAttrRecommenderArn

      @Stability(Stable) @NotNull public String getAttrRecommenderArn()
      The Amazon Resource Name (ARN) of the recommender.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the recommender.

    • getAttrTrainingMetrics

      @Stability(Stable) @NotNull public IResolvable getAttrTrainingMetrics()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRecommenderRef

      @Stability(Stable) @NotNull public RecommenderReference getRecommenderRef()
      A reference to a Recommender resource.
      Specified by:
      getRecommenderRef in interface IRecommenderRef

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The name of the domain for which the recommender will be created.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The name of the domain for which the recommender will be created.

    • getRecommenderName

      @Stability(Stable) @NotNull public String getRecommenderName()
      The name of the recommender.

    • setRecommenderName

      @Stability(Stable) public void setRecommenderName(@NotNull String value)
      The name of the recommender.

    • getRecommenderRecipeName

      @Stability(Stable) @NotNull public String getRecommenderRecipeName()
      The name of the recommender recipe.

    • setRecommenderRecipeName

      @Stability(Stable) public void setRecommenderRecipeName(@NotNull String value)
      The name of the recommender recipe.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the recommender.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the recommender.

    • getRecommenderConfig

      @Stability(Stable) @Nullable public Object getRecommenderConfig()
      Configuration for the recommender.

      Returns union: either IResolvable or CfnRecommender.RecommenderConfigProperty

    • setRecommenderConfig

      @Stability(Stable) public void setRecommenderConfig(@Nullable IResolvable value)
      Configuration for the recommender.

    • setRecommenderConfig

      @Stability(Stable) public void setRecommenderConfig(@Nullable CfnRecommender.RecommenderConfigProperty value)
      Configuration for the recommender.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.