aws-cdk-lib.aws_quicksight.CfnTopic.TopicFilterProperty

interface TopicFilterProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTopic.TopicFilterProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTopic_TopicFilterProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTopic.TopicFilterProperty
Pythonaws_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.

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

NameTypeDescription
filterNamestringThe name of the filter.
operandFieldNamestringThe name of the field that the filter operates on.
categoryFilter?IResolvable | TopicCategoryFilterPropertyThe category filter that is associated with this filter.
dateRangeFilter?IResolvable | TopicDateRangeFilterPropertyThe date range filter.
filterClass?stringThe class of the filter.
filterDescription?stringA description of the filter used to select items for a topic.
filterSynonyms?string[]The other names or aliases for the filter.
filterType?stringThe type of the filter.
numericEqualityFilter?IResolvable | TopicNumericEqualityFilterPropertyThe numeric equality filter.
numericRangeFilter?IResolvable | TopicNumericRangeFilterPropertyThe numeric range filter.
relativeDateFilter?IResolvable | TopicRelativeDateFilterPropertyThe relative date filter.

filterName

Type: string

The name of the filter.


operandFieldName

Type: string

The name of the field that the filter operates on.


categoryFilter?

Type: IResolvable | TopicCategoryFilterProperty (optional)

The category filter that is associated with this filter.


dateRangeFilter?

Type: IResolvable | TopicDateRangeFilterProperty (optional)

The date range filter.


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 .


filterDescription?

Type: string (optional)

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


filterSynonyms?

Type: string[] (optional)

The other names or aliases for the filter.


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 .


numericEqualityFilter?

Type: IResolvable | TopicNumericEqualityFilterProperty (optional)

The numeric equality filter.


numericRangeFilter?

Type: IResolvable | TopicNumericRangeFilterProperty (optional)

The numeric range filter.


relativeDateFilter?

Type: IResolvable | TopicRelativeDateFilterProperty (optional)

The relative date filter.