Skip to content
v2.275.0

CfnRecommenderFilterProps Struct Added in v2.275.0 ​

Properties for defining a CfnRecommenderFilter.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const cfnRecommenderFilterProps: customerprofiles.CfnRecommenderFilterProps = {
  domainName: 'domainName',
  recommenderFilterExpression: 'recommenderFilterExpression',
  recommenderFilterName: 'recommenderFilterName',

  // the properties below are optional
  description: 'description',
  recommenderSchemaName: 'recommenderSchemaName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the recommender filter.
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#
The unique name of the domain.
recommenderFilterExpressionstringrecommender_filter_expressionstrrecommenderFilterExpressionStringRecommenderFilterExpressionstringRecommenderFilterExpression*stringrequired#
The filter expression that defines which items to include or exclude from recommendations.
recommenderFilterNamestringrecommender_filter_namestrrecommenderFilterNameStringRecommenderFilterNamestringRecommenderFilterName*stringrequired#
The name of the recommender filter.
recommenderSchemaNameoptionalstringrecommender_schema_nameoptionalstrrecommenderSchemaNameoptionalStringRecommenderSchemaNameoptionalstringRecommenderSchemaNameoptional*string#
The name of the recommender schema to use for this recommender filter.

If not specified, the default schema is used.

tagsoptionalCfnRecommenderFilter.TagsItemsProperty[]tagsoptionaltyping.List[TagsItemsProperty]tagsoptionalList<TagsItemsProperty>TagsoptionalTagsItemsProperty[]Tagsoptional*[]TagsItemsProperty#
The tags used to organize, track, or control access for this resource.