Class: AWSCDK::QuickSight::CfnDashboard::FilterDateTimePickerControlProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

A control from a date filter that is used to specify date and time.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filter_control_id:, source_filter_id:, title:, commit_mode: nil, display_options: nil, type: nil) ⇒ FilterDateTimePickerControlProperty

Returns a new instance of FilterDateTimePickerControlProperty.

Parameters:

  • filter_control_id (String)

    The ID of the FilterDateTimePickerControl .

  • source_filter_id (String)

    The source filter ID of the FilterDateTimePickerControl .

  • title (String)

    The title of the FilterDateTimePickerControl .

  • commit_mode (String, nil) (defaults to: nil)

    The visibility configurationof the Apply button on a DateTimePickerControl .

  • display_options (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::DateTimePickerControlDisplayOptionsProperty, nil) (defaults to: nil)

    The display options of a control.

  • type (String, nil) (defaults to: nil)

    The type of the FilterDropDownControl . Choose one of the following options:.



10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
# File 'quick_sight/cfn_dashboard.rb', line 10648

def initialize(filter_control_id:, source_filter_id:, title:, commit_mode: nil, display_options: nil, type: nil)
  @filter_control_id = filter_control_id
  Jsii::Type.check_type(@filter_control_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterControlId")
  @source_filter_id = source_filter_id
  Jsii::Type.check_type(@source_filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceFilterId")
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title")
  @commit_mode = commit_mode
  Jsii::Type.check_type(@commit_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commitMode") unless @commit_mode.nil?
  @display_options = display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DateTimePickerControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXRlVGltZVBpY2tlckNvbnRyb2xEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "displayOptions") unless @display_options.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#commit_modeString? (readonly)

The visibility configurationof the Apply button on a DateTimePickerControl .



10682
10683
10684
# File 'quick_sight/cfn_dashboard.rb', line 10682

def commit_mode
  @commit_mode
end

#display_optionsAWSCDK::IResolvable, ... (readonly)

The display options of a control.



10687
10688
10689
# File 'quick_sight/cfn_dashboard.rb', line 10687

def display_options
  @display_options
end

#filter_control_idString (readonly)

The ID of the FilterDateTimePickerControl .



10667
10668
10669
# File 'quick_sight/cfn_dashboard.rb', line 10667

def filter_control_id
  @filter_control_id
end

#source_filter_idString (readonly)

The source filter ID of the FilterDateTimePickerControl .



10672
10673
10674
# File 'quick_sight/cfn_dashboard.rb', line 10672

def source_filter_id
  @source_filter_id
end

#titleString (readonly)

The title of the FilterDateTimePickerControl .



10677
10678
10679
# File 'quick_sight/cfn_dashboard.rb', line 10677

def title
  @title
end

#typeString? (readonly)

The type of the FilterDropDownControl . Choose one of the following options:.

  • MULTI_SELECT : The user can select multiple entries from a dropdown menu.
  • SINGLE_SELECT : The user can select a single entry from a dropdown menu.


10695
10696
10697
# File 'quick_sight/cfn_dashboard.rb', line 10695

def type
  @type
end

Class Method Details

.jsii_propertiesObject



10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
# File 'quick_sight/cfn_dashboard.rb', line 10697

def self.jsii_properties
  {
    :filter_control_id => "filterControlId",
    :source_filter_id => "sourceFilterId",
    :title => "title",
    :commit_mode => "commitMode",
    :display_options => "displayOptions",
    :type => "type",
  }
end

Instance Method Details

#to_jsiiObject



10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
# File 'quick_sight/cfn_dashboard.rb', line 10708

def to_jsii
  result = {}
  result.merge!({
    "filterControlId" => @filter_control_id,
    "sourceFilterId" => @source_filter_id,
    "title" => @title,
    "commitMode" => @commit_mode,
    "displayOptions" => @display_options,
    "type" => @type,
  })
  result.compact
end