interface FilterOperationProperty

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

A transform operation that filters rows based on a condition.

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 filterOperationProperty: quicksight.CfnDataSet.FilterOperationProperty = {
  conditionExpression: 'conditionExpression',
  dateFilterCondition: {
    columnName: 'columnName',
    comparisonFilterCondition: {
      operator: 'operator',

      // the properties below are optional
      value: {
        staticValue: 'staticValue',
      },
    },
    rangeFilterCondition: {
      includeMaximum: false,
      includeMinimum: false,
      rangeMaximum: {
        staticValue: 'staticValue',
      },
      rangeMinimum: {
        staticValue: 'staticValue',
      },
    },
  },
  numericFilterCondition: {
    columnName: 'columnName',
    comparisonFilterCondition: {
      operator: 'operator',

      // the properties below are optional
      value: {
        staticValue: 123,
      },
    },
    rangeFilterCondition: {
      includeMaximum: false,
      includeMinimum: false,
      rangeMaximum: {
        staticValue: 123,
      },
      rangeMinimum: {
        staticValue: 123,
      },
    },
  },
  stringFilterCondition: {
    columnName: 'columnName',
    comparisonFilterCondition: {
      operator: 'operator',

      // the properties below are optional
      value: {
        staticValue: 'staticValue',
      },
    },
    listFilterCondition: {
      operator: 'operator',

      // the properties below are optional
      values: {
        staticValues: ['staticValues'],
      },
    },
  },
};

Properties

Name	Type	Description
conditionExpression?	`string`	An expression that must evaluate to a Boolean value.
dateFilterCondition?	`IResolvable` `\|` `DataSetDateFilterConditionProperty`	A date-based filter condition within a filter operation.
numericFilterCondition?	`IResolvable` `\|` `DataSetNumericFilterConditionProperty`	A numeric-based filter condition within a filter operation.
stringFilterCondition?	`IResolvable` `\|` `DataSetStringFilterConditionProperty`	A string-based filter condition within a filter operation.

conditionExpression?

Type: string (optional)

An expression that must evaluate to a Boolean value.

Rows for which the expression evaluates to true are kept in the dataset.

dateFilterCondition?

Type: IResolvable | DataSetDateFilterConditionProperty (optional)

A date-based filter condition within a filter operation.

numericFilterCondition?

Type: IResolvable | DataSetNumericFilterConditionProperty (optional)

A numeric-based filter condition within a filter operation.

stringFilterCondition?

Type: IResolvable | DataSetStringFilterConditionProperty (optional)

A string-based filter condition within a filter operation.

AWS CDK

2.233.0