| 1 | |||
| 2 | package Paws::AutoScaling::EnableMetricsCollection; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Granularity => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Metrics => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'EnableMetricsCollection'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::AutoScaling::EnableMetricsCollection - Arguments for method EnableMetricsCollection on L<Paws::AutoScaling> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method EnableMetricsCollection on the | ||
| 24 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 25 | as arguments to method EnableMetricsCollection. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to EnableMetricsCollection. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 32 | # To enable metrics collection for an Auto Scaling group | ||
| 33 | # This example enables data collection for the specified Auto Scaling group. | ||
| 34 | $autoscaling->EnableMetricsCollection( | ||
| 35 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 36 | 'Granularity' => '1Minute' | ||
| 37 | ); | ||
| 38 | |||
| 39 | |||
| 40 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/EnableMetricsCollection> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> AutoScalingGroupName => Str | ||
| 47 | |||
| 48 | The name of the Auto Scaling group. | ||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> Granularity => Str | ||
| 53 | |||
| 54 | The granularity to associate with the metrics to collect. The only | ||
| 55 | valid value is C<1Minute>. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 Metrics => ArrayRef[Str|Undef] | ||
| 60 | |||
| 61 | Specifies which group-level metrics to start collecting. You can | ||
| 62 | specify one or more of the following metrics: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<GroupMinSize> | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<GroupMaxSize> | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<GroupDesiredCapacity> | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<GroupInServiceInstances> | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<GroupPendingInstances> | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<GroupStandbyInstances> | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<GroupTerminatingInstances> | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<GroupTotalInstances> | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | The instance weighting feature supports the following additional | ||
| 101 | metrics: | ||
| 102 | |||
| 103 | =over | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<GroupInServiceCapacity> | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<GroupPendingCapacity> | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<GroupStandbyCapacity> | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<GroupTerminatingCapacity> | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<GroupTotalCapacity> | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | The warm pools feature supports the following additional metrics: | ||
| 128 | |||
| 129 | =over | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | C<WarmPoolDesiredCapacity> | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | C<WarmPoolWarmedCapacity> | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | C<WarmPoolPendingCapacity> | ||
| 142 | |||
| 143 | =item * | ||
| 144 | |||
| 145 | C<WarmPoolTerminatingCapacity> | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | C<WarmPoolTotalCapacity> | ||
| 150 | |||
| 151 | =item * | ||
| 152 | |||
| 153 | C<GroupAndWarmPoolDesiredCapacity> | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<GroupAndWarmPoolTotalCapacity> | ||
| 158 | |||
| 159 | =back | ||
| 160 | |||
| 161 | If you omit this parameter, all metrics are enabled. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head1 SEE ALSO | ||
| 167 | |||
| 168 | This class forms part of L<Paws>, documenting arguments for method EnableMetricsCollection in L<Paws::AutoScaling> | ||
| 169 | |||
| 170 | =head1 BUGS and CONTRIBUTIONS | ||
| 171 | |||
| 172 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 173 | |||
| 174 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 175 | |||
| 176 | =cut | ||
| 177 |