« blib/lib/Paws/AutoScaling/TargetTrackingConfiguration.pm
↑ Summary
blib/lib/Paws/AutoScaling/UpdateAutoScalingGroup.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::TerminateInstanceInAutoScalingGroup; | ||
| 3 | use Moose; | ||
| 4 | has InstanceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ShouldDecrementDesiredCapacity => (is => 'ro', isa => 'Bool', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TerminateInstanceInAutoScalingGroup'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AutoScaling::ActivityType'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'TerminateInstanceInAutoScalingGroupResult'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::AutoScaling::TerminateInstanceInAutoScalingGroup - Arguments for method TerminateInstanceInAutoScalingGroup on L<Paws::AutoScaling> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method TerminateInstanceInAutoScalingGroup on the | ||
| 23 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 24 | as arguments to method TerminateInstanceInAutoScalingGroup. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TerminateInstanceInAutoScalingGroup. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 31 | # To terminate an instance in an Auto Scaling group | ||
| 32 | # This example terminates the specified instance from the specified Auto Scaling | ||
| 33 | # group without updating the size of the group. Auto Scaling launches a | ||
| 34 | # replacement instance after the specified instance terminates. | ||
| 35 | my $ActivityType = $autoscaling->TerminateInstanceInAutoScalingGroup( | ||
| 36 | 'InstanceId' => 'i-93633f9b', | ||
| 37 | 'ShouldDecrementDesiredCapacity' => 0 | ||
| 38 | ); | ||
| 39 | |||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/TerminateInstanceInAutoScalingGroup> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> InstanceId => Str | ||
| 48 | |||
| 49 | The ID of the instance. | ||
| 50 | |||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ShouldDecrementDesiredCapacity => Bool | ||
| 54 | |||
| 55 | Indicates whether terminating the instance also decrements the size of | ||
| 56 | the Auto Scaling group. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head1 SEE ALSO | ||
| 62 | |||
| 63 | This class forms part of L<Paws>, documenting arguments for method TerminateInstanceInAutoScalingGroup in L<Paws::AutoScaling> | ||
| 64 | |||
| 65 | =head1 BUGS and CONTRIBUTIONS | ||
| 66 | |||
| 67 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 68 | |||
| 69 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 70 | |||
| 71 | =cut | ||
| 72 |