software.amazon.awscdk.services.cloudwatch

Class CompositeAlarm.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CompositeAlarm.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CompositeAlarm>

Enclosing class:

CompositeAlarm

@Stability(value=Stable)
public static final class CompositeAlarm.Builder
extends Object
implements software.amazon.jsii.Builder<CompositeAlarm>

A fluent builder for CompositeAlarm.

Method Summary

Modifier and Type	Method and Description
CompositeAlarm.Builder	actionsEnabled(Boolean actionsEnabled) Whether the actions for this alarm are enabled.
CompositeAlarm.Builder	alarmDescription(String alarmDescription) Description for the alarm.
CompositeAlarm.Builder	alarmRule(IAlarmRule alarmRule) Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
CompositeAlarm	build()
CompositeAlarm.Builder	compositeAlarmName(String compositeAlarmName) Name of the alarm.
static CompositeAlarm.Builder	create(software.constructs.Construct scope, String id)

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CompositeAlarm.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CompositeAlarm.Builder.

alarmRule

@Stability(value=Stable)
public CompositeAlarm.Builder alarmRule(IAlarmRule alarmRule)

Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.

Parameters:

alarmRule - Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. This parameter is required.

Returns:

this

actionsEnabled

@Stability(value=Stable)
public CompositeAlarm.Builder actionsEnabled(Boolean actionsEnabled)

Whether the actions for this alarm are enabled.

Default: true

Parameters:

actionsEnabled - Whether the actions for this alarm are enabled. This parameter is required.

Returns:

this

alarmDescription

@Stability(value=Stable)
public CompositeAlarm.Builder alarmDescription(String alarmDescription)

Description for the alarm.

Default: No description

Parameters:

alarmDescription - Description for the alarm. This parameter is required.

Returns:

this

compositeAlarmName

@Stability(value=Stable)
public CompositeAlarm.Builder compositeAlarmName(String compositeAlarmName)

Name of the alarm.

Default: Automatically generated name

Parameters:

compositeAlarmName - Name of the alarm. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CompositeAlarm build()

Specified by:

build in interface software.amazon.jsii.Builder<CompositeAlarm>