public static interface PutCompositeAlarmRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<PutCompositeAlarmRequest.Builder,PutCompositeAlarmRequest>
Modifier and Type | Method and Description |
---|---|
PutCompositeAlarmRequest.Builder |
actionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
|
PutCompositeAlarmRequest.Builder |
alarmActions(Collection<String> alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
PutCompositeAlarmRequest.Builder |
alarmActions(String... alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
PutCompositeAlarmRequest.Builder |
alarmDescription(String alarmDescription)
The description for the composite alarm.
|
PutCompositeAlarmRequest.Builder |
alarmName(String alarmName)
The name for the composite alarm.
|
PutCompositeAlarmRequest.Builder |
alarmRule(String alarmRule)
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's
state.
|
PutCompositeAlarmRequest.Builder |
insufficientDataActions(Collection<String> insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
PutCompositeAlarmRequest.Builder |
insufficientDataActions(String... insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
PutCompositeAlarmRequest.Builder |
okActions(Collection<String> okActions)
The actions to execute when this alarm transitions to an
OK state from any other state. |
PutCompositeAlarmRequest.Builder |
okActions(String... okActions)
The actions to execute when this alarm transitions to an
OK state from any other state. |
PutCompositeAlarmRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutCompositeAlarmRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutCompositeAlarmRequest.Builder |
tags(Collection<Tag> tags)
A list of key-value pairs to associate with the composite alarm.
|
PutCompositeAlarmRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs to associate with the composite alarm.
|
PutCompositeAlarmRequest.Builder |
tags(Tag... tags)
A list of key-value pairs to associate with the composite alarm.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutCompositeAlarmRequest.Builder actionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
The default is TRUE
.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm state of the composite
alarm. The default is TRUE
.PutCompositeAlarmRequest.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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:ssm:region:account-id:opsitem:severity
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
PutCompositeAlarmRequest.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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:ssm:region:account-id:opsitem:severity
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
PutCompositeAlarmRequest.Builder alarmDescription(String alarmDescription)
The description for the composite alarm.
alarmDescription
- The description for the composite alarm.PutCompositeAlarmRequest.Builder alarmName(String alarmName)
The name for the composite alarm. This name must be unique within the Region.
alarmName
- The name for the composite alarm. This name must be unique within the Region.PutCompositeAlarmRequest.Builder alarmRule(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.
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.
PutCompositeAlarmRequest.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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
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
PutCompositeAlarmRequest.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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
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
PutCompositeAlarmRequest.Builder okActions(Collection<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
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
PutCompositeAlarmRequest.Builder okActions(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
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
PutCompositeAlarmRequest.Builder tags(Collection<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.
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.
PutCompositeAlarmRequest.Builder tags(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.
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.
PutCompositeAlarmRequest.Builder tags(Consumer<Tag.Builder>... 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.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
PutCompositeAlarmRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutCompositeAlarmRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2021. All rights reserved.