Class: AWSCDK::QuickSight::CfnTopic::TopicCategoryFilterProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTopic::TopicCategoryFilterProperty

Defined in:

quick_sight/cfn_topic.rb

Overview

A structure that represents a category filter.

See Also:

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

Instance Attribute Summary

• #category_filter_function ⇒ String^? readonly

  The category filter function.

• #category_filter_type ⇒ String^? readonly

  The category filter type.

• #constant ⇒ AWSCDK::IResolvable, ... readonly

  The constant used in a category filter.

• #inverse ⇒ Boolean, ... readonly

  A Boolean value that indicates if the filter is inverse.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(category_filter_function: nil, category_filter_type: nil, constant: nil, inverse: nil) ⇒ TopicCategoryFilterProperty constructor

  A new instance of TopicCategoryFilterProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(category_filter_function: nil, category_filter_type: nil, constant: nil, inverse: nil) ⇒ TopicCategoryFilterProperty

Returns a new instance of TopicCategoryFilterProperty.

Parameters:

• category_filter_function (String, nil) (defaults to: nil) —

  The category filter function.

• category_filter_type (String, nil) (defaults to: nil) —

  The category filter type.

• constant (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::TopicCategoryFilterConstantProperty, nil) (defaults to: nil) —

  The constant used in a category filter.

• inverse (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  A Boolean value that indicates if the filter is inverse.

# File 'quick_sight/cfn_topic.rb', line 1751

def initialize(category_filter_function: nil, category_filter_type: nil, constant: nil, inverse: nil)
  @category_filter_function = category_filter_function
  Jsii::Type.check_type(@category_filter_function, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "categoryFilterFunction") unless @category_filter_function.nil?
  @category_filter_type = category_filter_type
  Jsii::Type.check_type(@category_filter_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "categoryFilterType") unless @category_filter_type.nil?
  @constant = constant.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicCategoryFilterConstantProperty.new(**constant.transform_keys(&:to_sym)) : constant
  Jsii::Type.check_type(@constant, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljQ2F0ZWdvcnlGaWx0ZXJDb25zdGFudFByb3BlcnR5In1dfX0=")), "constant") unless @constant.nil?
  @inverse = inverse
  Jsii::Type.check_type(@inverse, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "inverse") unless @inverse.nil?
end

Instance Attribute Details

#category_filter_function ⇒ String^? (readonly)

The category filter function.

Valid values for this structure are EXACT and CONTAINS .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfilterfunction

# File 'quick_sight/cfn_topic.rb', line 1768

def category_filter_function
  @category_filter_function
end

#category_filter_type ⇒ String^? (readonly)

The category filter type.

This element is used to specify whether a filter is a simple category filter or an inverse category filter.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfiltertype

# File 'quick_sight/cfn_topic.rb', line 1775

def category_filter_type
  @category_filter_type
end

#constant ⇒ AWSCDK::IResolvable, ... (readonly)

The constant used in a category filter.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::TopicCategoryFilterConstantProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-constant

# File 'quick_sight/cfn_topic.rb', line 1780

def constant
  @constant
end

#inverse ⇒ Boolean, ... (readonly)

Note:

Default: - false

A Boolean value that indicates if the filter is inverse.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-inverse

# File 'quick_sight/cfn_topic.rb', line 1786

def inverse
  @inverse
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 1788

def self.jsii_properties
  {
    :category_filter_function => "categoryFilterFunction",
    :category_filter_type => "categoryFilterType",
    :constant => "constant",
    :inverse => "inverse",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 1797

def to_jsii
  result = {}
  result.merge!({
    "categoryFilterFunction" => @category_filter_function,
    "categoryFilterType" => @category_filter_type,
    "constant" => @constant,
    "inverse" => @inverse,
  })
  result.compact
end