Class: AWSCDK::QuickSight::CfnDashboard::ExcludePeriodConfigurationProperty

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

Overview

The exclude period of TimeRangeFilter or RelativeDatesFilter .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(amount:, granularity:, status: nil) ⇒ ExcludePeriodConfigurationProperty

Returns a new instance of ExcludePeriodConfigurationProperty.

Parameters:

  • amount (Numeric) —

    The amount or number of the exclude period.

  • granularity (String) —

    The granularity or unit (day, month, year) of the exclude period.

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

    The status of the exclude period. Choose from the following options:.



9508
9509
9510
9511
9512
9513
9514
9515
 
# File 'quick_sight/cfn_dashboard.rb', line 9508

def initialize(amount:, granularity:, status: nil)
  @amount = amount
  Jsii::Type.check_type(@amount, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "amount")
  @granularity = granularity
  Jsii::Type.check_type(@granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "granularity")
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#amount ⇒ Numeric (readonly)

The amount or number of the exclude period.

Returns:

  • (Numeric)

See Also:



9521
9522
9523
 
# File 'quick_sight/cfn_dashboard.rb', line 9521

def amount
  @amount
end

#granularity ⇒ String (readonly)

The granularity or unit (day, month, year) of the exclude period.

Returns:

  • (String)

See Also:



9526
9527
9528
 
# File 'quick_sight/cfn_dashboard.rb', line 9526

def granularity
  @granularity
end

#status ⇒ String? (readonly)

The status of the exclude period. Choose from the following options:.

  • ENABLED
  • DISABLED

Returns:

  • (String, nil)

See Also:



9534
9535
9536
 
# File 'quick_sight/cfn_dashboard.rb', line 9534

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



9536
9537
9538
9539
9540
9541
9542
 
# File 'quick_sight/cfn_dashboard.rb', line 9536

def self.jsii_properties
  {
    :amount => "amount",
    :granularity => "granularity",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



9544
9545
9546
9547
9548
9549
9550
9551
9552
 
# File 'quick_sight/cfn_dashboard.rb', line 9544

def to_jsii
  result = {}
  result.merge!({
    "amount" => @amount,
    "granularity" => @granularity,
    "status" => @status,
  })
  result.compact
end