This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-autoscaling/include/aws/autoscaling/model/PredefinedMetricSpecification.h

297 lines
18 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/autoscaling/AutoScaling_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSStreamFwd.h>
#include <aws/autoscaling/model/MetricType.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Xml
{
class XmlNode;
} // namespace Xml
} // namespace Utils
namespace AutoScaling
{
namespace Model
{
/**
* <p>Represents a predefined metric for a target tracking scaling policy to use
* with Amazon EC2 Auto Scaling.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PredefinedMetricSpecification">AWS
* API Reference</a></p>
*/
class AWS_AUTOSCALING_API PredefinedMetricSpecification
{
public:
PredefinedMetricSpecification();
PredefinedMetricSpecification(const Aws::Utils::Xml::XmlNode& xmlNode);
PredefinedMetricSpecification& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const;
void OutputToStream(Aws::OStream& oStream, const char* location) const;
/**
* <p>The metric type. The following predefined metrics are available:</p> <ul>
* <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the
* Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> -
* Average number of bytes received on all network interfaces by the Auto Scaling
* group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of
* bytes sent out on all network interfaces by the Auto Scaling group.</p> </li>
* <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed
* per target in an Application Load Balancer target group.</p> </li> </ul>
*/
inline const MetricType& GetPredefinedMetricType() const{ return m_predefinedMetricType; }
/**
* <p>The metric type. The following predefined metrics are available:</p> <ul>
* <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the
* Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> -
* Average number of bytes received on all network interfaces by the Auto Scaling
* group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of
* bytes sent out on all network interfaces by the Auto Scaling group.</p> </li>
* <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed
* per target in an Application Load Balancer target group.</p> </li> </ul>
*/
inline bool PredefinedMetricTypeHasBeenSet() const { return m_predefinedMetricTypeHasBeenSet; }
/**
* <p>The metric type. The following predefined metrics are available:</p> <ul>
* <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the
* Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> -
* Average number of bytes received on all network interfaces by the Auto Scaling
* group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of
* bytes sent out on all network interfaces by the Auto Scaling group.</p> </li>
* <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed
* per target in an Application Load Balancer target group.</p> </li> </ul>
*/
inline void SetPredefinedMetricType(const MetricType& value) { m_predefinedMetricTypeHasBeenSet = true; m_predefinedMetricType = value; }
/**
* <p>The metric type. The following predefined metrics are available:</p> <ul>
* <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the
* Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> -
* Average number of bytes received on all network interfaces by the Auto Scaling
* group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of
* bytes sent out on all network interfaces by the Auto Scaling group.</p> </li>
* <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed
* per target in an Application Load Balancer target group.</p> </li> </ul>
*/
inline void SetPredefinedMetricType(MetricType&& value) { m_predefinedMetricTypeHasBeenSet = true; m_predefinedMetricType = std::move(value); }
/**
* <p>The metric type. The following predefined metrics are available:</p> <ul>
* <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the
* Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> -
* Average number of bytes received on all network interfaces by the Auto Scaling
* group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of
* bytes sent out on all network interfaces by the Auto Scaling group.</p> </li>
* <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed
* per target in an Application Load Balancer target group.</p> </li> </ul>
*/
inline PredefinedMetricSpecification& WithPredefinedMetricType(const MetricType& value) { SetPredefinedMetricType(value); return *this;}
/**
* <p>The metric type. The following predefined metrics are available:</p> <ul>
* <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the
* Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> -
* Average number of bytes received on all network interfaces by the Auto Scaling
* group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of
* bytes sent out on all network interfaces by the Auto Scaling group.</p> </li>
* <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed
* per target in an Application Load Balancer target group.</p> </li> </ul>
*/
inline PredefinedMetricSpecification& WithPredefinedMetricType(MetricType&& value) { SetPredefinedMetricType(std::move(value)); return *this;}
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline const Aws::String& GetResourceLabel() const{ return m_resourceLabel; }
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline bool ResourceLabelHasBeenSet() const { return m_resourceLabelHasBeenSet; }
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline void SetResourceLabel(const Aws::String& value) { m_resourceLabelHasBeenSet = true; m_resourceLabel = value; }
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline void SetResourceLabel(Aws::String&& value) { m_resourceLabelHasBeenSet = true; m_resourceLabel = std::move(value); }
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline void SetResourceLabel(const char* value) { m_resourceLabelHasBeenSet = true; m_resourceLabel.assign(value); }
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline PredefinedMetricSpecification& WithResourceLabel(const Aws::String& value) { SetResourceLabel(value); return *this;}
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline PredefinedMetricSpecification& WithResourceLabel(Aws::String&& value) { SetResourceLabel(std::move(value)); return *this;}
/**
* <p>Identifies the resource associated with the metric type. You can't specify a
* resource label unless the metric type is <code>ALBRequestCountPerTarget</code>
* and there is a target group attached to the Auto Scaling group.</p> <p>Elastic
* Load Balancing sends data about your load balancers to Amazon CloudWatch.
* CloudWatch collects the data and specifies the format to use to access the data.
* The format is
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i>
* </code>, where </p> <ul> <li> <p>
* <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final
* portion of the load balancer ARN, and</p> </li> <li> <p>
* <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the
* final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an
* Application Load Balancer, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a>
* API operation. To find the ARN for the target group, use the <a
* href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a>
* API operation.</p>
*/
inline PredefinedMetricSpecification& WithResourceLabel(const char* value) { SetResourceLabel(value); return *this;}
private:
MetricType m_predefinedMetricType;
bool m_predefinedMetricTypeHasBeenSet;
Aws::String m_resourceLabel;
bool m_resourceLabelHasBeenSet;
};
} // namespace Model
} // namespace AutoScaling
} // namespace Aws