Package software.amazon.awscdk.services.cloudwatch

Class AlarmMuteRule.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.AlarmMuteRule.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AlarmMuteRule>
Enclosing class:
AlarmMuteRule
@Stability(Stable) public static final class AlarmMuteRule.Builder extends Object implements software.amazon.jsii.Builder<AlarmMuteRule>
A fluent builder for AlarmMuteRule.

  • Method Details

    • create

      @Stability(Stable) public static AlarmMuteRule.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of AlarmMuteRule.Builder.

    • duration

      @Stability(Stable) public AlarmMuteRule.Builder duration(Duration duration)
      The length of time that alarms remain muted when the schedule activates.

      Minimum: 1 minute, Maximum: 15 days

      Parameters:
      duration - The length of time that alarms remain muted when the schedule activates. This parameter is required.
      Returns:
      this

    • schedule

      @Stability(Stable) public AlarmMuteRule.Builder schedule(ScheduleExpression schedule)
      The schedule defines when alarms should be muted.

      Parameters:
      schedule - The schedule defines when alarms should be muted. This parameter is required.
      Returns:
      this

    • alarmMuteRuleName

      @Stability(Stable) public AlarmMuteRule.Builder alarmMuteRuleName(String alarmMuteRuleName)
      The name of the alarm mute rule.

      This name must be unique within your AWS account and region.

      Default: - generated by CloudFormation

      Parameters:
      alarmMuteRuleName - The name of the alarm mute rule. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public AlarmMuteRule.Builder description(String description)
      A description of the alarm mute rule that helps you identify its purpose.

      Default: - no description

      Parameters:
      description - A description of the alarm mute rule that helps you identify its purpose. This parameter is required.
      Returns:
      this

    • expire

      @Stability(Stable) public AlarmMuteRule.Builder expire(CalendarDateTime 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.

      Default: - no configuration

      Parameters:
      expire - The date and time when the mute rule expires and is no longer evaluated. This parameter is required.
      Returns:
      this

    • start

      @Stability(Stable) public AlarmMuteRule.Builder start(CalendarDateTime 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.

      Default: - no configuration

      Parameters:
      start - The date and time after which the mute rule takes effect. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public AlarmMuteRule.Builder tags(Map<String,String> tags)
      A list of tags associated with the alarm mute rule.

      Tags help you organize and categorize your AWS resources.

      Default: - No tags are applied

      Parameters:
      tags - A list of tags associated with the alarm mute rule. This parameter is required.
      Returns:
      this

    • alarms

      @Stability(Stable) public AlarmMuteRule.Builder alarms(List<? extends IAlarmRef> alarms)
      The list of alarms that this mute rule targets.

      You can specify up to 100 alarms.

      Default: - no target alarms

      Parameters:
      alarms - The list of alarms that this mute rule targets. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public AlarmMuteRule build()
      Specified by:
      build in interface software.amazon.jsii.Builder<AlarmMuteRule>
      Returns:
      a newly built instance of AlarmMuteRule.