« blib/lib/Paws/Lightsail/ContainerServiceEndpoint.pm
↑ Summary
blib/lib/Paws/Lightsail/ContainerServiceLogEvent.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::ContainerServiceHealthCheckConfig; | ||
| 3 | use Moose; | ||
| 4 | has HealthyThreshold => (is => 'ro', isa => 'Int', request_name => 'healthyThreshold', traits => ['NameInRequest']); | ||
| 5 | has IntervalSeconds => (is => 'ro', isa => 'Int', request_name => 'intervalSeconds', traits => ['NameInRequest']); | ||
| 6 | has Path => (is => 'ro', isa => 'Str', request_name => 'path', traits => ['NameInRequest']); | ||
| 7 | has SuccessCodes => (is => 'ro', isa => 'Str', request_name => 'successCodes', traits => ['NameInRequest']); | ||
| 8 | has TimeoutSeconds => (is => 'ro', isa => 'Int', request_name => 'timeoutSeconds', traits => ['NameInRequest']); | ||
| 9 | has UnhealthyThreshold => (is => 'ro', isa => 'Int', request_name => 'unhealthyThreshold', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Lightsail::ContainerServiceHealthCheckConfig | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Lightsail::ContainerServiceHealthCheckConfig object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { HealthyThreshold => $value, ..., UnhealthyThreshold => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::ContainerServiceHealthCheckConfig object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->HealthyThreshold | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Describes the health check configuration of an Amazon Lightsail | ||
| 42 | container service. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 HealthyThreshold => Int | ||
| 48 | |||
| 49 | The number of consecutive health checks successes required before | ||
| 50 | moving the container to the C<Healthy> state. The default value is | ||
| 51 | C<2>. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 IntervalSeconds => Int | ||
| 55 | |||
| 56 | The approximate interval, in seconds, between health checks of an | ||
| 57 | individual container. You can specify between 5 and 300 seconds. The | ||
| 58 | default value is C<5>. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Path => Str | ||
| 62 | |||
| 63 | The path on the container on which to perform the health check. The | ||
| 64 | default value is C</>. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 SuccessCodes => Str | ||
| 68 | |||
| 69 | The HTTP codes to use when checking for a successful response from a | ||
| 70 | container. You can specify values between 200 and 499. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 TimeoutSeconds => Int | ||
| 74 | |||
| 75 | The amount of time, in seconds, during which no response means a failed | ||
| 76 | health check. You can specify between 2 and 60 seconds. The default | ||
| 77 | value is C<2>. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 UnhealthyThreshold => Int | ||
| 81 | |||
| 82 | The number of consecutive health check failures required before moving | ||
| 83 | the container to the C<Unhealthy> state. The default value is C<2>. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 90 | |||
| 91 | =head1 BUGS and CONTRIBUTIONS | ||
| 92 | |||
| 93 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 94 | |||
| 95 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 96 | |||
| 97 | =cut | ||
| 98 |