aws-cdk-lib.aws_quicksight.CfnDashboard.NumericEqualityFilterProperty

interface NumericEqualityFilterProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboard.NumericEqualityFilterProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_NumericEqualityFilterProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboard.NumericEqualityFilterProperty
Pythonaws_cdk.aws_quicksight.CfnDashboard.NumericEqualityFilterProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnDashboard » NumericEqualityFilterProperty

A NumericEqualityFilter filters values that are equal to the specified value.

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 numericEqualityFilterProperty: quicksight.CfnDashboard.NumericEqualityFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  matchOperator: 'matchOperator',
  nullOption: 'nullOption',

  // the properties below are optional
  aggregationFunction: {
    categoricalAggregationFunction: 'categoricalAggregationFunction',
    dateAggregationFunction: 'dateAggregationFunction',
    numericalAggregationFunction: {
      percentileAggregation: {
        percentileValue: 123,
      },
      simpleNumericalAggregation: 'simpleNumericalAggregation',
    },
  },
  parameterName: 'parameterName',
  selectAllOptions: 'selectAllOptions',
  value: 123,
};

Properties

NameTypeDescription
columnIResolvable | ColumnIdentifierPropertyThe column that the filter is applied to.
filterIdstringAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.
matchOperatorstringThe match operator that is used to determine if a filter should be applied.
nullOptionstringThis option determines how null values should be treated when filtering data.
aggregationFunction?IResolvable | AggregationFunctionPropertyThe aggregation function of the filter.
parameterName?stringThe parameter whose value should be used for the filter value.
selectAllOptions?stringSelect all of the values. Null is not the assigned value of select all.
value?numberThe input value.

column

Type: IResolvable | ColumnIdentifierProperty

The column that the filter is applied to.


filterId

Type: string

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.


matchOperator

Type: string

The match operator that is used to determine if a filter should be applied.


nullOption

Type: string

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.
  • NULLS_ONLY : Only include null values in filtered results.
  • NON_NULLS_ONLY : Exclude null values from filtered results.

aggregationFunction?

Type: IResolvable | AggregationFunctionProperty (optional)

The aggregation function of the filter.


parameterName?

Type: string (optional)

The parameter whose value should be used for the filter value.


selectAllOptions?

Type: string (optional)

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

value?

Type: number (optional)

The input value.