« blib/lib/Paws/AutoScaling/PolicyARNType.pm
↑ Summary
blib/lib/Paws/AutoScaling/PredictiveScalingConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::PredefinedMetricSpecification; | ||
| 3 | use Moose; | ||
| 4 | has PredefinedMetricType => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ResourceLabel => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::AutoScaling::PredefinedMetricSpecification | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::AutoScaling::PredefinedMetricSpecification object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { PredefinedMetricType => $value, ..., ResourceLabel => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::PredefinedMetricSpecification object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->PredefinedMetricType | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Represents a predefined metric for a target tracking scaling policy to | ||
| 38 | use with Amazon EC2 Auto Scaling. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> PredefinedMetricType => Str | ||
| 44 | |||
| 45 | The metric type. The following predefined metrics are available: | ||
| 46 | |||
| 47 | =over | ||
| 48 | |||
| 49 | =item * | ||
| 50 | |||
| 51 | C<ASGAverageCPUUtilization> - Average CPU utilization of the Auto | ||
| 52 | Scaling group. | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | C<ASGAverageNetworkIn> - Average number of bytes received on all | ||
| 57 | network interfaces by the Auto Scaling group. | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | C<ASGAverageNetworkOut> - Average number of bytes sent out on all | ||
| 62 | network interfaces by the Auto Scaling group. | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<ALBRequestCountPerTarget> - Number of requests completed per target | ||
| 67 | in an Application Load Balancer target group. | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ResourceLabel => Str | ||
| 74 | |||
| 75 | A label that uniquely identifies a specific Application Load Balancer | ||
| 76 | target group from which to determine the average request count served | ||
| 77 | by your Auto Scaling group. You can't specify a resource label unless | ||
| 78 | the target group is attached to the Auto Scaling group. | ||
| 79 | |||
| 80 | You create the resource label by appending the final portion of the | ||
| 81 | load balancer ARN and the final portion of the target group ARN into a | ||
| 82 | single value, separated by a forward slash (/). The format of the | ||
| 83 | resource label is: | ||
| 84 | |||
| 85 | C<app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff>. | ||
| 86 | |||
| 87 | Where: | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | app/E<lt>load-balancer-nameE<gt>/E<lt>load-balancer-idE<gt> is the | ||
| 94 | final portion of the load balancer ARN | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | targetgroup/E<lt>target-group-nameE<gt>/E<lt>target-group-idE<gt> is | ||
| 99 | the final portion of the target group ARN. | ||
| 100 | |||
| 101 | =back | ||
| 102 | |||
| 103 | To find the ARN for an Application Load Balancer, use the | ||
| 104 | DescribeLoadBalancers | ||
| 105 | (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) | ||
| 106 | API operation. To find the ARN for the target group, use the | ||
| 107 | DescribeTargetGroups | ||
| 108 | (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) | ||
| 109 | API operation. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |