« blib/lib/Paws/ApplicationAutoScaling/SuspendedState.pm
↑ Summary
blib/lib/Paws/ApplicationCostProfiler/DeleteReportDefinition.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has CustomizedMetricSpecification => (is => 'ro', isa => 'Paws::ApplicationAutoScaling::CustomizedMetricSpecification'); | ||
| 5 | has DisableScaleIn => (is => 'ro', isa => 'Bool'); | ||
| 6 | has PredefinedMetricSpecification => (is => 'ro', isa => 'Paws::ApplicationAutoScaling::PredefinedMetricSpecification'); | ||
| 7 | has ScaleInCooldown => (is => 'ro', isa => 'Int'); | ||
| 8 | has ScaleOutCooldown => (is => 'ro', isa => 'Int'); | ||
| 9 | has TargetValue => (is => 'ro', isa => 'Num', required => 1); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { CustomizedMetricSpecification => $value, ..., TargetValue => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->CustomizedMetricSpecification | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Represents a target tracking scaling policy configuration to use with | ||
| 42 | Application Auto Scaling. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 CustomizedMetricSpecification => L<Paws::ApplicationAutoScaling::CustomizedMetricSpecification> | ||
| 48 | |||
| 49 | A customized metric. You can specify either a predefined metric or a | ||
| 50 | customized metric. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 DisableScaleIn => Bool | ||
| 54 | |||
| 55 | Indicates whether scale in by the target tracking scaling policy is | ||
| 56 | disabled. If the value is C<true>, scale in is disabled and the target | ||
| 57 | tracking scaling policy won't remove capacity from the scalable target. | ||
| 58 | Otherwise, scale in is enabled and the target tracking scaling policy | ||
| 59 | can remove capacity from the scalable target. The default value is | ||
| 60 | C<false>. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 PredefinedMetricSpecification => L<Paws::ApplicationAutoScaling::PredefinedMetricSpecification> | ||
| 64 | |||
| 65 | A predefined metric. You can specify either a predefined metric or a | ||
| 66 | customized metric. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ScaleInCooldown => Int | ||
| 70 | |||
| 71 | The amount of time, in seconds, after a scale-in activity completes | ||
| 72 | before another scale-in activity can start. | ||
| 73 | |||
| 74 | With the I<scale-in cooldown period>, the intention is to scale in | ||
| 75 | conservatively to protect your applicationE<rsquo>s availability, so | ||
| 76 | scale-in activities are blocked until the cooldown period has expired. | ||
| 77 | However, if another alarm triggers a scale-out activity during the | ||
| 78 | scale-in cooldown period, Application Auto Scaling scales out the | ||
| 79 | target immediately. In this case, the scale-in cooldown period stops | ||
| 80 | and doesn't complete. | ||
| 81 | |||
| 82 | Application Auto Scaling provides a default value of 300 for the | ||
| 83 | following scalable targets: | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | ECS services | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Spot Fleet requests | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | EMR clusters | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | AppStream 2.0 fleets | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | Aurora DB clusters | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | Amazon SageMaker endpoint variants | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | Custom resources | ||
| 114 | |||
| 115 | =back | ||
| 116 | |||
| 117 | For all other scalable targets, the default value is 0: | ||
| 118 | |||
| 119 | =over | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | DynamoDB tables | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | DynamoDB global secondary indexes | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | Amazon Comprehend document classification and entity recognizer | ||
| 132 | endpoints | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | Lambda provisioned concurrency | ||
| 137 | |||
| 138 | =item * | ||
| 139 | |||
| 140 | Amazon Keyspaces tables | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | Amazon MSK broker storage | ||
| 145 | |||
| 146 | =back | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 ScaleOutCooldown => Int | ||
| 151 | |||
| 152 | The amount of time, in seconds, to wait for a previous scale-out | ||
| 153 | activity to take effect. | ||
| 154 | |||
| 155 | With the I<scale-out cooldown period>, the intention is to continuously | ||
| 156 | (but not excessively) scale out. After Application Auto Scaling | ||
| 157 | successfully scales out using a target tracking scaling policy, it | ||
| 158 | starts to calculate the cooldown time. The scaling policy won't | ||
| 159 | increase the desired capacity again unless either a larger scale out is | ||
| 160 | triggered or the cooldown period ends. While the cooldown period is in | ||
| 161 | effect, the capacity added by the initiating scale-out activity is | ||
| 162 | calculated as part of the desired capacity for the next scale-out | ||
| 163 | activity. | ||
| 164 | |||
| 165 | Application Auto Scaling provides a default value of 300 for the | ||
| 166 | following scalable targets: | ||
| 167 | |||
| 168 | =over | ||
| 169 | |||
| 170 | =item * | ||
| 171 | |||
| 172 | ECS services | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | Spot Fleet requests | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | EMR clusters | ||
| 181 | |||
| 182 | =item * | ||
| 183 | |||
| 184 | AppStream 2.0 fleets | ||
| 185 | |||
| 186 | =item * | ||
| 187 | |||
| 188 | Aurora DB clusters | ||
| 189 | |||
| 190 | =item * | ||
| 191 | |||
| 192 | Amazon SageMaker endpoint variants | ||
| 193 | |||
| 194 | =item * | ||
| 195 | |||
| 196 | Custom resources | ||
| 197 | |||
| 198 | =back | ||
| 199 | |||
| 200 | For all other scalable targets, the default value is 0: | ||
| 201 | |||
| 202 | =over | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | DynamoDB tables | ||
| 207 | |||
| 208 | =item * | ||
| 209 | |||
| 210 | DynamoDB global secondary indexes | ||
| 211 | |||
| 212 | =item * | ||
| 213 | |||
| 214 | Amazon Comprehend document classification and entity recognizer | ||
| 215 | endpoints | ||
| 216 | |||
| 217 | =item * | ||
| 218 | |||
| 219 | Lambda provisioned concurrency | ||
| 220 | |||
| 221 | =item * | ||
| 222 | |||
| 223 | Amazon Keyspaces tables | ||
| 224 | |||
| 225 | =item * | ||
| 226 | |||
| 227 | Amazon MSK broker storage | ||
| 228 | |||
| 229 | =back | ||
| 230 | |||
| 231 | |||
| 232 | |||
| 233 | =head2 B<REQUIRED> TargetValue => Num | ||
| 234 | |||
| 235 | The target value for the metric. Although this property accepts numbers | ||
| 236 | of type Double, it won't accept values that are either too small or too | ||
| 237 | large. Values must be in the range of -2^360 to 2^360. The value must | ||
| 238 | be a valid number based on the choice of metric. For example, if the | ||
| 239 | metric is CPU utilization, then the target value is a percent value | ||
| 240 | that represents how much of the CPU can be used before scaling out. | ||
| 241 | |||
| 242 | |||
| 243 | |||
| 244 | =head1 SEE ALSO | ||
| 245 | |||
| 246 | This class forms part of L<Paws>, describing an object used in L<Paws::ApplicationAutoScaling> | ||
| 247 | |||
| 248 | =head1 BUGS and CONTRIBUTIONS | ||
| 249 | |||
| 250 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 251 | |||
| 252 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 253 | |||
| 254 | =cut | ||
| 255 |