« blib/lib/Paws/AutoScaling/SetDesiredCapacity.pm
↑ Summary
blib/lib/Paws/AutoScaling/SetInstanceProtection.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::SetInstanceHealth; | ||
| 3 | use Moose; | ||
| 4 | has HealthStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has InstanceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ShouldRespectGracePeriod => (is => 'ro', isa => 'Bool'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetInstanceHealth'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::AutoScaling::SetInstanceHealth - Arguments for method SetInstanceHealth on L<Paws::AutoScaling> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method SetInstanceHealth on the | ||
| 24 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 25 | as arguments to method SetInstanceHealth. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetInstanceHealth. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 32 | # To set the health status of an instance | ||
| 33 | # This example sets the health status of the specified instance to Unhealthy. | ||
| 34 | $autoscaling->SetInstanceHealth( | ||
| 35 | 'HealthStatus' => 'Unhealthy', | ||
| 36 | 'InstanceId' => 'i-93633f9b' | ||
| 37 | ); | ||
| 38 | |||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/SetInstanceHealth> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> HealthStatus => Str | ||
| 47 | |||
| 48 | The health status of the instance. Set to C<Healthy> to have the | ||
| 49 | instance remain in service. Set to C<Unhealthy> to have the instance be | ||
| 50 | out of service. Amazon EC2 Auto Scaling terminates and replaces the | ||
| 51 | unhealthy instance. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> InstanceId => Str | ||
| 56 | |||
| 57 | The ID of the instance. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 ShouldRespectGracePeriod => Bool | ||
| 62 | |||
| 63 | If the Auto Scaling group of the specified instance has a | ||
| 64 | C<HealthCheckGracePeriod> specified for the group, by default, this | ||
| 65 | call respects the grace period. Set this to C<False>, to have the call | ||
| 66 | not respect the grace period associated with the group. | ||
| 67 | |||
| 68 | For more information about the health check grace period, see | ||
| 69 | CreateAutoScalingGroup | ||
| 70 | (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html) | ||
| 71 | in the I<Amazon EC2 Auto Scaling API Reference>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, documenting arguments for method SetInstanceHealth in L<Paws::AutoScaling> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |