public static interface MetricAlarm.Builder extends SdkPojo, CopyableBuilder<MetricAlarm.Builder,MetricAlarm>
Modifier and Type | Method and Description |
---|---|
MetricAlarm.Builder |
actionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
|
MetricAlarm.Builder |
alarmActions(Collection<String> alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
MetricAlarm.Builder |
alarmActions(String... alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
MetricAlarm.Builder |
alarmArn(String alarmArn)
The Amazon Resource Name (ARN) of the alarm.
|
MetricAlarm.Builder |
alarmConfigurationUpdatedTimestamp(Instant alarmConfigurationUpdatedTimestamp)
The time stamp of the last update to the alarm configuration.
|
MetricAlarm.Builder |
alarmDescription(String alarmDescription)
The description of the alarm.
|
MetricAlarm.Builder |
alarmName(String alarmName)
The name of the alarm.
|
MetricAlarm.Builder |
comparisonOperator(ComparisonOperator comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
MetricAlarm.Builder |
comparisonOperator(String comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
MetricAlarm.Builder |
datapointsToAlarm(Integer datapointsToAlarm)
The number of datapoints that must be breaching to trigger the alarm.
|
MetricAlarm.Builder |
dimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
|
MetricAlarm.Builder |
dimensions(Consumer<Dimension.Builder>... dimensions)
The dimensions for the metric associated with the alarm.
|
MetricAlarm.Builder |
dimensions(Dimension... dimensions)
The dimensions for the metric associated with the alarm.
|
MetricAlarm.Builder |
evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
Used only for alarms based on percentiles.
|
MetricAlarm.Builder |
evaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
MetricAlarm.Builder |
extendedStatistic(String extendedStatistic)
The percentile statistic for the metric associated with the alarm.
|
MetricAlarm.Builder |
insufficientDataActions(Collection<String> insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
MetricAlarm.Builder |
insufficientDataActions(String... insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
MetricAlarm.Builder |
metricName(String metricName)
The name of the metric associated with the alarm.
|
MetricAlarm.Builder |
metrics(Collection<MetricDataQuery> metrics)
|
MetricAlarm.Builder |
metrics(Consumer<MetricDataQuery.Builder>... metrics)
This is a convenience that creates an instance of the
List avoiding the need
to create one manually via List . |
MetricAlarm.Builder |
metrics(MetricDataQuery... metrics)
|
MetricAlarm.Builder |
namespace(String namespace)
The namespace of the metric associated with the alarm.
|
MetricAlarm.Builder |
okActions(Collection<String> okActions)
The actions to execute when this alarm transitions to the
OK state from any other state. |
MetricAlarm.Builder |
okActions(String... okActions)
The actions to execute when this alarm transitions to the
OK state from any other state. |
MetricAlarm.Builder |
period(Integer period)
The period, in seconds, over which the statistic is applied.
|
MetricAlarm.Builder |
stateReason(String stateReason)
An explanation for the alarm state, in text format.
|
MetricAlarm.Builder |
stateReasonData(String stateReasonData)
An explanation for the alarm state, in JSON format.
|
MetricAlarm.Builder |
stateUpdatedTimestamp(Instant stateUpdatedTimestamp)
The time stamp of the last update to the alarm state.
|
MetricAlarm.Builder |
stateValue(StateValue stateValue)
The state value for the alarm.
|
MetricAlarm.Builder |
stateValue(String stateValue)
The state value for the alarm.
|
MetricAlarm.Builder |
statistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
MetricAlarm.Builder |
statistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
MetricAlarm.Builder |
threshold(Double threshold)
The value to compare with the specified statistic.
|
MetricAlarm.Builder |
treatMissingData(String treatMissingData)
Sets how this alarm is to handle missing data points.
|
MetricAlarm.Builder |
unit(StandardUnit unit)
The unit of the metric associated with the alarm.
|
MetricAlarm.Builder |
unit(String unit)
The unit of the metric associated with the alarm.
|
copy
applyMutation, build
MetricAlarm.Builder alarmName(String alarmName)
The name of the alarm.
alarmName
- The name of the alarm.MetricAlarm.Builder alarmArn(String alarmArn)
The Amazon Resource Name (ARN) of the alarm.
alarmArn
- The Amazon Resource Name (ARN) of the alarm.MetricAlarm.Builder alarmDescription(String alarmDescription)
The description of the alarm.
alarmDescription
- The description of the alarm.MetricAlarm.Builder alarmConfigurationUpdatedTimestamp(Instant alarmConfigurationUpdatedTimestamp)
The time stamp of the last update to the alarm configuration.
alarmConfigurationUpdatedTimestamp
- The time stamp of the last update to the alarm configuration.MetricAlarm.Builder actionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm state.MetricAlarm.Builder okActions(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).
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).MetricAlarm.Builder okActions(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).
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).MetricAlarm.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).
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).MetricAlarm.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).
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).MetricAlarm.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).
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).MetricAlarm.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).
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).MetricAlarm.Builder stateValue(String stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
,
StateValue
MetricAlarm.Builder stateValue(StateValue stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
,
StateValue
MetricAlarm.Builder stateReason(String stateReason)
An explanation for the alarm state, in text format.
stateReason
- An explanation for the alarm state, in text format.MetricAlarm.Builder stateReasonData(String stateReasonData)
An explanation for the alarm state, in JSON format.
stateReasonData
- An explanation for the alarm state, in JSON format.MetricAlarm.Builder stateUpdatedTimestamp(Instant stateUpdatedTimestamp)
The time stamp of the last update to the alarm state.
stateUpdatedTimestamp
- The time stamp of the last update to the alarm state.MetricAlarm.Builder metricName(String metricName)
The name of the metric associated with the alarm.
metricName
- The name of the metric associated with the alarm.MetricAlarm.Builder namespace(String namespace)
The namespace of the metric associated with the alarm.
namespace
- The namespace of the metric associated with the alarm.MetricAlarm.Builder statistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
MetricAlarm.Builder statistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
MetricAlarm.Builder extendedStatistic(String extendedStatistic)
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
extendedStatistic
- The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and
p100.MetricAlarm.Builder dimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
dimensions
- The dimensions for the metric associated with the alarm.MetricAlarm.Builder dimensions(Dimension... dimensions)
The dimensions for the metric associated with the alarm.
dimensions
- The dimensions for the metric associated with the alarm.MetricAlarm.Builder dimensions(Consumer<Dimension.Builder>... dimensions)
The dimensions for the metric associated with the alarm.
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 #dimensions(List)
.dimensions
- a consumer that will call methods on List.Builder
#dimensions(List)
MetricAlarm.Builder period(Integer period)
The period, in seconds, over which the statistic is applied.
period
- The period, in seconds, over which the statistic is applied.MetricAlarm.Builder unit(String unit)
The unit of the metric associated with the alarm.
unit
- The unit of the metric associated with the alarm.StandardUnit
,
StandardUnit
MetricAlarm.Builder unit(StandardUnit unit)
The unit of the metric associated with the alarm.
unit
- The unit of the metric associated with the alarm.StandardUnit
,
StandardUnit
MetricAlarm.Builder evaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
evaluationPeriods
- The number of periods over which data is compared to the specified threshold.MetricAlarm.Builder datapointsToAlarm(Integer datapointsToAlarm)
The number of datapoints that must be breaching to trigger the alarm.
datapointsToAlarm
- The number of datapoints that must be breaching to trigger the alarm.MetricAlarm.Builder threshold(Double threshold)
The value to compare with the specified statistic.
threshold
- The value to compare with the specified statistic.MetricAlarm.Builder comparisonOperator(String comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
,
ComparisonOperator
MetricAlarm.Builder comparisonOperator(ComparisonOperator comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
,
ComparisonOperator
MetricAlarm.Builder treatMissingData(String treatMissingData)
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of
missing
is used.
treatMissingData
- Sets how this alarm is to handle missing data points. If this parameter is omitted, the default
behavior of missing
is used.MetricAlarm.Builder evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
Used only for alarms based on percentiles. If ignore
, the alarm state does not change during
periods with too few data points to be statistically significant. If evaluate
or this parameter
is not used, the alarm is always evaluated and possibly changes state no matter how many data points are
available.
evaluateLowSampleCountPercentile
- Used only for alarms based on percentiles. If ignore
, the alarm state does not change
during periods with too few data points to be statistically significant. If evaluate
or
this parameter is not used, the alarm is always evaluated and possibly changes state no matter how
many data points are available.MetricAlarm.Builder metrics(Collection<MetricDataQuery> metrics)
metrics
- MetricAlarm.Builder metrics(MetricDataQuery... metrics)
metrics
- MetricAlarm.Builder metrics(Consumer<MetricDataQuery.Builder>... metrics)
List.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 #metrics(List)
.metrics
- a consumer that will call methods on List.Builder
#metrics(List)
Copyright © 2019. All rights reserved.