Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.CategoryFilterConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.CategoryFilterConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.CategoryFilterConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for a CategoryFilter .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Example:

 // 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.*;
 CategoryFilterConfigurationProperty categoryFilterConfigurationProperty = CategoryFilterConfigurationProperty.builder()
         .customFilterConfiguration(CustomFilterConfigurationProperty.builder()
                 .matchOperator("matchOperator")
                 .nullOption("nullOption")
                 // the properties below are optional
                 .categoryValue("categoryValue")
                 .parameterName("parameterName")
                 .selectAllOptions("selectAllOptions")
                 .build())
         .customFilterListConfiguration(CustomFilterListConfigurationProperty.builder()
                 .matchOperator("matchOperator")
                 .nullOption("nullOption")
                 // the properties below are optional
                 .categoryValues(List.of("categoryValues"))
                 .selectAllOptions("selectAllOptions")
                 .build())
         .filterListConfiguration(FilterListConfigurationProperty.builder()
                 .matchOperator("matchOperator")
                 // the properties below are optional
                 .categoryValues(List.of("categoryValues"))
                 .nullOption("nullOption")
                 .selectAllOptions("selectAllOptions")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.CategoryFilterConfigurationProperty.Builder	A builder for CfnTemplate.CategoryFilterConfigurationProperty
static final class	CfnTemplate.CategoryFilterConfigurationProperty.Jsii$Proxy	An implementation for CfnTemplate.CategoryFilterConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.CategoryFilterConfigurationProperty.Builder	builder()
default Object	getCustomFilterConfiguration()	A custom filter that filters based on a single value.
default Object	getCustomFilterListConfiguration()	A list of custom filter values.
default Object	getFilterListConfiguration()	A list of filter configurations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomFilterConfiguration

@Stability(Stable)
@Nullable
default Object getCustomFilterConfiguration()

A custom filter that filters based on a single value.

This filter can be partially matched.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-customfilterconfiguration

getCustomFilterListConfiguration

@Stability(Stable)
@Nullable
default Object getCustomFilterListConfiguration()

A list of custom filter values.

In the Amazon QuickSight console, this filter type is called a custom filter list.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-customfilterlistconfiguration

getFilterListConfiguration

@Stability(Stable)
@Nullable
default Object getFilterListConfiguration()

A list of filter configurations.

In the Amazon QuickSight console, this filter type is called a filter list.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-filterlistconfiguration

builder

@Stability(Stable)
static CfnTemplate.CategoryFilterConfigurationProperty.Builder builder()

Returns:

a CfnTemplate.CategoryFilterConfigurationProperty.Builder of CfnTemplate.CategoryFilterConfigurationProperty