« blib/lib/Paws/AutoScalingPlans/MetricDimension.pm
↑ Summary
blib/lib/Paws/AutoScalingPlans/PredefinedScalingMetricSpecification.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScalingPlans::PredefinedLoadMetricSpecification; | ||
| 3 | use Moose; | ||
| 4 | has PredefinedLoadMetricType => (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::AutoScalingPlans::PredefinedLoadMetricSpecification | ||
| 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::AutoScalingPlans::PredefinedLoadMetricSpecification object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { PredefinedLoadMetricType => $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::AutoScalingPlans::PredefinedLoadMetricSpecification object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->PredefinedLoadMetricType | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Represents a predefined metric that can be used for predictive scaling. | ||
| 38 | |||
| 39 | After creating your scaling plan, you can use the AWS Auto Scaling | ||
| 40 | console to visualize forecasts for the specified metric. For more | ||
| 41 | information, see View Scaling Information for a Resource | ||
| 42 | (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) | ||
| 43 | in the I<AWS Auto Scaling User Guide>. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> PredefinedLoadMetricType => Str | ||
| 49 | |||
| 50 | The metric type. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ResourceLabel => Str | ||
| 54 | |||
| 55 | Identifies the resource associated with the metric type. You can't | ||
| 56 | specify a resource label unless the metric type is | ||
| 57 | C<ALBTargetGroupRequestCount> and there is a target group for an | ||
| 58 | Application Load Balancer attached to the Auto Scaling group. | ||
| 59 | |||
| 60 | You create the resource label by appending the final portion of the | ||
| 61 | load balancer ARN and the final portion of the target group ARN into a | ||
| 62 | single value, separated by a forward slash (/). The format is | ||
| 63 | app/E<lt>load-balancer-nameE<gt>/E<lt>load-balancer-idE<gt>/targetgroup/E<lt>target-group-nameE<gt>/E<lt>target-group-idE<gt>, | ||
| 64 | where: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | app/E<lt>load-balancer-nameE<gt>/E<lt>load-balancer-idE<gt> is the | ||
| 71 | final portion of the load balancer ARN | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | targetgroup/E<lt>target-group-nameE<gt>/E<lt>target-group-idE<gt> is | ||
| 76 | the final portion of the target group ARN. | ||
| 77 | |||
| 78 | =back | ||
| 79 | |||
| 80 | This is an example: | ||
| 81 | app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. | ||
| 82 | |||
| 83 | To find the ARN for an Application Load Balancer, use the | ||
| 84 | DescribeLoadBalancers | ||
| 85 | (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) | ||
| 86 | API operation. To find the ARN for the target group, use the | ||
| 87 | DescribeTargetGroups | ||
| 88 | (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) | ||
| 89 | API operation. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScalingPlans> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |