« blib/lib/Paws/AutoScaling/PredefinedMetricSpecification.pm
↑ Summary
blib/lib/Paws/AutoScaling/PredictiveScalingMetricSpecification.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::PredictiveScalingConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has MaxCapacityBreachBehavior => (is => 'ro', isa => 'Str'); | ||
| 5 | has MaxCapacityBuffer => (is => 'ro', isa => 'Int'); | ||
| 6 | has MetricSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::AutoScaling::PredictiveScalingMetricSpecification]', required => 1); | ||
| 7 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 8 | has SchedulingBufferTime => (is => 'ro', isa => 'Int'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::AutoScaling::PredictiveScalingConfiguration | ||
| 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::AutoScaling::PredictiveScalingConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { MaxCapacityBreachBehavior => $value, ..., SchedulingBufferTime => $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::AutoScaling::PredictiveScalingConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->MaxCapacityBreachBehavior | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Represents a predictive scaling policy configuration to use with Amazon | ||
| 41 | EC2 Auto Scaling. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 MaxCapacityBreachBehavior => Str | ||
| 47 | |||
| 48 | Defines the behavior that should be applied if the forecast capacity | ||
| 49 | approaches or exceeds the maximum capacity of the Auto Scaling group. | ||
| 50 | Defaults to C<HonorMaxCapacity> if not specified. | ||
| 51 | |||
| 52 | The following are possible values: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<HonorMaxCapacity> - Amazon EC2 Auto Scaling cannot scale out capacity | ||
| 59 | higher than the maximum capacity. The maximum capacity is enforced as a | ||
| 60 | hard limit. | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | C<IncreaseMaxCapacity> - Amazon EC2 Auto Scaling can scale out capacity | ||
| 65 | higher than the maximum capacity when the forecast capacity is close to | ||
| 66 | or exceeds the maximum capacity. The upper limit is determined by the | ||
| 67 | forecasted capacity and the value for C<MaxCapacityBuffer>. | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 MaxCapacityBuffer => Int | ||
| 74 | |||
| 75 | The size of the capacity buffer to use when the forecast capacity is | ||
| 76 | close to or exceeds the maximum capacity. The value is specified as a | ||
| 77 | percentage relative to the forecast capacity. For example, if the | ||
| 78 | buffer is 10, this means a 10 percent buffer, such that if the forecast | ||
| 79 | capacity is 50, and the maximum capacity is 40, then the effective | ||
| 80 | maximum capacity is 55. | ||
| 81 | |||
| 82 | If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the | ||
| 83 | maximum capacity to equal but not exceed forecast capacity. | ||
| 84 | |||
| 85 | Required if the C<MaxCapacityBreachBehavior> property is set to | ||
| 86 | C<IncreaseMaxCapacity>, and cannot be used otherwise. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> MetricSpecifications => ArrayRef[L<Paws::AutoScaling::PredictiveScalingMetricSpecification>] | ||
| 90 | |||
| 91 | This structure includes the metrics and target utilization to use for | ||
| 92 | predictive scaling. | ||
| 93 | |||
| 94 | This is an array, but we currently only support a single metric | ||
| 95 | specification. That is, you can specify a target value and a single | ||
| 96 | metric pair, or a target value and one scaling metric and one load | ||
| 97 | metric. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 Mode => Str | ||
| 101 | |||
| 102 | The predictive scaling mode. Defaults to C<ForecastOnly> if not | ||
| 103 | specified. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 SchedulingBufferTime => Int | ||
| 107 | |||
| 108 | The amount of time, in seconds, by which the instance launch time can | ||
| 109 | be advanced. For example, the forecast says to add capacity at 10:00 | ||
| 110 | AM, and you choose to pre-launch instances by 5 minutes. In that case, | ||
| 111 | the instances will be launched at 9:55 AM. The intention is to give | ||
| 112 | resources time to be provisioned. It can take a few minutes to launch | ||
| 113 | an EC2 instance. The actual amount of time required depends on several | ||
| 114 | factors, such as the size of the instance and whether there are startup | ||
| 115 | scripts to complete. | ||
| 116 | |||
| 117 | The value must be less than the forecast interval duration of 3600 | ||
| 118 | seconds (60 minutes). Defaults to 300 seconds if not specified. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |