TopicFilterProperty Struct
A structure that represents a filter used to select items for a topic.
| Source | |
|---|---|
| Type last changed |
Example
ts
// 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 topicFilterProperty: quicksight.CfnTopic.TopicFilterProperty = {
filterName: 'filterName',
operandFieldName: 'operandFieldName',
// the properties below are optional
categoryFilter: {
categoryFilterFunction: 'categoryFilterFunction',
categoryFilterType: 'categoryFilterType',
constant: {
collectiveConstant: {
valueList: ['valueList'],
},
constantType: 'constantType',
singularConstant: 'singularConstant',
},
inverse: false,
},
dateRangeFilter: {
constant: {
constantType: 'constantType',
rangeConstant: {
maximum: 'maximum',
minimum: 'minimum',
},
},
inclusive: false,
},
filterClass: 'filterClass',
filterDescription: 'filterDescription',
filterSynonyms: ['filterSynonyms'],
filterType: 'filterType',
numericEqualityFilter: {
aggregation: 'aggregation',
constant: {
constantType: 'constantType',
singularConstant: 'singularConstant',
},
},
numericRangeFilter: {
aggregation: 'aggregation',
constant: {
constantType: 'constantType',
rangeConstant: {
maximum: 'maximum',
minimum: 'minimum',
},
},
inclusive: false,
},
relativeDateFilter: {
constant: {
constantType: 'constantType',
singularConstant: 'singularConstant',
},
relativeDateFilterFunction: 'relativeDateFilterFunction',
timeGranularity: 'timeGranularity',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight
topic_filter_property = quicksight.CfnTopic.TopicFilterProperty(
filter_name="filterName",
operand_field_name="operandFieldName",
# the properties below are optional
category_filter=quicksight.CfnTopic.TopicCategoryFilterProperty(
category_filter_function="categoryFilterFunction",
category_filter_type="categoryFilterType",
constant=quicksight.CfnTopic.TopicCategoryFilterConstantProperty(
collective_constant=quicksight.CfnTopic.CollectiveConstantProperty(
value_list=["valueList"]
),
constant_type="constantType",
singular_constant="singularConstant"
),
inverse=False
),
date_range_filter=quicksight.CfnTopic.TopicDateRangeFilterProperty(
constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
constant_type="constantType",
range_constant=quicksight.CfnTopic.RangeConstantProperty(
maximum="maximum",
minimum="minimum"
)
),
inclusive=False
),
filter_class="filterClass",
filter_description="filterDescription",
filter_synonyms=["filterSynonyms"],
filter_type="filterType",
numeric_equality_filter=quicksight.CfnTopic.TopicNumericEqualityFilterProperty(
aggregation="aggregation",
constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
constant_type="constantType",
singular_constant="singularConstant"
)
),
numeric_range_filter=quicksight.CfnTopic.TopicNumericRangeFilterProperty(
aggregation="aggregation",
constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty(
constant_type="constantType",
range_constant=quicksight.CfnTopic.RangeConstantProperty(
maximum="maximum",
minimum="minimum"
)
),
inclusive=False
),
relative_date_filter=quicksight.CfnTopic.TopicRelativeDateFilterProperty(
constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty(
constant_type="constantType",
singular_constant="singularConstant"
),
relative_date_filter_function="relativeDateFilterFunction",
time_granularity="timeGranularity"
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;
TopicFilterProperty topicFilterProperty = TopicFilterProperty.builder()
.filterName("filterName")
.operandFieldName("operandFieldName")
// the properties below are optional
.categoryFilter(TopicCategoryFilterProperty.builder()
.categoryFilterFunction("categoryFilterFunction")
.categoryFilterType("categoryFilterType")
.constant(TopicCategoryFilterConstantProperty.builder()
.collectiveConstant(CollectiveConstantProperty.builder()
.valueList(List.of("valueList"))
.build())
.constantType("constantType")
.singularConstant("singularConstant")
.build())
.inverse(false)
.build())
.dateRangeFilter(TopicDateRangeFilterProperty.builder()
.constant(TopicRangeFilterConstantProperty.builder()
.constantType("constantType")
.rangeConstant(RangeConstantProperty.builder()
.maximum("maximum")
.minimum("minimum")
.build())
.build())
.inclusive(false)
.build())
.filterClass("filterClass")
.filterDescription("filterDescription")
.filterSynonyms(List.of("filterSynonyms"))
.filterType("filterType")
.numericEqualityFilter(TopicNumericEqualityFilterProperty.builder()
.aggregation("aggregation")
.constant(TopicSingularFilterConstantProperty.builder()
.constantType("constantType")
.singularConstant("singularConstant")
.build())
.build())
.numericRangeFilter(TopicNumericRangeFilterProperty.builder()
.aggregation("aggregation")
.constant(TopicRangeFilterConstantProperty.builder()
.constantType("constantType")
.rangeConstant(RangeConstantProperty.builder()
.maximum("maximum")
.minimum("minimum")
.build())
.build())
.inclusive(false)
.build())
.relativeDateFilter(TopicRelativeDateFilterProperty.builder()
.constant(TopicSingularFilterConstantProperty.builder()
.constantType("constantType")
.singularConstant("singularConstant")
.build())
.relativeDateFilterFunction("relativeDateFilterFunction")
.timeGranularity("timeGranularity")
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
topicFilterProperty := &TopicFilterProperty{
FilterName: jsii.String("filterName"),
OperandFieldName: jsii.String("operandFieldName"),
// the properties below are optional
CategoryFilter: &TopicCategoryFilterProperty{
CategoryFilterFunction: jsii.String("categoryFilterFunction"),
CategoryFilterType: jsii.String("categoryFilterType"),
Constant: &TopicCategoryFilterConstantProperty{
CollectiveConstant: &CollectiveConstantProperty{
ValueList: []*string{
jsii.String("valueList"),
},
},
ConstantType: jsii.String("constantType"),
SingularConstant: jsii.String("singularConstant"),
},
Inverse: jsii.Boolean(false),
},
DateRangeFilter: &TopicDateRangeFilterProperty{
Constant: &TopicRangeFilterConstantProperty{
ConstantType: jsii.String("constantType"),
RangeConstant: &RangeConstantProperty{
Maximum: jsii.String("maximum"),
Minimum: jsii.String("minimum"),
},
},
Inclusive: jsii.Boolean(false),
},
FilterClass: jsii.String("filterClass"),
FilterDescription: jsii.String("filterDescription"),
FilterSynonyms: []*string{
jsii.String("filterSynonyms"),
},
FilterType: jsii.String("filterType"),
NumericEqualityFilter: &TopicNumericEqualityFilterProperty{
Aggregation: jsii.String("aggregation"),
Constant: &TopicSingularFilterConstantProperty{
ConstantType: jsii.String("constantType"),
SingularConstant: jsii.String("singularConstant"),
},
},
NumericRangeFilter: &TopicNumericRangeFilterProperty{
Aggregation: jsii.String("aggregation"),
Constant: &TopicRangeFilterConstantProperty{
ConstantType: jsii.String("constantType"),
RangeConstant: &RangeConstantProperty{
Maximum: jsii.String("maximum"),
Minimum: jsii.String("minimum"),
},
},
Inclusive: jsii.Boolean(false),
},
RelativeDateFilter: &TopicRelativeDateFilterProperty{
Constant: &TopicSingularFilterConstantProperty{
ConstantType: jsii.String("constantType"),
SingularConstant: jsii.String("singularConstant"),
},
RelativeDateFilterFunction: jsii.String("relativeDateFilterFunction"),
TimeGranularity: jsii.String("timeGranularity"),
},
}
Properties
categoryFilteroptionalIResolvable | CfnTopic.category_filteroptionaltyping.Union[IResolvable, TopicCategoryFilterProperty]categoryFilteroptionalIResolvableCategoryFilteroptionalIResolvableCategoryFilteroptionalinterface{} #The category filter that is associated with this filter.
dateRangeFilteroptionalIResolvable | CfnTopic.date_range_filteroptionaltyping.Union[IResolvable, TopicDateRangeFilterProperty]dateRangeFilteroptionalIResolvableDateRangeFilteroptionalIResolvableDateRangeFilteroptionalinterface{} #The date range filter.
filterClassoptionalstringfilter_classoptionalstrfilterClassoptionalStringFilterClassoptionalstringFilterClassoptional*string #The class of the filter.
Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .
filterDescriptionoptionalstringfilter_descriptionoptionalstrfilterDescriptionoptionalStringFilterDescriptionoptionalstringFilterDescriptionoptional*string #A description of the filter used to select items for a topic.
The name of the filter.
filterSynonymsoptionalstring[]filter_synonymsoptionaltyping.List[str]filterSynonymsoptionalList<String>FilterSynonymsoptionalstring[]FilterSynonymsoptional*[]*string #The other names or aliases for the filter.
filterTypeoptionalstringfilter_typeoptionalstrfilterTypeoptionalStringFilterTypeoptionalstringFilterTypeoptional*string #The type of the filter.
Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .
numericEqualityFilteroptionalIResolvable | CfnTopic.numeric_equality_filteroptionaltyping.Union[IResolvable, TopicNumericEqualityFilterProperty]numericEqualityFilteroptionalIResolvableNumericEqualityFilteroptionalIResolvableNumericEqualityFilteroptionalinterface{} #The numeric equality filter.
numericRangeFilteroptionalIResolvable | CfnTopic.numeric_range_filteroptionaltyping.Union[IResolvable, TopicNumericRangeFilterProperty]numericRangeFilteroptionalIResolvableNumericRangeFilteroptionalIResolvableNumericRangeFilteroptionalinterface{} #The numeric range filter.
operandFieldNamestringoperand_field_namestroperandFieldNameStringOperandFieldNamestringOperandFieldName*string required #The name of the field that the filter operates on.
relativeDateFilteroptionalIResolvable | CfnTopic.relative_date_filteroptionaltyping.Union[IResolvable, TopicRelativeDateFilterProperty]relativeDateFilteroptionalIResolvableRelativeDateFilteroptionalIResolvableRelativeDateFilteroptionalinterface{} #The relative date filter.