Class: AWSCDK::CloudWatch::SearchExpressionOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_watch/search_expression_options.rb

Overview

Configurable options for SearchExpressions.

Direct Known Subclasses

SearchExpressionProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(color: nil, label: nil, period: nil, search_account: nil, search_region: nil) ⇒ SearchExpressionOptions

Returns a new instance of SearchExpressionOptions.

Parameters:

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

    Color for the metric produced by the search expression.

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

    Label for this search expression when added to a Graph in a Dashboard.

  • period (AWSCDK::Duration, nil) (defaults to: nil) —

    The period over which the search expression's statistics are applied.

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

    Account to evaluate search expressions within.

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

    Region to evaluate search expressions within.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'cloud_watch/search_expression_options.rb', line 12

def initialize(color: nil, label: nil, period: nil, search_account: nil, search_region: nil)
  @color = color
  Jsii::Type.check_type(@color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "color") unless @color.nil?
  @label = label
  Jsii::Type.check_type(@label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "label") unless @label.nil?
  @period = period
  Jsii::Type.check_type(@period, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "period") unless @period.nil?
  @search_account = 
  Jsii::Type.check_type(@search_account, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "searchAccount") unless @search_account.nil?
  @search_region = search_region
  Jsii::Type.check_type(@search_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "searchRegion") unless @search_region.nil?
end

Instance Attribute Details

#color ⇒ String? (readonly)

Note:

Default: - Automatically assigned.

Color for the metric produced by the search expression.

If the search expression produces more than one time series, the color is assigned to the first one. Other metrics are assigned colors automatically.

Returns:

  • (String, nil) 


32
33
34
 
# File 'cloud_watch/search_expression_options.rb', line 32

def color
  @color
end

#label ⇒ String? (readonly)

Note:

Default: - No label.

Label for this search expression when added to a Graph in a Dashboard.

If this expression evaluates to more than one time series, each time series will appear in the graph using a combination of the expression label and the individual metric label. Specify the empty string ('') to suppress the expression label and only keep the metric label.

You can use dynamic labels to show summary information about the displayed time series in the legend. For example, if you use:

[max: ${MAX}] MyMetric

As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. If the search expression produces more than one time series, the maximum will be shown for each individual time series produce by this search expression.

Returns:

  • (String, nil) 


57
58
59
 
# File 'cloud_watch/search_expression_options.rb', line 57

def label
  @label
end

#period ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Duration.minutes(5)

The period over which the search expression's statistics are applied.

This period overrides the period defined within the search expression.

Returns:



64
65
66
 
# File 'cloud_watch/search_expression_options.rb', line 64

def period
  @period
end

#search_account ⇒ String? (readonly)

Note:

Default: - Deployment account.

Account to evaluate search expressions within.

Returns:

  • (String, nil) 


69
70
71
 
# File 'cloud_watch/search_expression_options.rb', line 69

def 
  @search_account
end

#search_region ⇒ String? (readonly)

Note:

Default: - Deployment region.

Region to evaluate search expressions within.

Returns:

  • (String, nil) 


74
75
76
 
# File 'cloud_watch/search_expression_options.rb', line 74

def search_region
  @search_region
end

Class Method Details

.jsii_properties ⇒ Object 



76
77
78
79
80
81
82
83
84
 
# File 'cloud_watch/search_expression_options.rb', line 76

def self.jsii_properties
  {
    :color => "color",
    :label => "label",
    :period => "period",
    :search_account => "searchAccount",
    :search_region => "searchRegion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
 
# File 'cloud_watch/search_expression_options.rb', line 86

def to_jsii
  result = {}
  result.merge!({
    "color" => @color,
    "label" => @label,
    "period" => @period,
    "searchAccount" => @search_account,
    "searchRegion" => @search_region,
  })
  result.compact
end