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

#include <PredictiveScalingPredefinedMetricPair.h>

Public Member Functions

 PredictiveScalingPredefinedMetricPair ()
 
 PredictiveScalingPredefinedMetricPair (const Aws::Utils::Xml::XmlNode &xmlNode)
 
PredictiveScalingPredefinedMetricPairoperator= (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 PredefinedMetricPairTypeGetPredefinedMetricType () const
 
bool PredefinedMetricTypeHasBeenSet () const
 
void SetPredefinedMetricType (const PredefinedMetricPairType &value)
 
void SetPredefinedMetricType (PredefinedMetricPairType &&value)
 
PredictiveScalingPredefinedMetricPairWithPredefinedMetricType (const PredefinedMetricPairType &value)
 
PredictiveScalingPredefinedMetricPairWithPredefinedMetricType (PredefinedMetricPairType &&value)
 
const Aws::StringGetResourceLabel () const
 
bool ResourceLabelHasBeenSet () const
 
void SetResourceLabel (const Aws::String &value)
 
void SetResourceLabel (Aws::String &&value)
 
void SetResourceLabel (const char *value)
 
PredictiveScalingPredefinedMetricPairWithResourceLabel (const Aws::String &value)
 
PredictiveScalingPredefinedMetricPairWithResourceLabel (Aws::String &&value)
 
PredictiveScalingPredefinedMetricPairWithResourceLabel (const char *value)
 

Detailed Description

Represents a metric pair for a predictive scaling policy.

See Also:

AWS API Reference

Definition at line 33 of file PredictiveScalingPredefinedMetricPair.h.

Constructor & Destructor Documentation

◆ PredictiveScalingPredefinedMetricPair() [1/2]

Aws::AutoScaling::Model::PredictiveScalingPredefinedMetricPair::PredictiveScalingPredefinedMetricPair ( )

◆ PredictiveScalingPredefinedMetricPair() [2/2]

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

Member Function Documentation

◆ GetPredefinedMetricType()

const PredefinedMetricPairType& Aws::AutoScaling::Model::PredictiveScalingPredefinedMetricPair::GetPredefinedMetricType ( ) const
inline

Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

Definition at line 51 of file PredictiveScalingPredefinedMetricPair.h.

◆ GetResourceLabel()

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 119 of file PredictiveScalingPredefinedMetricPair.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PredefinedMetricTypeHasBeenSet()

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

Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

Definition at line 60 of file PredictiveScalingPredefinedMetricPair.h.

◆ ResourceLabelHasBeenSet()

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 141 of file PredictiveScalingPredefinedMetricPair.h.

◆ SetPredefinedMetricType() [1/2]

void Aws::AutoScaling::Model::PredictiveScalingPredefinedMetricPair::SetPredefinedMetricType ( const PredefinedMetricPairType value)
inline

Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

Definition at line 69 of file PredictiveScalingPredefinedMetricPair.h.

◆ SetPredefinedMetricType() [2/2]

void Aws::AutoScaling::Model::PredictiveScalingPredefinedMetricPair::SetPredefinedMetricType ( PredefinedMetricPairType &&  value)
inline

Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

Definition at line 78 of file PredictiveScalingPredefinedMetricPair.h.

◆ SetResourceLabel() [1/3]

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 185 of file PredictiveScalingPredefinedMetricPair.h.

◆ SetResourceLabel() [2/3]

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 163 of file PredictiveScalingPredefinedMetricPair.h.

◆ SetResourceLabel() [3/3]

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 207 of file PredictiveScalingPredefinedMetricPair.h.

◆ WithPredefinedMetricType() [1/2]

PredictiveScalingPredefinedMetricPair& Aws::AutoScaling::Model::PredictiveScalingPredefinedMetricPair::WithPredefinedMetricType ( const PredefinedMetricPairType value)
inline

Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

Definition at line 87 of file PredictiveScalingPredefinedMetricPair.h.

◆ WithPredefinedMetricType() [2/2]

PredictiveScalingPredefinedMetricPair& Aws::AutoScaling::Model::PredictiveScalingPredefinedMetricPair::WithPredefinedMetricType ( PredefinedMetricPairType &&  value)
inline

Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.

Definition at line 96 of file PredictiveScalingPredefinedMetricPair.h.

◆ WithResourceLabel() [1/3]

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 251 of file PredictiveScalingPredefinedMetricPair.h.

◆ WithResourceLabel() [2/3]

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 229 of file PredictiveScalingPredefinedMetricPair.h.

◆ WithResourceLabel() [3/3]

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

A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and 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 273 of file PredictiveScalingPredefinedMetricPair.h.


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