Class CloudWatchAlarmConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CloudWatchAlarmConfiguration.Builder,
CloudWatchAlarmConfiguration>
A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ComparisonOperator
For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.final String
For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.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 the alarm is associated with.final String
The namespace of the metric that the alarm is associated with.final Integer
period()
For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.static Class
<? extends CloudWatchAlarmConfiguration.Builder> final Statistic
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.final String
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.final Double
For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
evaluationPeriods
For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
- Returns:
- For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
-
threshold
For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
- Returns:
- For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
-
comparisonOperator
For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
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:
- For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
- See Also:
-
comparisonOperatorAsString
For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
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:
- For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
- See Also:
-
period
For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
- Returns:
- For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
-
metricName
The name of the CloudWatch metric that the alarm is associated with.
- Returns:
- The name of the CloudWatch metric that the alarm is associated with.
-
namespace
The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
- Returns:
- The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
-
statistic
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
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:
- For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
- See Also:
-
statisticAsString
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
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:
- For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the 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
For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
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:
- For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
-
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<CloudWatchAlarmConfiguration.Builder,
CloudWatchAlarmConfiguration> - 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
-