Class: AWSCDK::AppConfig::Monitor

Inherits:
Jsii::Object
  • Object
show all
Defined in:
app_config/monitor.rb

Overview

Defines monitors that will be associated with an AWS AppConfig environment.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Monitor

Returns a new instance of Monitor.



8
9
10
 
# File 'app_config/monitor.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.from_cfn_monitors_property(monitors_property) ⇒ AWSCDK::AppConfig::Monitor

Creates a Monitor from a CfnEnvironment.MonitorsProperty construct.

Parameters:

Returns:

  • (AWSCDK::AppConfig::Monitor) 


25
26
27
28
29
 
# File 'app_config/monitor.rb', line 25

def self.from_cfn_monitors_property(monitors_property)
  monitors_property = monitors_property.is_a?(Hash) ? ::AWSCDK::AppConfig::CfnEnvironment::MonitorsProperty.new(**monitors_property.transform_keys(&:to_sym)) : monitors_property
  Jsii::Type.check_type(monitors_property, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNmbkVudmlyb25tZW50Lk1vbml0b3JzUHJvcGVydHkifQ==")), "monitorsProperty")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Monitor", "fromCfnMonitorsProperty", [monitors_property])
end

.from_cloud_watch_alarm(alarm, alarm_role = nil) ⇒ AWSCDK::AppConfig::Monitor

Creates a Monitor from a CloudWatch alarm.

If the alarm role is not specified, a role will be generated.

Parameters:

Returns:

  • (AWSCDK::AppConfig::Monitor) 


39
40
41
42
43
 
# File 'app_config/monitor.rb', line 39

def self.from_cloud_watch_alarm(alarm, alarm_role = nil)
  Jsii::Type.check_type(alarm, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZHdhdGNoLklBbGFybVJlZiJ9")), "alarm")
  Jsii::Type.check_type(alarm_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifQ==")), "alarmRole") unless alarm_role.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Monitor", "fromCloudWatchAlarm", [alarm, alarm_role])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
19
 
# File 'app_config/monitor.rb', line 12

def self.jsii_overridable_methods
  {
    :alarm_arn => { kind: :property, name: "alarmArn", is_optional: false },
    :monitor_type => { kind: :property, name: "monitorType", is_optional: false },
    :alarm_role_arn => { kind: :property, name: "alarmRoleArn", is_optional: true },
    :is_composite_alarm => { kind: :property, name: "isCompositeAlarm", is_optional: true },
  }
end

Instance Method Details

#alarm_arn ⇒ String

The alarm ARN for AWS AppConfig to monitor.

Returns:

  • (String) 


48
49
50
 
# File 'app_config/monitor.rb', line 48

def alarm_arn()
  jsii_get_property("alarmArn")
end

#alarm_role_arn ⇒ String?

The IAM role ARN for AWS AppConfig to view the alarm state.

Returns:

  • (String, nil) 


62
63
64
 
# File 'app_config/monitor.rb', line 62

def alarm_role_arn()
  jsii_get_property("alarmRoleArn")
end

#is_composite_alarm ⇒ Boolean?

Indicates whether a CloudWatch alarm is a composite alarm.

Returns:

  • (Boolean, nil) 


69
70
71
 
# File 'app_config/monitor.rb', line 69

def is_composite_alarm()
  jsii_get_property("isCompositeAlarm")
end

#monitor_type ⇒ AWSCDK::AppConfig::MonitorType

The type of monitor.

Returns:



55
56
57
 
# File 'app_config/monitor.rb', line 55

def monitor_type()
  jsii_get_property("monitorType")
end