CompositeAlarm (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatch.model.CompositeAlarm

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CompositeAlarm
extends Object
implements Serializable, Cloneable

The details about a composite alarm.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CompositeAlarm()

Constructors
Constructor and Description
`CompositeAlarm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompositeAlarm`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getActionsEnabled()` Indicates whether actions should be executed during any changes to the alarm state.
`String`	`getActionsSuppressedBy()` 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.
`String`	`getActionsSuppressedReason()` Captures the reason for action suppression.
`String`	`getActionsSuppressor()` Actions will be suppressed if the suppressor alarm is in the `ALARM` state.
`Integer`	`getActionsSuppressorExtensionPeriod()` The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state.
`Integer`	`getActionsSuppressorWaitPeriod()` The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state.
`List<String>`	`getAlarmActions()` The actions to execute when this alarm transitions to the ALARM state from any other state.
`String`	`getAlarmArn()` The Amazon Resource Name (ARN) of the alarm.
`Date`	`getAlarmConfigurationUpdatedTimestamp()` The time stamp of the last update to the alarm configuration.
`String`	`getAlarmDescription()` The description of the alarm.
`String`	`getAlarmName()` The name of the alarm.
`String`	`getAlarmRule()` The rule that this alarm uses to evaluate its alarm state.
`List<String>`	`getInsufficientDataActions()` The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
`List<String>`	`getOKActions()` The actions to execute when this alarm transitions to the OK state from any other state.
`String`	`getStateReason()` An explanation for the alarm state, in text format.
`String`	`getStateReasonData()` An explanation for the alarm state, in JSON format.
`Date`	`getStateTransitionedTimestamp()` The timestamp of the last change to the alarm's `StateValue`.
`Date`	`getStateUpdatedTimestamp()` Tracks the timestamp of any state update, even if `StateValue` doesn't change.
`String`	`getStateValue()` The state value for the alarm.
`int`	`hashCode()`
`Boolean`	`isActionsEnabled()` Indicates whether actions should be executed during any changes to the alarm state.
`void`	`setActionsEnabled(Boolean actionsEnabled)` Indicates whether actions should be executed during any changes to the alarm state.
`void`	`setActionsSuppressedBy(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.
`void`	`setActionsSuppressedReason(String actionsSuppressedReason)` Captures the reason for action suppression.
`void`	`setActionsSuppressor(String actionsSuppressor)` Actions will be suppressed if the suppressor alarm is in the `ALARM` state.
`void`	`setActionsSuppressorExtensionPeriod(Integer actionsSuppressorExtensionPeriod)` The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state.
`void`	`setActionsSuppressorWaitPeriod(Integer actionsSuppressorWaitPeriod)` The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state.
`void`	`setAlarmActions(Collection<String> alarmActions)` The actions to execute when this alarm transitions to the ALARM state from any other state.
`void`	`setAlarmArn(String alarmArn)` The Amazon Resource Name (ARN) of the alarm.
`void`	`setAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)` The time stamp of the last update to the alarm configuration.
`void`	`setAlarmDescription(String alarmDescription)` The description of the alarm.
`void`	`setAlarmName(String alarmName)` The name of the alarm.
`void`	`setAlarmRule(String alarmRule)` The rule that this alarm uses to evaluate its alarm state.
`void`	`setInsufficientDataActions(Collection<String> insufficientDataActions)` The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
`void`	`setOKActions(Collection<String> oKActions)` The actions to execute when this alarm transitions to the OK state from any other state.
`void`	`setStateReason(String stateReason)` An explanation for the alarm state, in text format.
`void`	`setStateReasonData(String stateReasonData)` An explanation for the alarm state, in JSON format.
`void`	`setStateTransitionedTimestamp(Date stateTransitionedTimestamp)` The timestamp of the last change to the alarm's `StateValue`.
`void`	`setStateUpdatedTimestamp(Date stateUpdatedTimestamp)` Tracks the timestamp of any state update, even if `StateValue` doesn't change.
`void`	`setStateValue(String stateValue)` The state value for the alarm.
`String`	`toString()` Returns a string representation of this object.
`CompositeAlarm`	`withActionsEnabled(Boolean actionsEnabled)` Indicates whether actions should be executed during any changes to the alarm state.
`CompositeAlarm`	`withActionsSuppressedBy(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`	`withActionsSuppressedBy(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`	`withActionsSuppressedReason(String actionsSuppressedReason)` Captures the reason for action suppression.
`CompositeAlarm`	`withActionsSuppressor(String actionsSuppressor)` Actions will be suppressed if the suppressor alarm is in the `ALARM` state.
`CompositeAlarm`	`withActionsSuppressorExtensionPeriod(Integer actionsSuppressorExtensionPeriod)` The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state.
`CompositeAlarm`	`withActionsSuppressorWaitPeriod(Integer actionsSuppressorWaitPeriod)` The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state.
`CompositeAlarm`	`withAlarmActions(Collection<String> alarmActions)` The actions to execute when this alarm transitions to the ALARM state from any other state.
`CompositeAlarm`	`withAlarmActions(String... alarmActions)` The actions to execute when this alarm transitions to the ALARM state from any other state.
`CompositeAlarm`	`withAlarmArn(String alarmArn)` The Amazon Resource Name (ARN) of the alarm.
`CompositeAlarm`	`withAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)` The time stamp of the last update to the alarm configuration.
`CompositeAlarm`	`withAlarmDescription(String alarmDescription)` The description of the alarm.
`CompositeAlarm`	`withAlarmName(String alarmName)` The name of the alarm.
`CompositeAlarm`	`withAlarmRule(String alarmRule)` The rule that this alarm uses to evaluate its alarm state.
`CompositeAlarm`	`withInsufficientDataActions(Collection<String> insufficientDataActions)` The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
`CompositeAlarm`	`withInsufficientDataActions(String... insufficientDataActions)` The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
`CompositeAlarm`	`withOKActions(Collection<String> oKActions)` The actions to execute when this alarm transitions to the OK state from any other state.
`CompositeAlarm`	`withOKActions(String... oKActions)` The actions to execute when this alarm transitions to the OK state from any other state.
`CompositeAlarm`	`withStateReason(String stateReason)` An explanation for the alarm state, in text format.
`CompositeAlarm`	`withStateReasonData(String stateReasonData)` An explanation for the alarm state, in JSON format.
`CompositeAlarm`	`withStateTransitionedTimestamp(Date stateTransitionedTimestamp)` The timestamp of the last change to the alarm's `StateValue`.
`CompositeAlarm`	`withStateUpdatedTimestamp(Date stateUpdatedTimestamp)` Tracks the timestamp of any state update, even if `StateValue` doesn't change.
`CompositeAlarm`	`withStateValue(StateValue stateValue)` The state value for the alarm.
`CompositeAlarm`	`withStateValue(String stateValue)` The state value for the alarm.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CompositeAlarm
```
public CompositeAlarm()
```
- Method Detail
  - setActionsEnabled
```
public void setActionsEnabled(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.
  - getActionsEnabled
```
public Boolean getActionsEnabled()
```
    Indicates whether actions should be executed during any changes to the alarm state.
    
    Returns:
    
    Indicates whether actions should be executed during any changes to the alarm state.
  - withActionsEnabled
```
public CompositeAlarm withActionsEnabled(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.
  - isActionsEnabled
```
public Boolean isActionsEnabled()
```
    Indicates whether actions should be executed during any changes to the alarm state.
    
    Returns:
    
    Indicates whether actions should be executed during any changes to the alarm state.
  - getAlarmActions
```
public List<String> getAlarmActions()
```
    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:
    
    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).
  - setAlarmActions
```
public void setAlarmActions(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).
  - withAlarmActions
```
public CompositeAlarm withAlarmActions(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).
    
    NOTE: This method appends the values to the existing list (if any). Use setAlarmActions(java.util.Collection) or withAlarmActions(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAlarmActions
```
public CompositeAlarm withAlarmActions(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.
  - setAlarmArn
```
public void setAlarmArn(String alarmArn)
```
    The Amazon Resource Name (ARN) of the alarm.
    
    Parameters:
    
    alarmArn - The Amazon Resource Name (ARN) of the alarm.
  - getAlarmArn
```
public String getAlarmArn()
```
    The Amazon Resource Name (ARN) of the alarm.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the alarm.
  - withAlarmArn
```
public CompositeAlarm withAlarmArn(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.
  - setAlarmConfigurationUpdatedTimestamp
```
public void setAlarmConfigurationUpdatedTimestamp(Date 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.
  - getAlarmConfigurationUpdatedTimestamp
```
public Date getAlarmConfigurationUpdatedTimestamp()
```
    The time stamp of the last update to the alarm configuration.
    
    Returns:
    
    The time stamp of the last update to the alarm configuration.
  - withAlarmConfigurationUpdatedTimestamp
```
public CompositeAlarm withAlarmConfigurationUpdatedTimestamp(Date 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.
  - setAlarmDescription
```
public void setAlarmDescription(String alarmDescription)
```
    The description of the alarm.
    
    Parameters:
    
    alarmDescription - The description of the alarm.
  - getAlarmDescription
```
public String getAlarmDescription()
```
    The description of the alarm.
    
    Returns:
    
    The description of the alarm.
  - withAlarmDescription
```
public CompositeAlarm withAlarmDescription(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.
  - setAlarmName
```
public void setAlarmName(String alarmName)
```
    The name of the alarm.
    
    Parameters:
    
    alarmName - The name of the alarm.
  - getAlarmName
```
public String getAlarmName()
```
    The name of the alarm.
    
    Returns:
    
    The name of the alarm.
  - withAlarmName
```
public CompositeAlarm withAlarmName(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.
  - setAlarmRule
```
public void setAlarmRule(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.
  - getAlarmRule
```
public String getAlarmRule()
```
    The rule that this alarm uses to evaluate its alarm state.
    
    Returns:
    
    The rule that this alarm uses to evaluate its alarm state.
  - withAlarmRule
```
public CompositeAlarm withAlarmRule(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.
  - getInsufficientDataActions
```
public List<String> getInsufficientDataActions()
```
    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:
    
    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).
  - setInsufficientDataActions
```
public void setInsufficientDataActions(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).
  - withInsufficientDataActions
```
public CompositeAlarm withInsufficientDataActions(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).
    
    NOTE: This method appends the values to the existing list (if any). Use setInsufficientDataActions(java.util.Collection) or withInsufficientDataActions(java.util.Collection) if you want to override the existing values.
    
    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.
  - withInsufficientDataActions
```
public CompositeAlarm withInsufficientDataActions(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.
  - getOKActions
```
public List<String> getOKActions()
```
    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:
    
    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).
  - setOKActions
```
public void setOKActions(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).
  - withOKActions
```
public CompositeAlarm withOKActions(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).
    
    NOTE: This method appends the values to the existing list (if any). Use setOKActions(java.util.Collection) or withOKActions(java.util.Collection) if you want to override the existing values.
    
    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.
  - withOKActions
```
public CompositeAlarm withOKActions(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.
  - setStateReason
```
public void setStateReason(String stateReason)
```
    An explanation for the alarm state, in text format.
    
    Parameters:
    
    stateReason - An explanation for the alarm state, in text format.
  - getStateReason
```
public String getStateReason()
```
    An explanation for the alarm state, in text format.
    
    Returns:
    
    An explanation for the alarm state, in text format.
  - withStateReason
```
public CompositeAlarm withStateReason(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.
  - setStateReasonData
```
public void setStateReasonData(String stateReasonData)
```
    An explanation for the alarm state, in JSON format.
    
    Parameters:
    
    stateReasonData - An explanation for the alarm state, in JSON format.
  - getStateReasonData
```
public String getStateReasonData()
```
    An explanation for the alarm state, in JSON format.
    
    Returns:
    
    An explanation for the alarm state, in JSON format.
  - withStateReasonData
```
public CompositeAlarm withStateReasonData(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.
  - setStateUpdatedTimestamp
```
public void setStateUpdatedTimestamp(Date 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.
  - getStateUpdatedTimestamp
```
public Date getStateUpdatedTimestamp()
```
    Tracks the timestamp of any state update, even if StateValue doesn't change.
    
    Returns:
    
    Tracks the timestamp of any state update, even if StateValue doesn't change.
  - withStateUpdatedTimestamp
```
public CompositeAlarm withStateUpdatedTimestamp(Date 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.
  - setStateValue
```
public void setStateValue(String stateValue)
```
    The state value for the alarm.
    
    Parameters:
    
    stateValue - The state value for the alarm.
    
    See Also:
    
    StateValue
  - getStateValue
```
public String getStateValue()
```
    The state value for the alarm.
    
    Returns:
    
    The state value for the alarm.
    
    See Also:
    
    StateValue
  - withStateValue
```
public CompositeAlarm withStateValue(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
  - withStateValue
```
public CompositeAlarm withStateValue(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
  - setStateTransitionedTimestamp
```
public void setStateTransitionedTimestamp(Date 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.
  - getStateTransitionedTimestamp
```
public Date getStateTransitionedTimestamp()
```
    The timestamp of the last change to the alarm's StateValue.
    
    Returns:
    
    The timestamp of the last change to the alarm's StateValue.
  - withStateTransitionedTimestamp
```
public CompositeAlarm withStateTransitionedTimestamp(Date 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.
  - setActionsSuppressedBy
```
public void setActionsSuppressedBy(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.
    
    See Also:
    
    ActionsSuppressedBy
  - getActionsSuppressedBy
```
public String getActionsSuppressedBy()
```
    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:
    
    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.
    
    See Also:
    
    ActionsSuppressedBy
  - withActionsSuppressedBy
```
public CompositeAlarm withActionsSuppressedBy(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
  - withActionsSuppressedBy
```
public CompositeAlarm withActionsSuppressedBy(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
  - setActionsSuppressedReason
```
public void setActionsSuppressedReason(String actionsSuppressedReason)
```
    Captures the reason for action suppression.
    
    Parameters:
    
    actionsSuppressedReason - Captures the reason for action suppression.
  - getActionsSuppressedReason
```
public String getActionsSuppressedReason()
```
    Captures the reason for action suppression.
    
    Returns:
    
    Captures the reason for action suppression.
  - withActionsSuppressedReason
```
public CompositeAlarm withActionsSuppressedReason(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.
  - setActionsSuppressor
```
public void setActionsSuppressor(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.
  - getActionsSuppressor
```
public String getActionsSuppressor()
```
    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:
    
    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.
  - withActionsSuppressor
```
public CompositeAlarm withActionsSuppressor(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.
  - setActionsSuppressorWaitPeriod
```
public void setActionsSuppressorWaitPeriod(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.
  - getActionsSuppressorWaitPeriod
```
public Integer getActionsSuppressorWaitPeriod()
```
    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:
    
    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.
  - withActionsSuppressorWaitPeriod
```
public CompositeAlarm withActionsSuppressorWaitPeriod(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.
  - setActionsSuppressorExtensionPeriod
```
public void setActionsSuppressorExtensionPeriod(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.
  - getActionsSuppressorExtensionPeriod
```
public Integer getActionsSuppressorExtensionPeriod()
```
    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:
    
    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.
  - withActionsSuppressorExtensionPeriod
```
public CompositeAlarm withActionsSuppressorExtensionPeriod(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CompositeAlarm clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.778

Class CompositeAlarm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompositeAlarm

Method Detail

setActionsEnabled

getActionsEnabled

withActionsEnabled

isActionsEnabled

getAlarmActions

setAlarmActions

withAlarmActions

withAlarmActions

setAlarmArn

getAlarmArn

withAlarmArn

setAlarmConfigurationUpdatedTimestamp

getAlarmConfigurationUpdatedTimestamp

withAlarmConfigurationUpdatedTimestamp

setAlarmDescription

getAlarmDescription

withAlarmDescription

setAlarmName

getAlarmName

withAlarmName

setAlarmRule

getAlarmRule

withAlarmRule

getInsufficientDataActions

setInsufficientDataActions

withInsufficientDataActions

withInsufficientDataActions

getOKActions

setOKActions

withOKActions

withOKActions

setStateReason

getStateReason

withStateReason

setStateReasonData

getStateReasonData

withStateReasonData

setStateUpdatedTimestamp

getStateUpdatedTimestamp

withStateUpdatedTimestamp

setStateValue

getStateValue

withStateValue

withStateValue

setStateTransitionedTimestamp

getStateTransitionedTimestamp

withStateTransitionedTimestamp

setActionsSuppressedBy

getActionsSuppressedBy

withActionsSuppressedBy

withActionsSuppressedBy

setActionsSuppressedReason

getActionsSuppressedReason

withActionsSuppressedReason

setActionsSuppressor

getActionsSuppressor

withActionsSuppressor

setActionsSuppressorWaitPeriod

getActionsSuppressorWaitPeriod

withActionsSuppressorWaitPeriod

setActionsSuppressorExtensionPeriod

getActionsSuppressorExtensionPeriod

withActionsSuppressorExtensionPeriod

toString

equals

hashCode

clone