Package software.amazon.awssdk.services.cloudwatch.model

Interface CompositeAlarm.Builder

    • Method Detail

      • actionsEnabled

        CompositeAlarm.Builder actionsEnabled​(Boolean actionsEnabled)

        Indicates whether actions should be executed during any changes to the alarm state.

        Parameters:
        actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmActions

        CompositeAlarm.Builder alarmActions​(Collection<String> alarmActions)

        The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        Parameters:
        alarmActions - The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmActions

        CompositeAlarm.Builder alarmActions​(String... alarmActions)

        The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        Parameters:
        alarmActions - The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmArn

        CompositeAlarm.Builder alarmArn​(String alarmArn)

        The Amazon Resource Name (ARN) of the alarm.

        Parameters:
        alarmArn - The Amazon Resource Name (ARN) of the alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmConfigurationUpdatedTimestamp

        CompositeAlarm.Builder alarmConfigurationUpdatedTimestamp​(Instant alarmConfigurationUpdatedTimestamp)

        The time stamp of the last update to the alarm configuration.

        Parameters:
        alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmDescription

        CompositeAlarm.Builder alarmDescription​(String alarmDescription)

        The description of the alarm.

        Parameters:
        alarmDescription - The description of the alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmName

        CompositeAlarm.Builder alarmName​(String alarmName)

        The name of the alarm.

        Parameters:
        alarmName - The name of the alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmRule

        CompositeAlarm.Builder alarmRule​(String alarmRule)

        The rule that this alarm uses to evaluate its alarm state.

        Parameters:
        alarmRule - The rule that this alarm uses to evaluate its alarm state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • insufficientDataActions

        CompositeAlarm.Builder insufficientDataActions​(Collection<String> insufficientDataActions)

        The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        Parameters:
        insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • insufficientDataActions

        CompositeAlarm.Builder insufficientDataActions​(String... insufficientDataActions)

        The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        Parameters:
        insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • okActions

        CompositeAlarm.Builder okActions​(Collection<String> okActions)

        The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        Parameters:
        okActions - The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • okActions

        CompositeAlarm.Builder okActions​(String... okActions)

        The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        Parameters:
        okActions - The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stateReason

        CompositeAlarm.Builder stateReason​(String stateReason)

        An explanation for the alarm state, in text format.

        Parameters:
        stateReason - An explanation for the alarm state, in text format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stateReasonData

        CompositeAlarm.Builder stateReasonData​(String stateReasonData)

        An explanation for the alarm state, in JSON format.

        Parameters:
        stateReasonData - An explanation for the alarm state, in JSON format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stateUpdatedTimestamp

        CompositeAlarm.Builder stateUpdatedTimestamp​(Instant stateUpdatedTimestamp)

        Tracks the timestamp of any state update, even if StateValue doesn't change.

        Parameters:
        stateUpdatedTimestamp - Tracks the timestamp of any state update, even if StateValue doesn't change.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stateValue

        CompositeAlarm.Builder stateValue​(String stateValue)

        The state value for the alarm.

        Parameters:
        stateValue - The state value for the alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StateValue, StateValue

      • stateValue

        CompositeAlarm.Builder stateValue​(StateValue stateValue)

        The state value for the alarm.

        Parameters:
        stateValue - The state value for the alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StateValue, StateValue

      • stateTransitionedTimestamp

        CompositeAlarm.Builder stateTransitionedTimestamp​(Instant stateTransitionedTimestamp)

        The timestamp of the last change to the alarm's StateValue.

        Parameters:
        stateTransitionedTimestamp - The timestamp of the last change to the alarm's StateValue.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionsSuppressedBy

        CompositeAlarm.Builder actionsSuppressedBy​(String actionsSuppressedBy)

        When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.

        Parameters:
        actionsSuppressedBy - When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionsSuppressedBy, ActionsSuppressedBy

      • actionsSuppressedBy

        CompositeAlarm.Builder actionsSuppressedBy​(ActionsSuppressedBy actionsSuppressedBy)

        When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.

        Parameters:
        actionsSuppressedBy - When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionsSuppressedBy, ActionsSuppressedBy

      • actionsSuppressedReason

        CompositeAlarm.Builder actionsSuppressedReason​(String actionsSuppressedReason)

        Captures the reason for action suppression.

        Parameters:
        actionsSuppressedReason - Captures the reason for action suppression.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionsSuppressor

        CompositeAlarm.Builder actionsSuppressor​(String actionsSuppressor)

        Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

        Parameters:
        actionsSuppressor - Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionsSuppressorWaitPeriod

        CompositeAlarm.Builder actionsSuppressorWaitPeriod​(Integer actionsSuppressorWaitPeriod)

        The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions.

        WaitPeriod is required only when ActionsSuppressor is specified.

        Parameters:
        actionsSuppressorWaitPeriod - The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions.

        WaitPeriod is required only when ActionsSuppressor is specified.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionsSuppressorExtensionPeriod

        CompositeAlarm.Builder actionsSuppressorExtensionPeriod​(Integer actionsSuppressorExtensionPeriod)

        The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions.

        ExtensionPeriod is required only when ActionsSuppressor is specified.

        Parameters:
        actionsSuppressorExtensionPeriod - The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions.

        ExtensionPeriod is required only when ActionsSuppressor is specified.

        Returns:
        Returns a reference to this object so that method calls can be chained together.