class Monitor

Language	Type name
.NET	`Amazon.CDK.AWS.AppConfig.Monitor`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#Monitor`
Java	`software.amazon.awscdk.services.appconfig.Monitor`
Python	`aws_cdk.aws_appconfig.Monitor`
TypeScript (source)	`aws-cdk-lib` » `aws_appconfig` » `Monitor`

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

Example

declare const application: appconfig.Application;
declare const alarm: cloudwatch.Alarm;
declare const compositeAlarm: cloudwatch.CompositeAlarm;

new appconfig.Environment(this, 'MyEnvironment', {
  application,
  monitors: [
    appconfig.Monitor.fromCloudWatchAlarm(alarm),
    appconfig.Monitor.fromCloudWatchAlarm(compositeAlarm),
  ],
});

Initializer

new Monitor()

Properties

Name	Type	Description
alarmArn	`string`	The alarm ARN for AWS AppConfig to monitor.
monitorType	`MonitorType`	The type of monitor.
alarmRoleArn?	`string`	The IAM role ARN for AWS AppConfig to view the alarm state.
isCompositeAlarm?	`boolean`	Indicates whether a CloudWatch alarm is a composite alarm.

alarmArn

Type: string

The alarm ARN for AWS AppConfig to monitor.

monitorType

Type: MonitorType

The type of monitor.

alarmRoleArn?

Type: string (optional)

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

isCompositeAlarm?

Type: boolean (optional)

Indicates whether a CloudWatch alarm is a composite alarm.

Methods

Name	Description
static fromCfnMonitorsProperty(monitorsProperty)	Creates a Monitor from a CfnEnvironment.MonitorsProperty construct.
static fromCloudWatchAlarm(alarm, alarmRole?)	Creates a Monitor from a CloudWatch alarm.

static fromCfnMonitorsProperty(monitorsProperty)

public static fromCfnMonitorsProperty(monitorsProperty: MonitorsProperty): Monitor

Parameters

monitorsProperty MonitorsProperty — The monitors property.

Returns

Monitor

Creates a Monitor from a CfnEnvironment.MonitorsProperty construct.

static fromCloudWatchAlarm(alarm, alarmRole?)

public static fromCloudWatchAlarm(alarm: IAlarm, alarmRole?: IRoleRef): Monitor