Class: AWSCDK::QuickSight::CfnAnalysis::ExcludePeriodConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnAnalysis::ExcludePeriodConfigurationProperty

Defined in:

quick_sight/cfn_analysis.rb

Overview

The exclude period of TimeRangeFilter or RelativeDatesFilter .

See Also:

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

Instance Attribute Summary

• #amount ⇒ Numeric readonly

  The amount or number of the exclude period.

• #granularity ⇒ String readonly

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

• #status ⇒ String^? readonly

  The status of the exclude period.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

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

  A new instance of ExcludePeriodConfigurationProperty.

• #to_jsii ⇒ Object

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:.

# File 'quick_sight/cfn_analysis.rb', line 8887

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-amount

# File 'quick_sight/cfn_analysis.rb', line 8900

def amount
  @amount
end

#granularity ⇒ String (readonly)

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

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-granularity

# File 'quick_sight/cfn_analysis.rb', line 8905

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-status

# File 'quick_sight/cfn_analysis.rb', line 8913

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 8915

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

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 8923

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