aws-cdk-lib.aws_quicksight.CfnTopic.TopicNumericRangeFilterProperty

TopicNumericRangeFilterProperty Struct

A filter that filters topics based on the value of a numeric field.

The filter includes only topics whose numeric field value falls within the specified range.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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 topicNumericRangeFilterProperty: quicksight.CfnTopic.TopicNumericRangeFilterProperty = {
  aggregation: 'aggregation',
  constant: {
    constantType: 'constantType',
    rangeConstant: {
      maximum: 'maximum',
      minimum: 'minimum',
    },
  },
  inclusive: false,
};

Properties

aggregation?optionalstringaggregation?optionalstraggregation?optionalStringAggregation?optionalstringAggregation?optional*string#

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are `NO_AGGREGATION` , `SUM` , `AVERAGE` , `COUNT` , `DISTINCT_COUNT` , `MAX` , `MEDIAN` , `MIN` , `STDEV` , `STDEVP` , `VAR` , and `VARP` .

constant?optionalIResolvable | CfnTopic.TopicRangeFilterConstantPropertyconstant?optionaltyping.Union[IResolvable, TopicRangeFilterConstantProperty]constant?optionalIResolvableConstant?optionalIResolvableConstant?optionalinterface{}#

The constant used in a numeric range filter.

inclusive?optionalboolean | IResolvableinclusive?optionaltyping.Union[bool, IResolvable]inclusive?optionalBooleanInclusive?optionalboolInclusive?optionalinterface{}= false#

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.

If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.