Class CloudWatchAlarmDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CloudWatchAlarmDefinition.Builder,
CloudWatchAlarmDefinition>
The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ComparisonOperator
Determines how the metric specified byMetricName
is compared to the value specified byThreshold
.final String
Determines how the metric specified byMetricName
is compared to the value specified byThreshold
.final List
<MetricDimension> A CloudWatch metric dimension.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Dimensions property.final int
hashCode()
final String
The name of the CloudWatch metric that is watched to determine an alarm condition.final String
The namespace for the CloudWatch metric.final Integer
period()
The period, in seconds, over which the statistic is applied.static Class
<? extends CloudWatchAlarmDefinition.Builder> final Statistic
The statistic to apply to the metric associated with the alarm.final String
The statistic to apply to the metric associated with the alarm.final Double
The value against which the specified statistic is compared.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Unit
unit()
The unit of measure associated with the CloudWatch metric being watched.final String
The unit of measure associated with the CloudWatch metric being watched.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
comparisonOperator
Determines how the metric specified by
MetricName
is compared to the value specified byThreshold
.If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- Determines how the metric specified by
MetricName
is compared to the value specified byThreshold
. - See Also:
-
comparisonOperatorAsString
Determines how the metric specified by
MetricName
is compared to the value specified byThreshold
.If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- Determines how the metric specified by
MetricName
is compared to the value specified byThreshold
. - See Also:
-
evaluationPeriods
The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is
1
.- Returns:
- The number of periods, in five-minute increments, during which the alarm condition must exist before the
alarm triggers automatic scaling activity. The default value is
1
.
-
metricName
The name of the CloudWatch metric that is watched to determine an alarm condition.
- Returns:
- The name of the CloudWatch metric that is watched to determine an alarm condition.
-
namespace
The namespace for the CloudWatch metric. The default is
AWS/ElasticMapReduce
.- Returns:
- The namespace for the CloudWatch metric. The default is
AWS/ElasticMapReduce
.
-
period
The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify
300
.- Returns:
- The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are
emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify
300
.
-
statistic
The statistic to apply to the metric associated with the alarm. The default is
AVERAGE
.If the service returns an enum value that is not available in the current SDK version,
statistic
will returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic to apply to the metric associated with the alarm. The default is
AVERAGE
. - See Also:
-
statisticAsString
The statistic to apply to the metric associated with the alarm. The default is
AVERAGE
.If the service returns an enum value that is not available in the current SDK version,
statistic
will returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic to apply to the metric associated with the alarm. The default is
AVERAGE
. - See Also:
-
threshold
The value against which the specified statistic is compared.
- Returns:
- The value against which the specified statistic is compared.
-
unit
The unit of measure associated with the CloudWatch metric being watched. The value specified for
Unit
must correspond to the units specified in the CloudWatch metric.If the service returns an enum value that is not available in the current SDK version,
unit
will returnUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit of measure associated with the CloudWatch metric being watched. The value specified for
Unit
must correspond to the units specified in the CloudWatch metric. - See Also:
-
unitAsString
The unit of measure associated with the CloudWatch metric being watched. The value specified for
Unit
must correspond to the units specified in the CloudWatch metric.If the service returns an enum value that is not available in the current SDK version,
unit
will returnUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit of measure associated with the CloudWatch metric being watched. The value specified for
Unit
must correspond to the units specified in the CloudWatch metric. - See Also:
-
hasDimensions
public final boolean hasDimensions()For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
dimensions
A CloudWatch metric dimension.
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
hasDimensions()
method.- Returns:
- A CloudWatch metric dimension.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CloudWatchAlarmDefinition.Builder,
CloudWatchAlarmDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-