interface TopicNumericRangeFilterProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.QuickSight.CfnTopic.TopicNumericRangeFilterProperty |
Java | software.amazon.awscdk.services.quicksight.CfnTopic.TopicNumericRangeFilterProperty |
Python | aws_cdk.aws_quicksight.CfnTopic.TopicNumericRangeFilterProperty |
TypeScript | @aws-cdk/aws-quicksight » CfnTopic » TopicNumericRangeFilterProperty |
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const topicNumericRangeFilterProperty: quicksight.CfnTopic.TopicNumericRangeFilterProperty = {
aggregation: 'aggregation',
constant: {
constantType: 'constantType',
rangeConstant: {
maximum: 'maximum',
minimum: 'minimum',
},
},
inclusive: false,
};
Properties
Name | Type | Description |
---|---|---|
aggregation? | 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? | IResolvable | Topic | The constant used in a numeric range filter. |
inclusive? | boolean | IResolvable | A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. |
aggregation?
Type:
string
(optional)
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?
Type:
IResolvable
|
Topic
(optional)
The constant used in a numeric range filter.
inclusive?
Type:
boolean |
IResolvable
(optional)
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.