« blib/lib/Paws/ApplicationAutoScaling/MetricDimension.pm
↑ Summary
blib/lib/Paws/ApplicationAutoScaling/PutScalingPolicy.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApplicationAutoScaling::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::ApplicationAutoScaling::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::ApplicationAutoScaling::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::ApplicationAutoScaling::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 Application Auto Scaling. | ||
| 39 | |||
| 40 | Only the AWS services that you're using send metrics to Amazon | ||
| 41 | CloudWatch. To determine whether a desired metric already exists by | ||
| 42 | looking up its namespace and dimension using the CloudWatch metrics | ||
| 43 | dashboard in the console, follow the procedure in Building dashboards | ||
| 44 | with CloudWatch | ||
| 45 | (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html) | ||
| 46 | in the I<Application Auto Scaling User Guide>. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> PredefinedMetricType => Str | ||
| 52 | |||
| 53 | The metric type. The C<ALBRequestCountPerTarget> metric type applies | ||
| 54 | only to Spot Fleet requests and ECS services. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ResourceLabel => Str | ||
| 58 | |||
| 59 | Identifies the resource associated with the metric type. You can't | ||
| 60 | specify a resource label unless the metric type is | ||
| 61 | C<ALBRequestCountPerTarget> and there is a target group attached to the | ||
| 62 | Spot Fleet request or ECS service. | ||
| 63 | |||
| 64 | You create the resource label by appending the final portion of the | ||
| 65 | load balancer ARN and the final portion of the target group ARN into a | ||
| 66 | single value, separated by a forward slash (/). The format is | ||
| 67 | 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>, | ||
| 68 | where: | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | app/E<lt>load-balancer-nameE<gt>/E<lt>load-balancer-idE<gt> is the | ||
| 75 | final portion of the load balancer ARN | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | targetgroup/E<lt>target-group-nameE<gt>/E<lt>target-group-idE<gt> is | ||
| 80 | the final portion of the target group ARN. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | This is an example: | ||
| 85 | app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. | ||
| 86 | |||
| 87 | To find the ARN for an Application Load Balancer, use the | ||
| 88 | DescribeLoadBalancers | ||
| 89 | (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) | ||
| 90 | API operation. To find the ARN for the target group, use the | ||
| 91 | DescribeTargetGroups | ||
| 92 | (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) | ||
| 93 | API operation. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, describing an object used in L<Paws::ApplicationAutoScaling> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |