public static interface DescribeAlarmsRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>
Modifier and Type | Method and Description |
---|---|
DescribeAlarmsRequest.Builder |
actionPrefix(String actionPrefix)
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm
action.
|
DescribeAlarmsRequest.Builder |
alarmNamePrefix(String alarmNamePrefix)
An alarm name prefix.
|
DescribeAlarmsRequest.Builder |
alarmNames(Collection<String> alarmNames)
The names of the alarms to retrieve information about.
|
DescribeAlarmsRequest.Builder |
alarmNames(String... alarmNames)
The names of the alarms to retrieve information about.
|
DescribeAlarmsRequest.Builder |
alarmTypes(AlarmType... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
|
DescribeAlarmsRequest.Builder |
alarmTypes(Collection<AlarmType> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
|
DescribeAlarmsRequest.Builder |
alarmTypesWithStrings(Collection<String> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
|
DescribeAlarmsRequest.Builder |
alarmTypesWithStrings(String... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
|
DescribeAlarmsRequest.Builder |
childrenOfAlarmName(String childrenOfAlarmName)
If you use this parameter and specify the name of a composite alarm, the operation returns information about
the "children" alarms of the alarm you specify.
|
DescribeAlarmsRequest.Builder |
maxRecords(Integer maxRecords)
The maximum number of alarm descriptions to retrieve.
|
DescribeAlarmsRequest.Builder |
nextToken(String nextToken)
The token returned by a previous call to indicate that there is more data available.
|
DescribeAlarmsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
DescribeAlarmsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
DescribeAlarmsRequest.Builder |
parentsOfAlarmName(String parentsOfAlarmName)
If you use this parameter and specify the name of a metric or composite alarm, the operation returns
information about the "parent" alarms of the alarm you specify.
|
DescribeAlarmsRequest.Builder |
stateValue(StateValue stateValue)
Specify this parameter to receive information only about alarms that are currently in the state that you
specify.
|
DescribeAlarmsRequest.Builder |
stateValue(String stateValue)
Specify this parameter to receive information only about alarms that are currently in the state that you
specify.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
DescribeAlarmsRequest.Builder alarmNames(Collection<String> alarmNames)
The names of the alarms to retrieve information about.
alarmNames
- The names of the alarms to retrieve information about.DescribeAlarmsRequest.Builder alarmNames(String... alarmNames)
The names of the alarms to retrieve information about.
alarmNames
- The names of the alarms to retrieve information about.DescribeAlarmsRequest.Builder alarmNamePrefix(String alarmNamePrefix)
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
alarmNamePrefix
- An alarm name prefix. If you specify this parameter, you receive information about all alarms that
have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
DescribeAlarmsRequest.Builder alarmTypesWithStrings(Collection<String> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite
alarms. If you omit this parameter, only metric alarms are returned.DescribeAlarmsRequest.Builder alarmTypesWithStrings(String... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite
alarms. If you omit this parameter, only metric alarms are returned.DescribeAlarmsRequest.Builder alarmTypes(Collection<AlarmType> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite
alarms. If you omit this parameter, only metric alarms are returned.DescribeAlarmsRequest.Builder alarmTypes(AlarmType... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite
alarms. If you omit this parameter, only metric alarms are returned.DescribeAlarmsRequest.Builder childrenOfAlarmName(String childrenOfAlarmName)
If you use this parameter and specify the name of a composite alarm, the operation returns information about
the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced
in the AlarmRule
field of the composite alarm that you specify in
ChildrenOfAlarmName
. Information about the composite alarm that you name in
ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request
except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and
StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To
get complete information about these alarms, perform another DescribeAlarms
operation and
specify the parent alarm names in the AlarmNames
parameter.
childrenOfAlarmName
- If you use this parameter and specify the name of a composite alarm, the operation returns information
about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms
referenced in the AlarmRule
field of the composite alarm that you specify in
ChildrenOfAlarmName
. Information about the composite alarm that you name in
ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the
request except for MaxRecords
and NextToken
. If you do so, you receive a
validation error.
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this
operation when you use this parameter. To get complete information about these alarms, perform another
DescribeAlarms
operation and specify the parent alarm names in the
AlarmNames
parameter.
DescribeAlarmsRequest.Builder parentsOfAlarmName(String parentsOfAlarmName)
If you use this parameter and specify the name of a metric or composite alarm, the operation returns
information about the "parent" alarms of the alarm you specify. These are the composite alarms that have
AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
.
Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except
for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete
information about these alarms, perform another DescribeAlarms
operation and specify the parent
alarm names in the AlarmNames
parameter.
parentsOfAlarmName
- If you use this parameter and specify the name of a metric or composite alarm, the operation returns
information about the "parent" alarms of the alarm you specify. These are the composite alarms that
have AlarmRule
parameters that reference the alarm named in
ParentsOfAlarmName
. Information about the alarm that you specify in
ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request
except for MaxRecords
and NextToken
. If you do so, you receive a validation
error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get
complete information about these alarms, perform another DescribeAlarms
operation and
specify the parent alarm names in the AlarmNames
parameter.
DescribeAlarmsRequest.Builder stateValue(String stateValue)
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
stateValue
- Specify this parameter to receive information only about alarms that are currently in the state that
you specify.StateValue
,
StateValue
DescribeAlarmsRequest.Builder stateValue(StateValue stateValue)
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
stateValue
- Specify this parameter to receive information only about alarms that are currently in the state that
you specify.StateValue
,
StateValue
DescribeAlarmsRequest.Builder actionPrefix(String actionPrefix)
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.
actionPrefix
- Use this parameter to filter the results of the operation to only those alarms that use a certain
alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send
notifications to that topic.DescribeAlarmsRequest.Builder maxRecords(Integer maxRecords)
The maximum number of alarm descriptions to retrieve.
maxRecords
- The maximum number of alarm descriptions to retrieve.DescribeAlarmsRequest.Builder nextToken(String nextToken)
The token returned by a previous call to indicate that there is more data available.
nextToken
- The token returned by a previous call to indicate that there is more data available.DescribeAlarmsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
DescribeAlarmsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2021. All rights reserved.