Package software.amazon.awssdk.services.autoscalingplans.model

Class CustomizedLoadMetricSpecification

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<CustomizedLoadMetricSpecification.Builder,​CustomizedLoadMetricSpecification>
    @Generated("software.amazon.awssdk:codegen")
public final class CustomizedLoadMetricSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomizedLoadMetricSpecification.Builder,​CustomizedLoadMetricSpecification>

    Represents a CloudWatch metric of your choosing that can be used for predictive scaling.

    For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data.

    When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

    If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).

    For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.

    After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.

    See Also:
    Serialized Form

    • Method Detail

      • metricName

        public final String metricName()

        The name of the metric.

        Returns:
        The name of the metric.

      • namespace

        public final String namespace()

        The namespace of the metric.

        Returns:
        The namespace of the metric.

      • 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 the isEmpty() 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

        public final List<MetricDimension> dimensions()

        The dimensions of the metric.

        Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

        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:
        The dimensions of the metric.

        Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

      • statisticAsString

        public final String statisticAsString()

        The statistic of the metric. The only valid value is Sum.

        If the service returns an enum value that is not available in the current SDK version, statistic will return MetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

        Returns:
        The statistic of the metric. The only valid value is Sum.
        See Also:
        MetricStatistic

      • unit

        public final String unit()

        The unit of the metric.

        Returns:
        The unit of the metric.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String 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.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)