Interface CompositeAlarm.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CompositeAlarm.Builder,
,CompositeAlarm> SdkBuilder<CompositeAlarm.Builder,
,CompositeAlarm> SdkPojo
- Enclosing class:
CompositeAlarm
-
Method Summary
Modifier and TypeMethodDescriptionactionsEnabled
(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm state.actionsSuppressedBy
(String actionsSuppressedBy) When the value isALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state.actionsSuppressedBy
(ActionsSuppressedBy actionsSuppressedBy) When the value isALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state.actionsSuppressedReason
(String actionsSuppressedReason) Captures the reason for action suppression.actionsSuppressor
(String actionsSuppressor) Actions will be suppressed if the suppressor alarm is in theALARM
state.actionsSuppressorExtensionPeriod
(Integer actionsSuppressorExtensionPeriod) The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of theALARM
state.actionsSuppressorWaitPeriod
(Integer actionsSuppressorWaitPeriod) The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into theALARM
state.alarmActions
(String... alarmActions) The actions to execute when this alarm transitions to the ALARM state from any other state.alarmActions
(Collection<String> alarmActions) The actions to execute when this alarm transitions to the ALARM state from any other state.The Amazon Resource Name (ARN) of the alarm.alarmConfigurationUpdatedTimestamp
(Instant alarmConfigurationUpdatedTimestamp) The time stamp of the last update to the alarm configuration.alarmDescription
(String alarmDescription) The description of the alarm.The name of the alarm.The rule that this alarm uses to evaluate its alarm state.insufficientDataActions
(String... insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.insufficientDataActions
(Collection<String> insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.The actions to execute when this alarm transitions to the OK state from any other state.okActions
(Collection<String> okActions) The actions to execute when this alarm transitions to the OK state from any other state.stateReason
(String stateReason) An explanation for the alarm state, in text format.stateReasonData
(String stateReasonData) An explanation for the alarm state, in JSON format.stateTransitionedTimestamp
(Instant stateTransitionedTimestamp) The timestamp of the last change to the alarm'sStateValue
.stateUpdatedTimestamp
(Instant stateUpdatedTimestamp) Tracks the timestamp of any state update, even ifStateValue
doesn't change.stateValue
(String stateValue) The state value for the alarm.stateValue
(StateValue stateValue) The state value for the alarm.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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
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
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
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
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
Tracks the timestamp of any state update, even if
StateValue
doesn't change.- Parameters:
stateUpdatedTimestamp
- Tracks the timestamp of any state update, even ifStateValue
doesn't change.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
stateTransitionedTimestamp
The timestamp of the last change to the alarm's
StateValue
.- Parameters:
stateTransitionedTimestamp
- The timestamp of the last change to the alarm'sStateValue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionsSuppressedBy
When the value is
ALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. After this time, the composite alarm performs its actions.- Parameters:
actionsSuppressedBy
- When the value isALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. 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
When the value is
ALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. After this time, the composite alarm performs its actions.- Parameters:
actionsSuppressedBy
- When the value isALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. 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:
-
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
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 theALARM
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
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 whenActionsSuppressor
is specified.- Parameters:
actionsSuppressorWaitPeriod
- The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into theALARM
state. After this time, the composite alarm performs its actions.WaitPeriod
is required only whenActionsSuppressor
is specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 whenActionsSuppressor
is specified.- Parameters:
actionsSuppressorExtensionPeriod
- The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of theALARM
state. After this time, the composite alarm performs its actions.ExtensionPeriod
is required only whenActionsSuppressor
is specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-