Package software.amazon.awscdk.services.customerprofiles

Class CfnRecommenderSchema

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.CfnRecommenderSchema
All Implemented Interfaces:
IInspectable, IRecommenderSchemaRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:48.878Z") @Stability(Stable) public class CfnRecommenderSchema extends CfnResource implements IInspectable, IRecommenderSchemaRef, ITaggableV2
A recommender schema defining the set of data columns available for training recommenders and filters under an Amazon Connect Customer Profiles domain.

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.*;
 CfnRecommenderSchema cfnRecommenderSchema = CfnRecommenderSchema.Builder.create(this, "MyCfnRecommenderSchema")
         .domainName("domainName")
         .fields(Map.of(
                 "fieldsKey", List.of(RecommenderSchemaFieldProperty.builder()
                         .targetFieldName("targetFieldName")
                         // the properties below are optional
                         .contentType("contentType")
                         .featureType("featureType")
                         .build())))
         .recommenderSchemaName("recommenderSchemaName")
         // the properties below are optional
         .tags(List.of(TagsItemsProperty.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

    • CfnRecommenderSchema

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

    • CfnRecommenderSchema

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

    • CfnRecommenderSchema

      @Stability(Stable) public CfnRecommenderSchema(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRecommenderSchemaProps props)
      Create a new AWS::CustomerProfiles::RecommenderSchema.

      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

    • arnForRecommenderSchema

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

    • isCfnRecommenderSchema

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

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()

    • 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

    • getCfnPropertyNames

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

    • getRecommenderSchemaRef

      @Stability(Stable) @NotNull public RecommenderSchemaReference getRecommenderSchemaRef()
      A reference to a RecommenderSchema resource.
      Specified by:
      getRecommenderSchemaRef in interface IRecommenderSchemaRef

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)

    • getFields

      @Stability(Stable) @NotNull public Object getFields()
      Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or Listinvalid input: '<'either IResolvable or CfnRecommenderSchema.RecommenderSchemaFieldProperty>>

    • setFields

      @Stability(Stable) public void setFields(@NotNull IResolvable value)

    • setFields

      @Stability(Stable) public void setFields(@NotNull Map<String,Object> value)

    • getRecommenderSchemaName

      @Stability(Stable) @NotNull public String getRecommenderSchemaName()

    • setRecommenderSchemaName

      @Stability(Stable) public void setRecommenderSchemaName(@NotNull String value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnRecommenderSchema.TagsItemsProperty> getTags()

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnRecommenderSchema.TagsItemsProperty> value)