« blib/lib/Paws/AutoScalingPlans/CreateScalingPlanResponse.pm
↑ Summary
blib/lib/Paws/AutoScalingPlans/CustomizedScalingMetricSpecification.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScalingPlans::CustomizedLoadMetricSpecification; | ||
| 3 | use Moose; | ||
| 4 | has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::AutoScalingPlans::MetricDimension]'); | ||
| 5 | has MetricName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Namespace => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Statistic => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Unit => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::AutoScalingPlans::CustomizedLoadMetricSpecification | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::AutoScalingPlans::CustomizedLoadMetricSpecification object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Dimensions => $value, ..., Unit => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScalingPlans::CustomizedLoadMetricSpecification object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Dimensions | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Represents a CloudWatch metric of your choosing that can be used for | ||
| 41 | predictive scaling. | ||
| 42 | |||
| 43 | For predictive scaling to work with a customized load metric | ||
| 44 | specification, AWS Auto Scaling needs access to the C<Sum> and | ||
| 45 | C<Average> statistics that CloudWatch computes from metric data. | ||
| 46 | |||
| 47 | When you choose a load metric, make sure that the required C<Sum> and | ||
| 48 | C<Average> statistics for your metric are available in CloudWatch and | ||
| 49 | that they provide relevant data for predictive scaling. The C<Sum> | ||
| 50 | statistic must represent the total load on the resource, and the | ||
| 51 | C<Average> statistic must represent the average load per capacity unit | ||
| 52 | of the resource. For example, there is a metric that counts the number | ||
| 53 | of requests processed by your Auto Scaling group. If the C<Sum> | ||
| 54 | statistic represents the total request count processed by the group, | ||
| 55 | then the C<Average> statistic for the specified metric must represent | ||
| 56 | the average request count processed by each instance of the group. | ||
| 57 | |||
| 58 | If you publish your own metrics, you can aggregate the data points at a | ||
| 59 | given interval and then publish the aggregated data points to | ||
| 60 | CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up | ||
| 61 | all the metric data points that occurred within each hour to match the | ||
| 62 | granularity period that is used in the forecast (60 minutes). | ||
| 63 | |||
| 64 | For information about terminology, available metrics, or how to publish | ||
| 65 | new metrics, see Amazon CloudWatch Concepts | ||
| 66 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) | ||
| 67 | in the I<Amazon CloudWatch User Guide>. | ||
| 68 | |||
| 69 | After creating your scaling plan, you can use the AWS Auto Scaling | ||
| 70 | console to visualize forecasts for the specified metric. For more | ||
| 71 | information, see View Scaling Information for a Resource | ||
| 72 | (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) | ||
| 73 | in the I<AWS Auto Scaling User Guide>. | ||
| 74 | |||
| 75 | =head1 ATTRIBUTES | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Dimensions => ArrayRef[L<Paws::AutoScalingPlans::MetricDimension>] | ||
| 79 | |||
| 80 | The dimensions of the metric. | ||
| 81 | |||
| 82 | Conditional: If you published your metric with dimensions, you must | ||
| 83 | specify the same dimensions in your customized load metric | ||
| 84 | specification. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> MetricName => Str | ||
| 88 | |||
| 89 | The name of the metric. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> Namespace => Str | ||
| 93 | |||
| 94 | The namespace of the metric. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> Statistic => Str | ||
| 98 | |||
| 99 | The statistic of the metric. The only valid value is C<Sum>. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 Unit => Str | ||
| 103 | |||
| 104 | The unit of the metric. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScalingPlans> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |