Class: AWSCDK::QuickSight::CfnDashboard::PeriodToDateComputationProperty

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

Overview

The period to date computation configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(computation_id:, name: nil, period_time_granularity: nil, time: nil, value: nil) ⇒ PeriodToDateComputationProperty

Returns a new instance of PeriodToDateComputationProperty.

Parameters:



22046
22047
22048
22049
22050
22051
22052
22053
22054
22055
22056
22057
 
# File 'quick_sight/cfn_dashboard.rb', line 22046

def initialize(computation_id:, name: nil, period_time_granularity: nil, time: nil, value: nil)
  @computation_id = computation_id
  Jsii::Type.check_type(@computation_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "computationId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @period_time_granularity = period_time_granularity
  Jsii::Type.check_type(@period_time_granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "periodTimeGranularity") unless @period_time_granularity.nil?
  @time = time.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DimensionFieldProperty.new(**time.transform_keys(&:to_sym)) : time
  Jsii::Type.check_type(@time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EaW1lbnNpb25GaWVsZFByb3BlcnR5In1dfX0=")), "time") unless @time.nil?
  @value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::MeasureFieldProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5NZWFzdXJlRmllbGRQcm9wZXJ0eSJ9XX19")), "value") unless @value.nil?
end

Instance Attribute Details

#computation_id ⇒ String (readonly)

The ID for a computation.

Returns:

  • (String)

See Also:



22063
22064
22065
 
# File 'quick_sight/cfn_dashboard.rb', line 22063

def computation_id
  @computation_id
end

#name ⇒ String? (readonly)

The name of a computation.

Returns:

  • (String, nil)

See Also:



22068
22069
22070
 
# File 'quick_sight/cfn_dashboard.rb', line 22068

def name
  @name
end

#period_time_granularity ⇒ String? (readonly)

The time granularity setup of period to date computation. Choose from the following options:.

  • YEAR: Year to date.
  • MONTH: Month to date.

Returns:

  • (String, nil)

See Also:



22076
22077
22078
 
# File 'quick_sight/cfn_dashboard.rb', line 22076

def period_time_granularity
  @period_time_granularity
end

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

The time field that is used in a computation.

Returns:

See Also:



22081
22082
22083
 
# File 'quick_sight/cfn_dashboard.rb', line 22081

def time
  @time
end

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

The value field that is used in a computation.

Returns:

See Also:



22086
22087
22088
 
# File 'quick_sight/cfn_dashboard.rb', line 22086

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



22088
22089
22090
22091
22092
22093
22094
22095
22096
 
# File 'quick_sight/cfn_dashboard.rb', line 22088

def self.jsii_properties
  {
    :computation_id => "computationId",
    :name => "name",
    :period_time_granularity => "periodTimeGranularity",
    :time => "time",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



22098
22099
22100
22101
22102
22103
22104
22105
22106
22107
22108
 
# File 'quick_sight/cfn_dashboard.rb', line 22098

def to_jsii
  result = {}
  result.merge!({
    "computationId" => @computation_id,
    "name" => @name,
    "periodTimeGranularity" => @period_time_granularity,
    "time" => @time,
    "value" => @value,
  })
  result.compact
end