Interface CfnTemplate.ITimeEqualityFilterProperty

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

Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ITimeEqualityFilterProperty
Syntax (vb)
Public Interface ITimeEqualityFilterProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var timeEqualityFilterProperty = new TimeEqualityFilterProperty {
    Column = new ColumnIdentifierProperty {
        ColumnName = "columnName",
        DataSetIdentifier = "dataSetIdentifier"
    },
    FilterId = "filterId",

    // the properties below are optional
    DefaultFilterControlConfiguration = new DefaultFilterControlConfigurationProperty {
        ControlOptions = new DefaultFilterControlOptionsProperty {
            DefaultDateTimePickerOptions = new DefaultDateTimePickerControlOptionsProperty {
                CommitMode = "commitMode",
                DisplayOptions = new DateTimePickerControlDisplayOptionsProperty {
                    DateTimeFormat = "dateTimeFormat",
                    InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                        InfoIconText = "infoIconText",
                        Visibility = "visibility"
                    },
                    TitleOptions = new LabelOptionsProperty {
                        CustomLabel = "customLabel",
                        FontConfiguration = new FontConfigurationProperty {
                            FontColor = "fontColor",
                            FontDecoration = "fontDecoration",
                            FontSize = new FontSizeProperty {
                                Relative = "relative"
                            },
                            FontStyle = "fontStyle",
                            FontWeight = new FontWeightProperty {
                                Name = "name"
                            }
                        },
                        Visibility = "visibility"
                    }
                },
                Type = "type"
            },
            DefaultDropdownOptions = new DefaultFilterDropDownControlOptionsProperty {
                CommitMode = "commitMode",
                DisplayOptions = new DropDownControlDisplayOptionsProperty {
                    InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                        InfoIconText = "infoIconText",
                        Visibility = "visibility"
                    },
                    SelectAllOptions = new ListControlSelectAllOptionsProperty {
                        Visibility = "visibility"
                    },
                    TitleOptions = new LabelOptionsProperty {
                        CustomLabel = "customLabel",
                        FontConfiguration = new FontConfigurationProperty {
                            FontColor = "fontColor",
                            FontDecoration = "fontDecoration",
                            FontSize = new FontSizeProperty {
                                Relative = "relative"
                            },
                            FontStyle = "fontStyle",
                            FontWeight = new FontWeightProperty {
                                Name = "name"
                            }
                        },
                        Visibility = "visibility"
                    }
                },
                SelectableValues = new FilterSelectableValuesProperty {
                    Values = new [] { "values" }
                },
                Type = "type"
            },
            DefaultListOptions = new DefaultFilterListControlOptionsProperty {
                DisplayOptions = new ListControlDisplayOptionsProperty {
                    InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                        InfoIconText = "infoIconText",
                        Visibility = "visibility"
                    },
                    SearchOptions = new ListControlSearchOptionsProperty {
                        Visibility = "visibility"
                    },
                    SelectAllOptions = new ListControlSelectAllOptionsProperty {
                        Visibility = "visibility"
                    },
                    TitleOptions = new LabelOptionsProperty {
                        CustomLabel = "customLabel",
                        FontConfiguration = new FontConfigurationProperty {
                            FontColor = "fontColor",
                            FontDecoration = "fontDecoration",
                            FontSize = new FontSizeProperty {
                                Relative = "relative"
                            },
                            FontStyle = "fontStyle",
                            FontWeight = new FontWeightProperty {
                                Name = "name"
                            }
                        },
                        Visibility = "visibility"
                    }
                },
                SelectableValues = new FilterSelectableValuesProperty {
                    Values = new [] { "values" }
                },
                Type = "type"
            },
            DefaultRelativeDateTimeOptions = new DefaultRelativeDateTimeControlOptionsProperty {
                CommitMode = "commitMode",
                DisplayOptions = new RelativeDateTimeControlDisplayOptionsProperty {
                    DateTimeFormat = "dateTimeFormat",
                    InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                        InfoIconText = "infoIconText",
                        Visibility = "visibility"
                    },
                    TitleOptions = new LabelOptionsProperty {
                        CustomLabel = "customLabel",
                        FontConfiguration = new FontConfigurationProperty {
                            FontColor = "fontColor",
                            FontDecoration = "fontDecoration",
                            FontSize = new FontSizeProperty {
                                Relative = "relative"
                            },
                            FontStyle = "fontStyle",
                            FontWeight = new FontWeightProperty {
                                Name = "name"
                            }
                        },
                        Visibility = "visibility"
                    }
                }
            },
            DefaultSliderOptions = new DefaultSliderControlOptionsProperty {
                MaximumValue = 123,
                MinimumValue = 123,
                StepSize = 123,

                // the properties below are optional
                DisplayOptions = new SliderControlDisplayOptionsProperty {
                    InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                        InfoIconText = "infoIconText",
                        Visibility = "visibility"
                    },
                    TitleOptions = new LabelOptionsProperty {
                        CustomLabel = "customLabel",
                        FontConfiguration = new FontConfigurationProperty {
                            FontColor = "fontColor",
                            FontDecoration = "fontDecoration",
                            FontSize = new FontSizeProperty {
                                Relative = "relative"
                            },
                            FontStyle = "fontStyle",
                            FontWeight = new FontWeightProperty {
                                Name = "name"
                            }
                        },
                        Visibility = "visibility"
                    }
                },
                Type = "type"
            },
            DefaultTextAreaOptions = new DefaultTextAreaControlOptionsProperty {
                Delimiter = "delimiter",
                DisplayOptions = new TextAreaControlDisplayOptionsProperty {
                    InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                        InfoIconText = "infoIconText",
                        Visibility = "visibility"
                    },
                    PlaceholderOptions = new TextControlPlaceholderOptionsProperty {
                        Visibility = "visibility"
                    },
                    TitleOptions = new LabelOptionsProperty {
                        CustomLabel = "customLabel",
                        FontConfiguration = new FontConfigurationProperty {
                            FontColor = "fontColor",
                            FontDecoration = "fontDecoration",
                            FontSize = new FontSizeProperty {
                                Relative = "relative"
                            },
                            FontStyle = "fontStyle",
                            FontWeight = new FontWeightProperty {
                                Name = "name"
                            }
                        },
                        Visibility = "visibility"
                    }
                }
            },
            DefaultTextFieldOptions = new DefaultTextFieldControlOptionsProperty {
                DisplayOptions = new TextFieldControlDisplayOptionsProperty {
                    InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                        InfoIconText = "infoIconText",
                        Visibility = "visibility"
                    },
                    PlaceholderOptions = new TextControlPlaceholderOptionsProperty {
                        Visibility = "visibility"
                    },
                    TitleOptions = new LabelOptionsProperty {
                        CustomLabel = "customLabel",
                        FontConfiguration = new FontConfigurationProperty {
                            FontColor = "fontColor",
                            FontDecoration = "fontDecoration",
                            FontSize = new FontSizeProperty {
                                Relative = "relative"
                            },
                            FontStyle = "fontStyle",
                            FontWeight = new FontWeightProperty {
                                Name = "name"
                            }
                        },
                        Visibility = "visibility"
                    }
                }
            }
        },
        Title = "title"
    },
    ParameterName = "parameterName",
    RollingDate = new RollingDateConfigurationProperty {
        Expression = "expression",

        // the properties below are optional
        DataSetIdentifier = "dataSetIdentifier"
    },
    TimeGranularity = "timeGranularity",
    Value = "value"
};

Synopsis

Properties

Column

The column that the filter is applied to.
DefaultFilterControlConfiguration

The default configurations for the associated controls.
FilterId

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

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

The rolling date input for the TimeEquality filter.
TimeGranularity

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

The value of a TimeEquality filter.

Properties

Column

The column that the filter is applied to.

object Column { get; }
Property Value

System.Object

Remarks

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

DefaultFilterControlConfiguration

The default configurations for the associated controls.

virtual object DefaultFilterControlConfiguration { get; }
Property Value

System.Object

Remarks

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

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

FilterId

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

string FilterId { get; }
Property Value

System.String

Remarks

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

ParameterName

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

virtual string ParameterName { get; }
Property Value

System.String

Remarks

This field is mutually exclusive to Value and RollingDate .

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

RollingDate

The rolling date input for the TimeEquality filter.

virtual object RollingDate { get; }
Property Value

System.Object

Remarks

This field is mutually exclusive to Value and ParameterName .

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

TimeGranularity

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

virtual string TimeGranularity { get; }
Property Value

System.String

Remarks

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

Value

The value of a TimeEquality filter.

virtual string Value { get; }
Property Value

System.String

Remarks

This field is mutually exclusive to RollingDate and ParameterName .

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