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

#include <PredictiveScalingPredefinedScalingMetric.h>

Public Member Functions

 PredictiveScalingPredefinedScalingMetric ()
 
 PredictiveScalingPredefinedScalingMetric (const Aws::Utils::Xml::XmlNode &xmlNode)
 
PredictiveScalingPredefinedScalingMetricoperator= (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 PredefinedScalingMetricTypeGetPredefinedMetricType () const
 
bool PredefinedMetricTypeHasBeenSet () const
 
void SetPredefinedMetricType (const PredefinedScalingMetricType &value)
 
void SetPredefinedMetricType (PredefinedScalingMetricType &&value)
 
PredictiveScalingPredefinedScalingMetricWithPredefinedMetricType (const PredefinedScalingMetricType &value)
 
PredictiveScalingPredefinedScalingMetricWithPredefinedMetricType (PredefinedScalingMetricType &&value)
 
const Aws::StringGetResourceLabel () const
 
bool ResourceLabelHasBeenSet () const
 
void SetResourceLabel (const Aws::String &value)
 
void SetResourceLabel (Aws::String &&value)
 
void SetResourceLabel (const char *value)
 
PredictiveScalingPredefinedScalingMetricWithResourceLabel (const Aws::String &value)
 
PredictiveScalingPredefinedScalingMetricWithResourceLabel (Aws::String &&value)
 
PredictiveScalingPredefinedScalingMetricWithResourceLabel (const char *value)
 

Detailed Description

Describes a scaling metric for a predictive scaling policy.

When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.

See Also:

AWS API Reference

Definition at line 35 of file PredictiveScalingPredefinedScalingMetric.h.

Constructor & Destructor Documentation

◆ PredictiveScalingPredefinedScalingMetric() [1/2]

Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::PredictiveScalingPredefinedScalingMetric ( )

◆ PredictiveScalingPredefinedScalingMetric() [2/2]

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

Member Function Documentation

◆ GetPredefinedMetricType()

const PredefinedScalingMetricType& Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::GetPredefinedMetricType ( ) const
inline

The metric type.

Definition at line 49 of file PredictiveScalingPredefinedScalingMetric.h.

◆ GetResourceLabel()

const Aws::String& Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 97 of file PredictiveScalingPredefinedScalingMetric.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PredefinedMetricTypeHasBeenSet()

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

The metric type.

Definition at line 54 of file PredictiveScalingPredefinedScalingMetric.h.

◆ ResourceLabelHasBeenSet()

bool Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 119 of file PredictiveScalingPredefinedScalingMetric.h.

◆ SetPredefinedMetricType() [1/2]

void Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::SetPredefinedMetricType ( const PredefinedScalingMetricType value)
inline

The metric type.

Definition at line 59 of file PredictiveScalingPredefinedScalingMetric.h.

◆ SetPredefinedMetricType() [2/2]

void Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::SetPredefinedMetricType ( PredefinedScalingMetricType &&  value)
inline

The metric type.

Definition at line 64 of file PredictiveScalingPredefinedScalingMetric.h.

◆ SetResourceLabel() [1/3]

void Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 163 of file PredictiveScalingPredefinedScalingMetric.h.

◆ SetResourceLabel() [2/3]

void Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 141 of file PredictiveScalingPredefinedScalingMetric.h.

◆ SetResourceLabel() [3/3]

void Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 185 of file PredictiveScalingPredefinedScalingMetric.h.

◆ WithPredefinedMetricType() [1/2]

PredictiveScalingPredefinedScalingMetric& Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::WithPredefinedMetricType ( const PredefinedScalingMetricType value)
inline

The metric type.

Definition at line 69 of file PredictiveScalingPredefinedScalingMetric.h.

◆ WithPredefinedMetricType() [2/2]

PredictiveScalingPredefinedScalingMetric& Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::WithPredefinedMetricType ( PredefinedScalingMetricType &&  value)
inline

The metric type.

Definition at line 74 of file PredictiveScalingPredefinedScalingMetric.h.

◆ WithResourceLabel() [1/3]

PredictiveScalingPredefinedScalingMetric& Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 229 of file PredictiveScalingPredefinedScalingMetric.h.

◆ WithResourceLabel() [2/3]

PredictiveScalingPredefinedScalingMetric& Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 207 of file PredictiveScalingPredefinedScalingMetric.h.

◆ WithResourceLabel() [3/3]

PredictiveScalingPredefinedScalingMetric& Aws::AutoScaling::Model::PredictiveScalingPredefinedScalingMetric::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 251 of file PredictiveScalingPredefinedScalingMetric.h.


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