« blib/lib/Paws/AutoScaling/EnableMetricsCollection.pm
↑ Summary
blib/lib/Paws/AutoScaling/EnterStandbyAnswer.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::EnterStandby; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has InstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has ShouldDecrementDesiredCapacity => (is => 'ro', isa => 'Bool', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'EnterStandby'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AutoScaling::EnterStandbyAnswer'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'EnterStandbyResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::AutoScaling::EnterStandby - Arguments for method EnterStandby on L<Paws::AutoScaling> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method EnterStandby on the | ||
| 24 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 25 | as arguments to method EnterStandby. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to EnterStandby. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 32 | # To move instances into standby mode | ||
| 33 | # This example puts the specified instance into standby mode. | ||
| 34 | my $EnterStandbyAnswer = $autoscaling->EnterStandby( | ||
| 35 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 36 | 'InstanceIds' => ['i-93633f9b'], | ||
| 37 | 'ShouldDecrementDesiredCapacity' => 1 | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $Activities = $EnterStandbyAnswer->Activities; | ||
| 42 | |||
| 43 | # Returns a L<Paws::AutoScaling::EnterStandbyAnswer> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/EnterStandby> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> AutoScalingGroupName => Str | ||
| 52 | |||
| 53 | The name of the Auto Scaling group. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 InstanceIds => ArrayRef[Str|Undef] | ||
| 58 | |||
| 59 | The IDs of the instances. You can specify up to 20 instances. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> ShouldDecrementDesiredCapacity => Bool | ||
| 64 | |||
| 65 | Indicates whether to decrement the desired capacity of the Auto Scaling | ||
| 66 | group by the number of instances moved to C<Standby> mode. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method EnterStandby in L<Paws::AutoScaling> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |