interface TopicFilterProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTopic.TopicFilterProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTopic_TopicFilterProperty
Java	software.amazon.awscdk.services.quicksight.CfnTopic.TopicFilterProperty
Python	aws_cdk.aws_quicksight.CfnTopic.TopicFilterProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnTopic » TopicFilterProperty

A structure that represents a filter used to select items for a topic.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const topicFilterProperty: quicksight.CfnTopic.TopicFilterProperty = {
  filterName: 'filterName',
  operandFieldName: 'operandFieldName',

  // the properties below are optional
  categoryFilter: {
    categoryFilterFunction: 'categoryFilterFunction',
    categoryFilterType: 'categoryFilterType',
    constant: {
      collectiveConstant: {
        valueList: ['valueList'],
      },
      constantType: 'constantType',
      singularConstant: 'singularConstant',
    },
    inverse: false,
  },
  dateRangeFilter: {
    constant: {
      constantType: 'constantType',
      rangeConstant: {
        maximum: 'maximum',
        minimum: 'minimum',
      },
    },
    inclusive: false,
  },
  filterClass: 'filterClass',
  filterDescription: 'filterDescription',
  filterSynonyms: ['filterSynonyms'],
  filterType: 'filterType',
  numericEqualityFilter: {
    aggregation: 'aggregation',
    constant: {
      constantType: 'constantType',
      singularConstant: 'singularConstant',
    },
  },
  numericRangeFilter: {
    aggregation: 'aggregation',
    constant: {
      constantType: 'constantType',
      rangeConstant: {
        maximum: 'maximum',
        minimum: 'minimum',
      },
    },
    inclusive: false,
  },
  relativeDateFilter: {
    constant: {
      constantType: 'constantType',
      singularConstant: 'singularConstant',
    },
    relativeDateFilterFunction: 'relativeDateFilterFunction',
    timeGranularity: 'timeGranularity',
  },
};

Properties

Name	Type	Description
filterName	string	The name of the filter.
operandFieldName	string	The name of the field that the filter operates on.
categoryFilter?	IResolvable | TopicCategoryFilterProperty	The category filter that is associated with this filter.
dateRangeFilter?	IResolvable | TopicDateRangeFilterProperty	The date range filter.
filterClass?	string	The class of the filter.
filterDescription?	string	A description of the filter used to select items for a topic.
filterSynonyms?	string[]	The other names or aliases for the filter.
filterType?	string	The type of the filter.
numericEqualityFilter?	IResolvable | TopicNumericEqualityFilterProperty	The numeric equality filter.
numericRangeFilter?	IResolvable | TopicNumericRangeFilterProperty	The numeric range filter.
relativeDateFilter?	IResolvable | TopicRelativeDateFilterProperty	The relative date filter.

---

filterName

Type: string

The name of the filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtername

---

operandFieldName

Type: string

The name of the field that the filter operates on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-operandfieldname

---

categoryFilter?

Type: IResolvable | TopicCategoryFilterProperty (optional)

The category filter that is associated with this filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-categoryfilter

---

dateRangeFilter?

Type: IResolvable | TopicDateRangeFilterProperty (optional)

The date range filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-daterangefilter

---

filterClass?

Type: string (optional)

The class of the filter.

Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterclass

---

filterDescription?

Type: string (optional)

A description of the filter used to select items for a topic.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterdescription

---

filterSynonyms?

Type: string[] (optional)

The other names or aliases for the filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtersynonyms

---

filterType?

Type: string (optional)

The type of the filter.

Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtertype

---

numericEqualityFilter?

Type: IResolvable | TopicNumericEqualityFilterProperty (optional)

The numeric equality filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericequalityfilter

---

numericRangeFilter?

Type: IResolvable | TopicNumericRangeFilterProperty (optional)

The numeric range filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericrangefilter

---

relativeDateFilter?

Type: IResolvable | TopicRelativeDateFilterProperty (optional)

The relative date filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-relativedatefilter