interface NestedFilterProperty

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

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html

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 nestedFilterProperty: quicksight.CfnTemplate.NestedFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  includeInnerSet: false,
  innerFilter: {
    categoryInnerFilter: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      configuration: {
        customFilterConfiguration: {
          matchOperator: 'matchOperator',
          nullOption: 'nullOption',

          // the properties below are optional
          categoryValue: 'categoryValue',
          parameterName: 'parameterName',
          selectAllOptions: 'selectAllOptions',
        },
        customFilterListConfiguration: {
          matchOperator: 'matchOperator',
          nullOption: 'nullOption',

          // the properties below are optional
          categoryValues: ['categoryValues'],
          selectAllOptions: 'selectAllOptions',
        },
        filterListConfiguration: {
          matchOperator: 'matchOperator',

          // the properties below are optional
          categoryValues: ['categoryValues'],
          nullOption: 'nullOption',
          selectAllOptions: 'selectAllOptions',
        },
      },

      // the properties below are optional
      defaultFilterControlConfiguration: {
        controlOptions: {
          defaultDateTimePickerOptions: {
            commitMode: 'commitMode',
            displayOptions: {
              dateTimeFormat: 'dateTimeFormat',
              infoIconLabelOptions: {
                infoIconText: 'infoIconText',
                visibility: 'visibility',
              },
              titleOptions: {
                customLabel: 'customLabel',
                fontConfiguration: {
                  fontColor: 'fontColor',
                  fontDecoration: 'fontDecoration',
                  fontSize: {
                    relative: 'relative',
                  },
                  fontStyle: 'fontStyle',
                  fontWeight: {
                    name: 'name',
                  },
                },
                visibility: 'visibility',
              },
            },
            type: 'type',
          },
          defaultDropdownOptions: {
            commitMode: 'commitMode',
            displayOptions: {
              infoIconLabelOptions: {
                infoIconText: 'infoIconText',
                visibility: 'visibility',
              },
              selectAllOptions: {
                visibility: 'visibility',
              },
              titleOptions: {
                customLabel: 'customLabel',
                fontConfiguration: {
                  fontColor: 'fontColor',
                  fontDecoration: 'fontDecoration',
                  fontSize: {
                    relative: 'relative',
                  },
                  fontStyle: 'fontStyle',
                  fontWeight: {
                    name: 'name',
                  },
                },
                visibility: 'visibility',
              },
            },
            selectableValues: {
              values: ['values'],
            },
            type: 'type',
          },
          defaultListOptions: {
            displayOptions: {
              infoIconLabelOptions: {
                infoIconText: 'infoIconText',
                visibility: 'visibility',
              },
              searchOptions: {
                visibility: 'visibility',
              },
              selectAllOptions: {
                visibility: 'visibility',
              },
              titleOptions: {
                customLabel: 'customLabel',
                fontConfiguration: {
                  fontColor: 'fontColor',
                  fontDecoration: 'fontDecoration',
                  fontSize: {
                    relative: 'relative',
                  },
                  fontStyle: 'fontStyle',
                  fontWeight: {
                    name: 'name',
                  },
                },
                visibility: 'visibility',
              },
            },
            selectableValues: {
              values: ['values'],
            },
            type: 'type',
          },
          defaultRelativeDateTimeOptions: {
            commitMode: 'commitMode',
            displayOptions: {
              dateTimeFormat: 'dateTimeFormat',
              infoIconLabelOptions: {
                infoIconText: 'infoIconText',
                visibility: 'visibility',
              },
              titleOptions: {
                customLabel: 'customLabel',
                fontConfiguration: {
                  fontColor: 'fontColor',
                  fontDecoration: 'fontDecoration',
                  fontSize: {
                    relative: 'relative',
                  },
                  fontStyle: 'fontStyle',
                  fontWeight: {
                    name: 'name',
                  },
                },
                visibility: 'visibility',
              },
            },
          },
          defaultSliderOptions: {
            maximumValue: 123,
            minimumValue: 123,
            stepSize: 123,

            // the properties below are optional
            displayOptions: {
              infoIconLabelOptions: {
                infoIconText: 'infoIconText',
                visibility: 'visibility',
              },
              titleOptions: {
                customLabel: 'customLabel',
                fontConfiguration: {
                  fontColor: 'fontColor',
                  fontDecoration: 'fontDecoration',
                  fontSize: {
                    relative: 'relative',
                  },
                  fontStyle: 'fontStyle',
                  fontWeight: {
                    name: 'name',
                  },
                },
                visibility: 'visibility',
              },
            },
            type: 'type',
          },
          defaultTextAreaOptions: {
            delimiter: 'delimiter',
            displayOptions: {
              infoIconLabelOptions: {
                infoIconText: 'infoIconText',
                visibility: 'visibility',
              },
              placeholderOptions: {
                visibility: 'visibility',
              },
              titleOptions: {
                customLabel: 'customLabel',
                fontConfiguration: {
                  fontColor: 'fontColor',
                  fontDecoration: 'fontDecoration',
                  fontSize: {
                    relative: 'relative',
                  },
                  fontStyle: 'fontStyle',
                  fontWeight: {
                    name: 'name',
                  },
                },
                visibility: 'visibility',
              },
            },
          },
          defaultTextFieldOptions: {
            displayOptions: {
              infoIconLabelOptions: {
                infoIconText: 'infoIconText',
                visibility: 'visibility',
              },
              placeholderOptions: {
                visibility: 'visibility',
              },
              titleOptions: {
                customLabel: 'customLabel',
                fontConfiguration: {
                  fontColor: 'fontColor',
                  fontDecoration: 'fontDecoration',
                  fontSize: {
                    relative: 'relative',
                  },
                  fontStyle: 'fontStyle',
                  fontWeight: {
                    name: 'name',
                  },
                },
                visibility: 'visibility',
              },
            },
          },
        },
        title: 'title',
      },
    },
  },
};

Properties

Name	Type	Description
column	IResolvable | ColumnIdentifierProperty	The column that the filter is applied to.
filterId	string	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
includeInnerSet	boolean | IResolvable	A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.
innerFilter	IResolvable | InnerFilterProperty	The InnerFilter defines the subset of data to be used with the NestedFilter .

---

column

Type: IResolvable | ColumnIdentifierProperty

The column that the filter is applied to.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-column

---

filterId

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-filterid

---

includeInnerSet

Type: boolean | IResolvable

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-includeinnerset

---

innerFilter

Type: IResolvable | InnerFilterProperty

The InnerFilter defines the subset of data to be used with the NestedFilter .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-innerfilter