Class CfnTemplatePropsMixin.RelativeDatesFilterProperty

A RelativeDatesFilter filters relative dates values.

Inheritance

object

CfnTemplatePropsMixin.RelativeDatesFilterProperty

Implements

CfnTemplatePropsMixin.IRelativeDatesFilterProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QuickSight

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnTemplatePropsMixin.RelativeDatesFilterProperty : CfnTemplatePropsMixin.IRelativeDatesFilterProperty

Syntax (vb)

Public Class CfnTemplatePropsMixin.RelativeDatesFilterProperty Implements CfnTemplatePropsMixin.IRelativeDatesFilterProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.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.CfnPropertyMixins.AWS.QuickSight;

             var relativeDatesFilterProperty = new RelativeDatesFilterProperty {
                 AnchorDateConfiguration = new AnchorDateConfigurationProperty {
                     AnchorOption = "anchorOption",
                     ParameterName = "parameterName"
                 },
                 Column = new ColumnIdentifierProperty {
                     ColumnName = "columnName",
                     DataSetIdentifier = "dataSetIdentifier"
                 },
                 DefaultFilterControlConfiguration = new DefaultFilterControlConfigurationProperty {
                     ControlOptions = new DefaultFilterControlOptionsProperty {
                         DefaultDateTimePickerOptions = new DefaultDateTimePickerControlOptionsProperty {
                             CommitMode = "commitMode",
                             DisplayOptions = new DateTimePickerControlDisplayOptionsProperty {
                                 DateIconVisibility = "dateIconVisibility",
                                 DateTimeFormat = "dateTimeFormat",
                                 HelperTextVisibility = "helperTextVisibility",
                                 InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                                     InfoIconText = "infoIconText",
                                     Visibility = "visibility"
                                 },
                                 TitleOptions = new LabelOptionsProperty {
                                     CustomLabel = "customLabel",
                                     FontConfiguration = new FontConfigurationProperty {
                                         FontColor = "fontColor",
                                         FontDecoration = "fontDecoration",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             Relative = "relative"
                                         },
                                         FontStyle = "fontStyle",
                                         FontWeight = new FontWeightProperty {
                                             Name = "name"
                                         }
                                     },
                                     Visibility = "visibility"
                                 }
                             }
                         },
                         DefaultSliderOptions = new DefaultSliderControlOptionsProperty {
                             DisplayOptions = new SliderControlDisplayOptionsProperty {
                                 InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                                     InfoIconText = "infoIconText",
                                     Visibility = "visibility"
                                 },
                                 TitleOptions = new LabelOptionsProperty {
                                     CustomLabel = "customLabel",
                                     FontConfiguration = new FontConfigurationProperty {
                                         FontColor = "fontColor",
                                         FontDecoration = "fontDecoration",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             Relative = "relative"
                                         },
                                         FontStyle = "fontStyle",
                                         FontWeight = new FontWeightProperty {
                                             Name = "name"
                                         }
                                     },
                                     Visibility = "visibility"
                                 }
                             },
                             MaximumValue = 123,
                             MinimumValue = 123,
                             StepSize = 123,
                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             Relative = "relative"
                                         },
                                         FontStyle = "fontStyle",
                                         FontWeight = new FontWeightProperty {
                                             Name = "name"
                                         }
                                     },
                                     Visibility = "visibility"
                                 }
                             }
                         }
                     },
                     Title = "title"
                 },
                 ExcludePeriodConfiguration = new ExcludePeriodConfigurationProperty {
                     Amount = 123,
                     Granularity = "granularity",
                     Status = "status"
                 },
                 FilterId = "filterId",
                 MinimumGranularity = "minimumGranularity",
                 NullOption = "nullOption",
                 ParameterName = "parameterName",
                 RelativeDateType = "relativeDateType",
                 RelativeDateValue = 123,
                 TimeGranularity = "timeGranularity"
             };

Synopsis

Constructors

RelativeDatesFilterProperty()

A RelativeDatesFilter filters relative dates values.

Properties

AnchorDateConfiguration	The date configuration of the filter.
Column	The column that the filter is applied to.
DefaultFilterControlConfiguration	The default configurations for the associated controls.
ExcludePeriodConfiguration	The configuration for the exclude period of the filter.
FilterId	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
MinimumGranularity	The minimum granularity (period granularity) of the relative dates filter.
NullOption	This option determines how null values should be treated when filtering data.
ParameterName	The parameter whose value should be used for the filter value.
RelativeDateType	The range date type of the filter. Choose one of the options below:.
RelativeDateValue	The date value of the filter.
TimeGranularity	The level of time precision that is used to aggregate `DateTime` values.

Constructors

RelativeDatesFilterProperty()

A RelativeDatesFilter filters relative dates values.

public RelativeDatesFilterProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.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.CfnPropertyMixins.AWS.QuickSight;

             var relativeDatesFilterProperty = new RelativeDatesFilterProperty {
                 AnchorDateConfiguration = new AnchorDateConfigurationProperty {
                     AnchorOption = "anchorOption",
                     ParameterName = "parameterName"
                 },
                 Column = new ColumnIdentifierProperty {
                     ColumnName = "columnName",
                     DataSetIdentifier = "dataSetIdentifier"
                 },
                 DefaultFilterControlConfiguration = new DefaultFilterControlConfigurationProperty {
                     ControlOptions = new DefaultFilterControlOptionsProperty {
                         DefaultDateTimePickerOptions = new DefaultDateTimePickerControlOptionsProperty {
                             CommitMode = "commitMode",
                             DisplayOptions = new DateTimePickerControlDisplayOptionsProperty {
                                 DateIconVisibility = "dateIconVisibility",
                                 DateTimeFormat = "dateTimeFormat",
                                 HelperTextVisibility = "helperTextVisibility",
                                 InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                                     InfoIconText = "infoIconText",
                                     Visibility = "visibility"
                                 },
                                 TitleOptions = new LabelOptionsProperty {
                                     CustomLabel = "customLabel",
                                     FontConfiguration = new FontConfigurationProperty {
                                         FontColor = "fontColor",
                                         FontDecoration = "fontDecoration",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             Relative = "relative"
                                         },
                                         FontStyle = "fontStyle",
                                         FontWeight = new FontWeightProperty {
                                             Name = "name"
                                         }
                                     },
                                     Visibility = "visibility"
                                 }
                             }
                         },
                         DefaultSliderOptions = new DefaultSliderControlOptionsProperty {
                             DisplayOptions = new SliderControlDisplayOptionsProperty {
                                 InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                                     InfoIconText = "infoIconText",
                                     Visibility = "visibility"
                                 },
                                 TitleOptions = new LabelOptionsProperty {
                                     CustomLabel = "customLabel",
                                     FontConfiguration = new FontConfigurationProperty {
                                         FontColor = "fontColor",
                                         FontDecoration = "fontDecoration",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             Relative = "relative"
                                         },
                                         FontStyle = "fontStyle",
                                         FontWeight = new FontWeightProperty {
                                             Name = "name"
                                         }
                                     },
                                     Visibility = "visibility"
                                 }
                             },
                             MaximumValue = 123,
                             MinimumValue = 123,
                             StepSize = 123,
                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             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",
                                         FontFamily = "fontFamily",
                                         FontSize = new FontSizeProperty {
                                             Absolute = "absolute",
                                             Relative = "relative"
                                         },
                                         FontStyle = "fontStyle",
                                         FontWeight = new FontWeightProperty {
                                             Name = "name"
                                         }
                                     },
                                     Visibility = "visibility"
                                 }
                             }
                         }
                     },
                     Title = "title"
                 },
                 ExcludePeriodConfiguration = new ExcludePeriodConfigurationProperty {
                     Amount = 123,
                     Granularity = "granularity",
                     Status = "status"
                 },
                 FilterId = "filterId",
                 MinimumGranularity = "minimumGranularity",
                 NullOption = "nullOption",
                 ParameterName = "parameterName",
                 RelativeDateType = "relativeDateType",
                 RelativeDateValue = 123,
                 TimeGranularity = "timeGranularity"
             };

Properties

AnchorDateConfiguration

The date configuration of the filter.

public object? AnchorDateConfiguration { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnTemplatePropsMixin.IAnchorDateConfigurationProperty

Column

The column that the filter is applied to.

public object? Column { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnTemplatePropsMixin.IColumnIdentifierProperty

DefaultFilterControlConfiguration

The default configurations for the associated controls.

public object? DefaultFilterControlConfiguration { get; set; }

Property Value

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-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-defaultfiltercontrolconfiguration

Type union: either IResolvable or CfnTemplatePropsMixin.IDefaultFilterControlConfigurationProperty

ExcludePeriodConfiguration

The configuration for the exclude period of the filter.

public object? ExcludePeriodConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnTemplatePropsMixin.IExcludePeriodConfigurationProperty

FilterId

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

public string? FilterId { get; set; }

Property Value

string

Remarks

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

MinimumGranularity

The minimum granularity (period granularity) of the relative dates filter.

public string? MinimumGranularity { get; set; }

Property Value

string

Remarks

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

NullOption

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

public string? NullOption { get; set; }

Property Value

string

Remarks

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

ParameterName

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

public string? ParameterName { get; set; }

Property Value

string

Remarks

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

RelativeDateType

The range date type of the filter. Choose one of the options below:.

public string? RelativeDateType { get; set; }

Property Value

string

Remarks

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

RelativeDateValue

The date value of the filter.

public double? RelativeDateValue { get; set; }

Property Value

double?

Remarks

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

TimeGranularity

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

public string? TimeGranularity { get; set; }