Class: AWSCDK::StepFunctions::TaskMetricsConfig

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions/task_metrics_config.rb

Overview

Task Metrics.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metric_dimensions: nil, metric_prefix_plural: nil, metric_prefix_singular: nil) ⇒ TaskMetricsConfig

Returns a new instance of TaskMetricsConfig.

Parameters:

  • metric_dimensions (Hash{String => Object}, nil) (defaults to: nil) —

    The dimensions to attach to metrics.

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

    Prefix for plural metric names of activity actions.

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

    Prefix for singular metric names of activity actions.



10
11
12
13
14
15
16
17
 
# File 'step_functions/task_metrics_config.rb', line 10

def initialize(metric_dimensions: nil, metric_prefix_plural: nil, metric_prefix_singular: nil)
  @metric_dimensions = metric_dimensions
  Jsii::Type.check_type(@metric_dimensions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "metricDimensions") unless @metric_dimensions.nil?
  @metric_prefix_plural = metric_prefix_plural
  Jsii::Type.check_type(@metric_prefix_plural, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricPrefixPlural") unless @metric_prefix_plural.nil?
  @metric_prefix_singular = metric_prefix_singular
  Jsii::Type.check_type(@metric_prefix_singular, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricPrefixSingular") unless @metric_prefix_singular.nil?
end

Instance Attribute Details

#metric_dimensions ⇒ Hash{String => Object}? (readonly)

Note:

Default: - No metrics

The dimensions to attach to metrics.

Returns:

  • (Hash{String => Object}, nil) 


23
24
25
 
# File 'step_functions/task_metrics_config.rb', line 23

def metric_dimensions
  @metric_dimensions
end

#metric_prefix_plural ⇒ String? (readonly)

Note:

Default: - No such metrics

Prefix for plural metric names of activity actions.

Returns:

  • (String, nil) 


28
29
30
 
# File 'step_functions/task_metrics_config.rb', line 28

def metric_prefix_plural
  @metric_prefix_plural
end

#metric_prefix_singular ⇒ String? (readonly)

Note:

Default: - No such metrics

Prefix for singular metric names of activity actions.

Returns:

  • (String, nil) 


33
34
35
 
# File 'step_functions/task_metrics_config.rb', line 33

def metric_prefix_singular
  @metric_prefix_singular
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'step_functions/task_metrics_config.rb', line 35

def self.jsii_properties
  {
    :metric_dimensions => "metricDimensions",
    :metric_prefix_plural => "metricPrefixPlural",
    :metric_prefix_singular => "metricPrefixSingular",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'step_functions/task_metrics_config.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "metricDimensions" => @metric_dimensions,
    "metricPrefixPlural" => @metric_prefix_plural,
    "metricPrefixSingular" => @metric_prefix_singular,
  })
  result.compact
end