@Generated(value="software.amazon.awssdk:codegen") public final class PutCompositeAlarmRequest extends CloudWatchRequest implements ToCopyableBuilder<PutCompositeAlarmRequest.Builder,PutCompositeAlarmRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutCompositeAlarmRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
|
List<String> |
alarmActions()
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
String |
alarmDescription()
The description for the composite alarm.
|
String |
alarmName()
The name for the composite alarm.
|
String |
alarmRule()
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
|
static PutCompositeAlarmRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAlarmActions()
For responses, this returns true if the service returned a value for the AlarmActions property.
|
int |
hashCode() |
boolean |
hasInsufficientDataActions()
For responses, this returns true if the service returned a value for the InsufficientDataActions property.
|
boolean |
hasOkActions()
For responses, this returns true if the service returned a value for the OKActions property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
List<String> |
insufficientDataActions()
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
List<String> |
okActions()
The actions to execute when this alarm transitions to an
OK state from any other state. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutCompositeAlarmRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of key-value pairs to associate with the composite alarm.
|
PutCompositeAlarmRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Boolean actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The
default is TRUE
.
TRUE
.public final boolean hasAlarmActions()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:ssm:region:account-id:opsitem:severity
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAlarmActions()
method.
ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:ssm:region:account-id:opsitem:severity
public final String alarmDescription()
The description for the composite alarm.
public final String alarmName()
The name for the composite alarm. This name must be unique within the Region.
public final String alarmRule()
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
ALARM("alarm-name or alarm-ARN")
is TRUE if the named alarm is in ALARM state.
OK("alarm-name or alarm-ARN")
is TRUE if the named alarm is in OK state.
INSUFFICIENT_DATA("alarm-name or alarm-ARN")
is TRUE if the named alarm is in
INSUFFICIENT_DATA state.
TRUE
always evaluates to TRUE.
FALSE
always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule
structure, and for testing your alarm
actions.
Alarm names specified in AlarmRule
can be surrounded with double-quotes ("), but do not have to be.
The following are some examples of AlarmRule
:
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
specifies that the composite alarm goes
into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
specifies that the alarm goes to
ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This
example reduces alarm noise during a known deployment window.
(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
goes into
ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK
state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are
not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.
The AlarmRule
can specify as many as 100 "children" alarms. The AlarmRule
expression
can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
ALARM("alarm-name or alarm-ARN")
is TRUE if the named alarm is in ALARM state.
OK("alarm-name or alarm-ARN")
is TRUE if the named alarm is in OK state.
INSUFFICIENT_DATA("alarm-name or alarm-ARN")
is TRUE if the named alarm is in
INSUFFICIENT_DATA state.
TRUE
always evaluates to TRUE.
FALSE
always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule
structure, and for testing your
alarm actions.
Alarm names specified in AlarmRule
can be surrounded with double-quotes ("), but do not have
to be.
The following are some examples of AlarmRule
:
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
specifies that the composite
alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM
state.
ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
specifies that the alarm
goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM
state. This example reduces alarm noise during a known deployment window.
(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
goes
into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if
NetworkOutTooHigh is in OK state. This provides another example of using a composite alarm to prevent
noise. This rule ensures that you are not notified with an alarm action on high CPU or disk usage if a
known network problem is also occurring.
The AlarmRule
can specify as many as 100 "children" alarms. The AlarmRule
expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and
parentheses.
public final boolean hasInsufficientDataActions()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasInsufficientDataActions()
method.
INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
public final boolean hasOkActions()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> okActions()
The actions to execute when this alarm transitions to an OK
state from any other state. Each action
is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasOkActions()
method.
OK
state from any other state. Each
action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
public final boolean hasTags()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags()
method.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
public PutCompositeAlarmRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutCompositeAlarmRequest.Builder,PutCompositeAlarmRequest>
toBuilder
in class CloudWatchRequest
public static PutCompositeAlarmRequest.Builder builder()
public static Class<? extends PutCompositeAlarmRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.