/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace AutoScalingPlans { namespace Model { /** *

Represents a CloudWatch metric of your choosing that can be used for dynamic * scaling as part of a target tracking scaling policy.

To create your * customized scaling metric specification:

  • Add values for each * required parameter from CloudWatch. You can use an existing metric, or a new * metric that you create. To use your own metric, you must first publish the * metric to CloudWatch. For more information, see Publish * Custom Metrics in the Amazon CloudWatch User Guide.

  • *

    Choose a metric that changes proportionally with capacity. The value of the * metric should increase or decrease in inverse proportion to the number of * capacity units. That is, the value of the metric should decrease when capacity * increases.

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

See Also:

AWS * API Reference

*/ class CustomizedScalingMetricSpecification { public: AWS_AUTOSCALINGPLANS_API CustomizedScalingMetricSpecification(); AWS_AUTOSCALINGPLANS_API CustomizedScalingMetricSpecification(Aws::Utils::Json::JsonView jsonValue); AWS_AUTOSCALINGPLANS_API CustomizedScalingMetricSpecification& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_AUTOSCALINGPLANS_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the metric.

*/ inline const Aws::String& GetMetricName() const{ return m_metricName; } /** *

The name of the metric.

*/ inline bool MetricNameHasBeenSet() const { return m_metricNameHasBeenSet; } /** *

The name of the metric.

*/ inline void SetMetricName(const Aws::String& value) { m_metricNameHasBeenSet = true; m_metricName = value; } /** *

The name of the metric.

*/ inline void SetMetricName(Aws::String&& value) { m_metricNameHasBeenSet = true; m_metricName = std::move(value); } /** *

The name of the metric.

*/ inline void SetMetricName(const char* value) { m_metricNameHasBeenSet = true; m_metricName.assign(value); } /** *

The name of the metric.

*/ inline CustomizedScalingMetricSpecification& WithMetricName(const Aws::String& value) { SetMetricName(value); return *this;} /** *

The name of the metric.

*/ inline CustomizedScalingMetricSpecification& WithMetricName(Aws::String&& value) { SetMetricName(std::move(value)); return *this;} /** *

The name of the metric.

*/ inline CustomizedScalingMetricSpecification& WithMetricName(const char* value) { SetMetricName(value); return *this;} /** *

The namespace of the metric.

*/ inline const Aws::String& GetNamespace() const{ return m_namespace; } /** *

The namespace of the metric.

*/ inline bool NamespaceHasBeenSet() const { return m_namespaceHasBeenSet; } /** *

The namespace of the metric.

*/ inline void SetNamespace(const Aws::String& value) { m_namespaceHasBeenSet = true; m_namespace = value; } /** *

The namespace of the metric.

*/ inline void SetNamespace(Aws::String&& value) { m_namespaceHasBeenSet = true; m_namespace = std::move(value); } /** *

The namespace of the metric.

*/ inline void SetNamespace(const char* value) { m_namespaceHasBeenSet = true; m_namespace.assign(value); } /** *

The namespace of the metric.

*/ inline CustomizedScalingMetricSpecification& WithNamespace(const Aws::String& value) { SetNamespace(value); return *this;} /** *

The namespace of the metric.

*/ inline CustomizedScalingMetricSpecification& WithNamespace(Aws::String&& value) { SetNamespace(std::move(value)); return *this;} /** *

The namespace of the metric.

*/ inline CustomizedScalingMetricSpecification& WithNamespace(const char* value) { SetNamespace(value); return *this;} /** *

The dimensions of the metric.

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

*/ inline const Aws::Vector& GetDimensions() const{ return m_dimensions; } /** *

The dimensions of the metric.

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

*/ inline bool DimensionsHasBeenSet() const { return m_dimensionsHasBeenSet; } /** *

The dimensions of the metric.

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

*/ inline void SetDimensions(const Aws::Vector& value) { m_dimensionsHasBeenSet = true; m_dimensions = value; } /** *

The dimensions of the metric.

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

*/ inline void SetDimensions(Aws::Vector&& value) { m_dimensionsHasBeenSet = true; m_dimensions = std::move(value); } /** *

The dimensions of the metric.

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

*/ inline CustomizedScalingMetricSpecification& WithDimensions(const Aws::Vector& value) { SetDimensions(value); return *this;} /** *

The dimensions of the metric.

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

*/ inline CustomizedScalingMetricSpecification& WithDimensions(Aws::Vector&& value) { SetDimensions(std::move(value)); return *this;} /** *

The dimensions of the metric.

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

*/ inline CustomizedScalingMetricSpecification& AddDimensions(const MetricDimension& value) { m_dimensionsHasBeenSet = true; m_dimensions.push_back(value); return *this; } /** *

The dimensions of the metric.

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

*/ inline CustomizedScalingMetricSpecification& AddDimensions(MetricDimension&& value) { m_dimensionsHasBeenSet = true; m_dimensions.push_back(std::move(value)); return *this; } /** *

The statistic of the metric.

*/ inline const MetricStatistic& GetStatistic() const{ return m_statistic; } /** *

The statistic of the metric.

*/ inline bool StatisticHasBeenSet() const { return m_statisticHasBeenSet; } /** *

The statistic of the metric.

*/ inline void SetStatistic(const MetricStatistic& value) { m_statisticHasBeenSet = true; m_statistic = value; } /** *

The statistic of the metric.

*/ inline void SetStatistic(MetricStatistic&& value) { m_statisticHasBeenSet = true; m_statistic = std::move(value); } /** *

The statistic of the metric.

*/ inline CustomizedScalingMetricSpecification& WithStatistic(const MetricStatistic& value) { SetStatistic(value); return *this;} /** *

The statistic of the metric.

*/ inline CustomizedScalingMetricSpecification& WithStatistic(MetricStatistic&& value) { SetStatistic(std::move(value)); return *this;} /** *

The unit of the metric.

*/ inline const Aws::String& GetUnit() const{ return m_unit; } /** *

The unit of the metric.

*/ inline bool UnitHasBeenSet() const { return m_unitHasBeenSet; } /** *

The unit of the metric.

*/ inline void SetUnit(const Aws::String& value) { m_unitHasBeenSet = true; m_unit = value; } /** *

The unit of the metric.

*/ inline void SetUnit(Aws::String&& value) { m_unitHasBeenSet = true; m_unit = std::move(value); } /** *

The unit of the metric.

*/ inline void SetUnit(const char* value) { m_unitHasBeenSet = true; m_unit.assign(value); } /** *

The unit of the metric.

*/ inline CustomizedScalingMetricSpecification& WithUnit(const Aws::String& value) { SetUnit(value); return *this;} /** *

The unit of the metric.

*/ inline CustomizedScalingMetricSpecification& WithUnit(Aws::String&& value) { SetUnit(std::move(value)); return *this;} /** *

The unit of the metric.

*/ inline CustomizedScalingMetricSpecification& WithUnit(const char* value) { SetUnit(value); return *this;} private: Aws::String m_metricName; bool m_metricNameHasBeenSet = false; Aws::String m_namespace; bool m_namespaceHasBeenSet = false; Aws::Vector m_dimensions; bool m_dimensionsHasBeenSet = false; MetricStatistic m_statistic; bool m_statisticHasBeenSet = false; Aws::String m_unit; bool m_unitHasBeenSet = false; }; } // namespace Model } // namespace AutoScalingPlans } // namespace Aws