AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::AutoScaling::Model::PredefinedMetricSpecification Class Reference

#include <PredefinedMetricSpecification.h>

Public Member Functions

 PredefinedMetricSpecification ()
 
 PredefinedMetricSpecification (const Aws::Utils::Xml::XmlNode &xmlNode)
 
PredefinedMetricSpecificationoperator= (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
 
const MetricTypeGetPredefinedMetricType () const
 
bool PredefinedMetricTypeHasBeenSet () const
 
void SetPredefinedMetricType (const MetricType &value)
 
void SetPredefinedMetricType (MetricType &&value)
 
PredefinedMetricSpecificationWithPredefinedMetricType (const MetricType &value)
 
PredefinedMetricSpecificationWithPredefinedMetricType (MetricType &&value)
 
const Aws::StringGetResourceLabel () const
 
bool ResourceLabelHasBeenSet () const
 
void SetResourceLabel (const Aws::String &value)
 
void SetResourceLabel (Aws::String &&value)
 
void SetResourceLabel (const char *value)
 
PredefinedMetricSpecificationWithResourceLabel (const Aws::String &value)
 
PredefinedMetricSpecificationWithResourceLabel (Aws::String &&value)
 
PredefinedMetricSpecificationWithResourceLabel (const char *value)
 

Detailed Description

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

See Also:

AWS API Reference

Definition at line 33 of file PredefinedMetricSpecification.h.

Constructor & Destructor Documentation

◆ PredefinedMetricSpecification() [1/2]

Aws::AutoScaling::Model::PredefinedMetricSpecification::PredefinedMetricSpecification ( )

◆ PredefinedMetricSpecification() [2/2]

Aws::AutoScaling::Model::PredefinedMetricSpecification::PredefinedMetricSpecification ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ GetPredefinedMetricType()

const MetricType& Aws::AutoScaling::Model::PredefinedMetricSpecification::GetPredefinedMetricType ( ) const
inline

The metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

  • ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Definition at line 54 of file PredefinedMetricSpecification.h.

◆ GetResourceLabel()

const Aws::String& Aws::AutoScaling::Model::PredefinedMetricSpecification::GetResourceLabel ( ) const
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 137 of file PredefinedMetricSpecification.h.

◆ operator=()

PredefinedMetricSpecification& Aws::AutoScaling::Model::PredefinedMetricSpecification::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::AutoScaling::Model::PredefinedMetricSpecification::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::AutoScaling::Model::PredefinedMetricSpecification::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ PredefinedMetricTypeHasBeenSet()

bool Aws::AutoScaling::Model::PredefinedMetricSpecification::PredefinedMetricTypeHasBeenSet ( ) const
inline

The metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

  • ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Definition at line 66 of file PredefinedMetricSpecification.h.

◆ ResourceLabelHasBeenSet()

bool Aws::AutoScaling::Model::PredefinedMetricSpecification::ResourceLabelHasBeenSet ( ) const
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 159 of file PredefinedMetricSpecification.h.

◆ SetPredefinedMetricType() [1/2]

void Aws::AutoScaling::Model::PredefinedMetricSpecification::SetPredefinedMetricType ( const MetricType value)
inline

The metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

  • ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Definition at line 78 of file PredefinedMetricSpecification.h.

◆ SetPredefinedMetricType() [2/2]

void Aws::AutoScaling::Model::PredefinedMetricSpecification::SetPredefinedMetricType ( MetricType &&  value)
inline

The metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

  • ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Definition at line 90 of file PredefinedMetricSpecification.h.

◆ SetResourceLabel() [1/3]

void Aws::AutoScaling::Model::PredefinedMetricSpecification::SetResourceLabel ( Aws::String &&  value)
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 203 of file PredefinedMetricSpecification.h.

◆ SetResourceLabel() [2/3]

void Aws::AutoScaling::Model::PredefinedMetricSpecification::SetResourceLabel ( const Aws::String value)
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 181 of file PredefinedMetricSpecification.h.

◆ SetResourceLabel() [3/3]

void Aws::AutoScaling::Model::PredefinedMetricSpecification::SetResourceLabel ( const char *  value)
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 225 of file PredefinedMetricSpecification.h.

◆ WithPredefinedMetricType() [1/2]

PredefinedMetricSpecification& Aws::AutoScaling::Model::PredefinedMetricSpecification::WithPredefinedMetricType ( const MetricType value)
inline

The metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

  • ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Definition at line 102 of file PredefinedMetricSpecification.h.

◆ WithPredefinedMetricType() [2/2]

PredefinedMetricSpecification& Aws::AutoScaling::Model::PredefinedMetricSpecification::WithPredefinedMetricType ( MetricType &&  value)
inline

The metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

  • ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

Definition at line 114 of file PredefinedMetricSpecification.h.

◆ WithResourceLabel() [1/3]

PredefinedMetricSpecification& Aws::AutoScaling::Model::PredefinedMetricSpecification::WithResourceLabel ( Aws::String &&  value)
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 269 of file PredefinedMetricSpecification.h.

◆ WithResourceLabel() [2/3]

PredefinedMetricSpecification& Aws::AutoScaling::Model::PredefinedMetricSpecification::WithResourceLabel ( const Aws::String value)
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 247 of file PredefinedMetricSpecification.h.

◆ WithResourceLabel() [3/3]

PredefinedMetricSpecification& Aws::AutoScaling::Model::PredefinedMetricSpecification::WithResourceLabel ( const char *  value)
inline

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Definition at line 291 of file PredefinedMetricSpecification.h.


The documentation for this class was generated from the following file: