public static interface CompositeAlarm.Builder extends SdkPojo, CopyableBuilder<CompositeAlarm.Builder,CompositeAlarm>
Modifier and Type | Method and Description |
---|---|
CompositeAlarm.Builder |
actionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
|
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. |
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. |
CompositeAlarm.Builder |
actionsSuppressedReason(String actionsSuppressedReason)
Captures the reason for action suppression.
|
CompositeAlarm.Builder |
actionsSuppressor(String actionsSuppressor)
Actions will be suppressed if the suppressor alarm is in the
ALARM state. |
CompositeAlarm.Builder |
actionsSuppressorExtensionPeriod(Integer actionsSuppressorExtensionPeriod)
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the
ALARM state. |
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. |
CompositeAlarm.Builder |
alarmActions(Collection<String> alarmActions)
The actions to execute when this alarm transitions to the ALARM state from any other state.
|
CompositeAlarm.Builder |
alarmActions(String... alarmActions)
The actions to execute when this alarm transitions to the ALARM state from any other state.
|
CompositeAlarm.Builder |
alarmArn(String alarmArn)
The Amazon Resource Name (ARN) of the alarm.
|
CompositeAlarm.Builder |
alarmConfigurationUpdatedTimestamp(Instant alarmConfigurationUpdatedTimestamp)
The time stamp of the last update to the alarm configuration.
|
CompositeAlarm.Builder |
alarmDescription(String alarmDescription)
The description of the alarm.
|
CompositeAlarm.Builder |
alarmName(String alarmName)
The name of the alarm.
|
CompositeAlarm.Builder |
alarmRule(String alarmRule)
The rule that this alarm uses to evaluate its alarm state.
|
CompositeAlarm.Builder |
insufficientDataActions(Collection<String> insufficientDataActions)
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
|
CompositeAlarm.Builder |
insufficientDataActions(String... insufficientDataActions)
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
|
CompositeAlarm.Builder |
okActions(Collection<String> okActions)
The actions to execute when this alarm transitions to the OK state from any other state.
|
CompositeAlarm.Builder |
okActions(String... okActions)
The actions to execute when this alarm transitions to the OK state from any other state.
|
CompositeAlarm.Builder |
stateReason(String stateReason)
An explanation for the alarm state, in text format.
|
CompositeAlarm.Builder |
stateReasonData(String stateReasonData)
An explanation for the alarm state, in JSON format.
|
CompositeAlarm.Builder |
stateTransitionedTimestamp(Instant stateTransitionedTimestamp)
The timestamp of the last change to the alarm's
StateValue . |
CompositeAlarm.Builder |
stateUpdatedTimestamp(Instant stateUpdatedTimestamp)
Tracks the timestamp of any state update, even if
StateValue doesn't change. |
CompositeAlarm.Builder |
stateValue(StateValue stateValue)
The state value for the alarm.
|
CompositeAlarm.Builder |
stateValue(String stateValue)
The state value for the alarm.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
CompositeAlarm.Builder actionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm state.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).
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).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).
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).CompositeAlarm.Builder alarmArn(String alarmArn)
The Amazon Resource Name (ARN) of the alarm.
alarmArn
- The Amazon Resource Name (ARN) of the alarm.CompositeAlarm.Builder alarmConfigurationUpdatedTimestamp(Instant alarmConfigurationUpdatedTimestamp)
The time stamp of the last update to the alarm configuration.
alarmConfigurationUpdatedTimestamp
- The time stamp of the last update to the alarm configuration.CompositeAlarm.Builder alarmDescription(String alarmDescription)
The description of the alarm.
alarmDescription
- The description of the alarm.CompositeAlarm.Builder alarmName(String alarmName)
The name of the alarm.
alarmName
- The name of the alarm.CompositeAlarm.Builder alarmRule(String alarmRule)
The rule that this alarm uses to evaluate its alarm state.
alarmRule
- The rule that this alarm uses to evaluate its alarm state.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).
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).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).
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).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).
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).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).
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).CompositeAlarm.Builder stateReason(String stateReason)
An explanation for the alarm state, in text format.
stateReason
- An explanation for the alarm state, in text format.CompositeAlarm.Builder stateReasonData(String stateReasonData)
An explanation for the alarm state, in JSON format.
stateReasonData
- An explanation for the alarm state, in JSON format.CompositeAlarm.Builder stateUpdatedTimestamp(Instant stateUpdatedTimestamp)
Tracks the timestamp of any state update, even if StateValue
doesn't change.
stateUpdatedTimestamp
- Tracks the timestamp of any state update, even if StateValue
doesn't change.CompositeAlarm.Builder stateValue(String stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
,
StateValue
CompositeAlarm.Builder stateValue(StateValue stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
,
StateValue
CompositeAlarm.Builder stateTransitionedTimestamp(Instant stateTransitionedTimestamp)
The timestamp of the last change to the alarm's StateValue
.
stateTransitionedTimestamp
- The timestamp of the last change to the alarm's StateValue
.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.
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.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.
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.ActionsSuppressedBy
,
ActionsSuppressedBy
CompositeAlarm.Builder actionsSuppressedReason(String actionsSuppressedReason)
Captures the reason for action suppression.
actionsSuppressedReason
- Captures the reason for action suppression.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.
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.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.
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.
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.
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.
Copyright © 2023. All rights reserved.