« blib/lib/Paws/AutoScaling/EnterStandbyAnswer.pm
↑ Summary
blib/lib/Paws/AutoScaling/ExitStandby.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::ExecutePolicy; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupName => (is => 'ro', isa => 'Str'); | ||
| 5 | has BreachThreshold => (is => 'ro', isa => 'Num'); | ||
| 6 | has HonorCooldown => (is => 'ro', isa => 'Bool'); | ||
| 7 | has MetricValue => (is => 'ro', isa => 'Num'); | ||
| 8 | has PolicyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExecutePolicy'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AutoScaling::ExecutePolicy - Arguments for method ExecutePolicy on L<Paws::AutoScaling> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ExecutePolicy on the | ||
| 26 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 27 | as arguments to method ExecutePolicy. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExecutePolicy. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 34 | # To execute a scaling policy | ||
| 35 | # This example executes the specified policy. | ||
| 36 | $autoscaling->ExecutePolicy( | ||
| 37 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 38 | 'BreachThreshold' => 50, | ||
| 39 | 'MetricValue' => 59, | ||
| 40 | 'PolicyName' => 'my-step-scale-out-policy' | ||
| 41 | ); | ||
| 42 | |||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/ExecutePolicy> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 AutoScalingGroupName => Str | ||
| 51 | |||
| 52 | The name of the Auto Scaling group. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 BreachThreshold => Num | ||
| 57 | |||
| 58 | The breach threshold for the alarm. | ||
| 59 | |||
| 60 | Required if the policy type is C<StepScaling> and not supported | ||
| 61 | otherwise. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 HonorCooldown => Bool | ||
| 66 | |||
| 67 | Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period | ||
| 68 | to complete before executing the policy. | ||
| 69 | |||
| 70 | Valid only if the policy type is C<SimpleScaling>. For more | ||
| 71 | information, see Scaling cooldowns for Amazon EC2 Auto Scaling | ||
| 72 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) | ||
| 73 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MetricValue => Num | ||
| 78 | |||
| 79 | The metric value to compare to C<BreachThreshold>. This enables you to | ||
| 80 | execute a policy of type C<StepScaling> and determine which step | ||
| 81 | adjustment to use. For example, if the breach threshold is 50 and you | ||
| 82 | want to use a step adjustment with a lower bound of 0 and an upper | ||
| 83 | bound of 10, you can set the metric value to 59. | ||
| 84 | |||
| 85 | If you specify a metric value that doesn't correspond to a step | ||
| 86 | adjustment for the policy, the call returns an error. | ||
| 87 | |||
| 88 | Required if the policy type is C<StepScaling> and not supported | ||
| 89 | otherwise. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> PolicyName => Str | ||
| 94 | |||
| 95 | The name or ARN of the policy. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, documenting arguments for method ExecutePolicy in L<Paws::AutoScaling> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |