Package software.amazon.awscdk.services.cloudwatch

Class AlarmMuteRuleOptions.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.AlarmMuteRuleOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AlarmMuteRuleOptions>

Enclosing interface:

AlarmMuteRuleOptions

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

A builder for AlarmMuteRuleOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AlarmMuteRuleOptions.Builder	alarmMuteRuleName(String alarmMuteRuleName)	Sets the value of AlarmMuteRuleOptions.getAlarmMuteRuleName()
AlarmMuteRuleOptions	build()	Builds the configured instance.
AlarmMuteRuleOptions.Builder	description(String description)	Sets the value of AlarmMuteRuleOptions.getDescription()
AlarmMuteRuleOptions.Builder	duration(Duration duration)	Sets the value of AlarmMuteRuleOptions.getDuration()
AlarmMuteRuleOptions.Builder	expire(CalendarDateTime expire)	Sets the value of AlarmMuteRuleOptions.getExpire()
AlarmMuteRuleOptions.Builder	schedule(ScheduleExpression schedule)	Sets the value of AlarmMuteRuleOptions.getSchedule()
AlarmMuteRuleOptions.Builder	start(CalendarDateTime start)	Sets the value of AlarmMuteRuleOptions.getStart()
AlarmMuteRuleOptions.Builder	tags(Map<String,String> tags)	Sets the value of AlarmMuteRuleOptions.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

duration

@Stability(Stable)
public AlarmMuteRuleOptions.Builder duration(Duration duration)

Sets the value of AlarmMuteRuleOptions.getDuration()

Parameters:

duration - The length of time that alarms remain muted when the schedule activates. This parameter is required. Minimum: 1 minute, Maximum: 15 days

Returns:

this

schedule

@Stability(Stable)
public AlarmMuteRuleOptions.Builder schedule(ScheduleExpression schedule)

Sets the value of AlarmMuteRuleOptions.getSchedule()

Parameters:

schedule - The schedule defines when alarms should be muted. This parameter is required.

Returns:

this

alarmMuteRuleName

@Stability(Stable)
public AlarmMuteRuleOptions.Builder alarmMuteRuleName(String alarmMuteRuleName)

Sets the value of AlarmMuteRuleOptions.getAlarmMuteRuleName()

Parameters:

alarmMuteRuleName - The name of the alarm mute rule. This name must be unique within your AWS account and region.

Returns:

this

description

@Stability(Stable)
public AlarmMuteRuleOptions.Builder description(String description)

Sets the value of AlarmMuteRuleOptions.getDescription()

Parameters:

description - A description of the alarm mute rule that helps you identify its purpose.

Returns:

this

expire

@Stability(Stable)
public AlarmMuteRuleOptions.Builder expire(CalendarDateTime expire)

Sets the value of AlarmMuteRuleOptions.getExpire()

Parameters:

expire - The date and time when the mute rule expires and is no longer evaluated. After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.

This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.

Returns:

this

start

@Stability(Stable)
public AlarmMuteRuleOptions.Builder start(CalendarDateTime start)

Sets the value of AlarmMuteRuleOptions.getStart()

Parameters:

start - The date and time after which the mute rule takes effect. If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.

This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.

Returns:

this

tags

@Stability(Stable)
public AlarmMuteRuleOptions.Builder tags(Map<String,String> tags)

Sets the value of AlarmMuteRuleOptions.getTags()

Parameters:

tags - A list of tags associated with the alarm mute rule. Tags help you organize and categorize your AWS resources.

Returns:

this

build

@Stability(Stable)
public AlarmMuteRuleOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AlarmMuteRuleOptions

Throws:

NullPointerException - if any required attribute was not provided