Class: AWSCDK::CloudWatch::ConcreteWidget

Inherits:
Jsii::Object
  • Object
show all
Includes:
IWidget
Defined in:
cloud_watch/concrete_widget.rb

Overview

A real CloudWatch widget that has its own fixed size and remembers its position.

This is in contrast to other widgets which exist for layout purposes.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(width, height) ⇒ ConcreteWidget

Returns a new instance of ConcreteWidget.

Parameters:

  • width (Numeric) —

    The amount of horizontal grid units the widget will take up.

  • height (Numeric) —

    The amount of vertical grid units the widget will take up.



13
14
15
16
17
 
# File 'cloud_watch/concrete_widget.rb', line 13

def initialize(width, height)
  Jsii::Type.check_type(width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "width")
  Jsii::Type.check_type(height, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "height")
  Jsii::Object.instance_method(:initialize).bind(self).call(width, height)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'cloud_watch/concrete_widget.rb', line 19

def self.jsii_overridable_methods
  {
    :height => { kind: :property, name: "height", is_optional: false },
    :width => { kind: :property, name: "width", is_optional: false },
    :warnings => { kind: :property, name: "warnings", is_optional: true },
    :warnings_v2 => { kind: :property, name: "warningsV2", is_optional: true },
    :x => { kind: :property, name: "x", is_optional: true },
    :y => { kind: :property, name: "y", is_optional: true },
    :copy_metric_warnings => { kind: :method, name: "copyMetricWarnings", is_optional: false },
    :position => { kind: :method, name: "position", is_optional: false },
    :to_json => { kind: :method, name: "toJson", is_optional: false },
  }
end

Instance Method Details

#copy_metric_warnings(*ms) ⇒ void

This method returns an undefined value.

Copy the warnings from the given metric.

Parameters:



85
86
87
88
89
90
 
# File 'cloud_watch/concrete_widget.rb', line 85

def copy_metric_warnings(*ms)
  ms.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5JTWV0cmljIn0=")), "ms[#{index}]")
  end
  jsii_call_method("copyMetricWarnings", [*ms])
end

#height ⇒ Numeric

The amount of vertical grid units the widget will take up.

Returns:

  • (Numeric) 


36
37
38
 
# File 'cloud_watch/concrete_widget.rb', line 36

def height()
  jsii_get_property("height")
end

#position(x, y) ⇒ void

This method returns an undefined value.

Place the widget at a given position.

Parameters:

  • x (Numeric)
  • y (Numeric) 


97
98
99
100
101
 
# File 'cloud_watch/concrete_widget.rb', line 97

def position(x, y)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "x")
  Jsii::Type.check_type(y, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "y")
  jsii_call_method("position", [x, y])
end

#to_json ⇒ Array<Object>

Return the widget JSON for use in the dashboard.

Returns:

  • (Array<Object>) 


106
107
108
 
# File 'cloud_watch/concrete_widget.rb', line 106

def to_json()
  jsii_call_method("toJson", [])
end

#warnings ⇒ Array<String>?

Any warnings that are produced as a result of putting together this widget.

Returns:

  • (Array<String>, nil) 


50
51
52
 
# File 'cloud_watch/concrete_widget.rb', line 50

def warnings()
  jsii_get_property("warnings")
end

#warnings_v2 ⇒ Hash{String => String}?

Any warnings that are produced as a result of putting together this widget.

Returns:

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


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

def warnings_v2()
  jsii_get_property("warningsV2")
end

#width ⇒ Numeric

The amount of horizontal grid units the widget will take up.

Returns:

  • (Numeric) 


43
44
45
 
# File 'cloud_watch/concrete_widget.rb', line 43

def width()
  jsii_get_property("width")
end

#x ⇒ Numeric?

Returns:

  • (Numeric, nil) 


62
63
64
 
# File 'cloud_watch/concrete_widget.rb', line 62

def x()
  jsii_get_property("x")
end

#x=(value) ⇒ Object 



66
67
68
69
 
# File 'cloud_watch/concrete_widget.rb', line 66

def x=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "x") unless value.nil?
  jsii_set_property("x", value)
end

#y ⇒ Numeric?

Returns:

  • (Numeric, nil) 


72
73
74
 
# File 'cloud_watch/concrete_widget.rb', line 72

def y()
  jsii_get_property("y")
end

#y=(value) ⇒ Object 



76
77
78
79
 
# File 'cloud_watch/concrete_widget.rb', line 76

def y=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "y") unless value.nil?
  jsii_set_property("y", value)
end