Class CfnTopic.TopicFilterProperty

A structure that represents a filter used to select items for a topic.

Inheritance

System.Object

CfnTopic.TopicFilterProperty

Implements

CfnTopic.ITopicFilterProperty

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.AWS.QuickSight.dll

Syntax (csharp)

public class TopicFilterProperty : Object, CfnTopic.ITopicFilterProperty

Syntax (vb)

Public Class TopicFilterProperty
    Inherits Object
    Implements CfnTopic.ITopicFilterProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.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 topicFilterProperty = new TopicFilterProperty {
    FilterName = "filterName",
    OperandFieldName = "operandFieldName",

    // the properties below are optional
    CategoryFilter = new TopicCategoryFilterProperty {
        CategoryFilterFunction = "categoryFilterFunction",
        CategoryFilterType = "categoryFilterType",
        Constant = new TopicCategoryFilterConstantProperty {
            CollectiveConstant = new CollectiveConstantProperty {
                ValueList = new [] { "valueList" }
            },
            ConstantType = "constantType",
            SingularConstant = "singularConstant"
        },
        Inverse = false
    },
    DateRangeFilter = new TopicDateRangeFilterProperty {
        Constant = new TopicRangeFilterConstantProperty {
            ConstantType = "constantType",
            RangeConstant = new RangeConstantProperty {
                Maximum = "maximum",
                Minimum = "minimum"
            }
        },
        Inclusive = false
    },
    FilterClass = "filterClass",
    FilterDescription = "filterDescription",
    FilterSynonyms = new [] { "filterSynonyms" },
    FilterType = "filterType",
    NumericEqualityFilter = new TopicNumericEqualityFilterProperty {
        Aggregation = "aggregation",
        Constant = new TopicSingularFilterConstantProperty {
            ConstantType = "constantType",
            SingularConstant = "singularConstant"
        }
    },
    NumericRangeFilter = new TopicNumericRangeFilterProperty {
        Aggregation = "aggregation",
        Constant = new TopicRangeFilterConstantProperty {
            ConstantType = "constantType",
            RangeConstant = new RangeConstantProperty {
                Maximum = "maximum",
                Minimum = "minimum"
            }
        },
        Inclusive = false
    },
    RelativeDateFilter = new TopicRelativeDateFilterProperty {
        Constant = new TopicSingularFilterConstantProperty {
            ConstantType = "constantType",
            SingularConstant = "singularConstant"
        },
        RelativeDateFilterFunction = "relativeDateFilterFunction",
        TimeGranularity = "timeGranularity"
    }
};

Synopsis

Constructors

TopicFilterProperty()

Properties

CategoryFilter	The category filter that is associated with this filter.
DateRangeFilter	The date range filter.
FilterClass	The class of the filter.
FilterDescription	A description of the filter used to select items for a topic.
FilterName	The name of the filter.
FilterSynonyms	The other names or aliases for the filter.
FilterType	The type of the filter.
NumericEqualityFilter	The numeric equality filter.
NumericRangeFilter	The numeric range filter.
OperandFieldName	The name of the field that the filter operates on.
RelativeDateFilter	The relative date filter.

Constructors

TopicFilterProperty()

public TopicFilterProperty()

Properties

CategoryFilter

The category filter that is associated with this filter.

public object CategoryFilter { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-categoryfilter

DateRangeFilter

The date range filter.

public object DateRangeFilter { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-daterangefilter

FilterClass

The class of the filter.

public string FilterClass { get; set; }

Property Value

System.String

Remarks

Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterclass

FilterDescription

A description of the filter used to select items for a topic.

public string FilterDescription { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterdescription

FilterName

The name of the filter.

public string FilterName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtername

FilterSynonyms

The other names or aliases for the filter.

public string[] FilterSynonyms { get; set; }

Property Value

System.String[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtersynonyms

FilterType

The type of the filter.

public string FilterType { get; set; }

Property Value

System.String

Remarks

Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtertype

NumericEqualityFilter

The numeric equality filter.

public object NumericEqualityFilter { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericequalityfilter

NumericRangeFilter

The numeric range filter.

public object NumericRangeFilter { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericrangefilter

OperandFieldName

The name of the field that the filter operates on.

public string OperandFieldName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-operandfieldname

RelativeDateFilter

The relative date filter.

public object RelativeDateFilter { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-relativedatefilter

Implements

CfnTopic.ITopicFilterProperty