interface TimeEqualityFilterProperty

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

A TimeEqualityFilter filters values that are equal to a given value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.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 timeEqualityFilterProperty: quicksight.CfnTemplate.TimeEqualityFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',

  // 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',
  },
  parameterName: 'parameterName',
  rollingDate: {
    expression: 'expression',

    // the properties below are optional
    dataSetIdentifier: 'dataSetIdentifier',
  },
  timeGranularity: 'timeGranularity',
  value: 'value',
};

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.
defaultFilterControlConfiguration?	IResolvable | DefaultFilterControlConfigurationProperty	The default configurations for the associated controls.
parameterName?	string	The parameter whose value should be used for the filter value.
rollingDate?	IResolvable | RollingDateConfigurationProperty	The rolling date input for the TimeEquality filter.
timeGranularity?	string	The level of time precision that is used to aggregate DateTime values.
value?	string	The value of a TimeEquality filter.

---

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-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-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-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-filterid

---

defaultFilterControlConfiguration?

Type: IResolvable | DefaultFilterControlConfigurationProperty (optional)

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

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

---

parameterName?

Type: string (optional)

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

This field is mutually exclusive to Value and RollingDate .

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

---

rollingDate?

Type: IResolvable | RollingDateConfigurationProperty (optional)

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName .

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

---

timeGranularity?

Type: string (optional)

The level of time precision that is used to aggregate DateTime values.

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

---

value?

Type: string (optional)

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName .

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