Package software.amazon.awscdk.services.appconfig

Class Monitor

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.appconfig.Monitor
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-19T18:11:55.381Z") @Stability(Stable) public abstract class Monitor extends software.amazon.jsii.JsiiObject
Defines monitors that will be associated with an AWS AppConfig environment.

Example: 

 Application application;
 Alarm alarm;
 CompositeAlarm compositeAlarm;
 Environment.Builder.create(this, "MyEnvironment")
         .application(application)
         .monitors(List.of(Monitor.fromCloudWatchAlarm(alarm), Monitor.fromCloudWatchAlarm(compositeAlarm)))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Monitor()
     
    protected
    Monitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Monitor(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Monitor
    fromCfnMonitorsProperty(CfnEnvironment.MonitorsProperty monitorsProperty)
    Creates a Monitor from a CfnEnvironment.MonitorsProperty construct.
    static Monitor
    fromCloudWatchAlarm(IAlarm alarm)
    Creates a Monitor from a CloudWatch alarm.
    static Monitor
    fromCloudWatchAlarm(IAlarm alarm, IRole alarmRole)
    Creates a Monitor from a CloudWatch alarm.
    abstract String
    getAlarmArn()
    The alarm ARN for AWS AppConfig to monitor.
    abstract String
    getAlarmRoleArn()
    The IAM role ARN for AWS AppConfig to view the alarm state.
    abstract Boolean
    getIsCompositeAlarm()
    Indicates whether a CloudWatch alarm is a composite alarm.
    abstract MonitorType
    getMonitorType()
    The type of monitor.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Monitor

      protected Monitor(software.amazon.jsii.JsiiObjectRef objRef)

    • Monitor

      protected Monitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Monitor

      @Stability(Stable) protected Monitor()

  • Method Details

    • fromCfnMonitorsProperty

      @Stability(Stable) @NotNull public static Monitor fromCfnMonitorsProperty(@NotNull CfnEnvironment.MonitorsProperty monitorsProperty)
      Creates a Monitor from a CfnEnvironment.MonitorsProperty construct.

      Parameters:
      monitorsProperty - The monitors property. This parameter is required.

    • fromCloudWatchAlarm

      @Stability(Stable) @NotNull public static Monitor fromCloudWatchAlarm(@NotNull IAlarm alarm, @Nullable IRole alarmRole)
      Creates a Monitor from a CloudWatch alarm.

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

      Parameters:
      alarm - The Amazon CloudWatch alarm. This parameter is required.
      alarmRole - The IAM role for AWS AppConfig to view the alarm state.

    • fromCloudWatchAlarm

      @Stability(Stable) @NotNull public static Monitor fromCloudWatchAlarm(@NotNull IAlarm alarm)
      Creates a Monitor from a CloudWatch alarm.

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

      Parameters:
      alarm - The Amazon CloudWatch alarm. This parameter is required.

    • getAlarmArn

      @Stability(Stable) @NotNull public abstract String getAlarmArn()
      The alarm ARN for AWS AppConfig to monitor.

    • getMonitorType

      @Stability(Stable) @NotNull public abstract MonitorType getMonitorType()
      The type of monitor.

    • getAlarmRoleArn

      @Stability(Stable) @Nullable public abstract String getAlarmRoleArn()
      The IAM role ARN for AWS AppConfig to view the alarm state.

    • getIsCompositeAlarm

      @Stability(Stable) @Nullable public abstract Boolean getIsCompositeAlarm()
      Indicates whether a CloudWatch alarm is a composite alarm.