« blib/lib/Paws/AppMesh/VirtualGatewayGrpcConnectionPool.pm
↑ Summary
blib/lib/Paws/AppMesh/VirtualGatewayHttp2ConnectionPool.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AppMesh::VirtualGatewayHealthCheckPolicy; | ||
| 3 | use Moose; | ||
| 4 | has HealthyThreshold => (is => 'ro', isa => 'Int', request_name => 'healthyThreshold', traits => ['NameInRequest'], required => 1); | ||
| 5 | has IntervalMillis => (is => 'ro', isa => 'Int', request_name => 'intervalMillis', traits => ['NameInRequest'], required => 1); | ||
| 6 | has Path => (is => 'ro', isa => 'Str', request_name => 'path', traits => ['NameInRequest']); | ||
| 7 | has Port => (is => 'ro', isa => 'Int', request_name => 'port', traits => ['NameInRequest']); | ||
| 8 | has Protocol => (is => 'ro', isa => 'Str', request_name => 'protocol', traits => ['NameInRequest'], required => 1); | ||
| 9 | has TimeoutMillis => (is => 'ro', isa => 'Int', request_name => 'timeoutMillis', traits => ['NameInRequest'], required => 1); | ||
| 10 | has UnhealthyThreshold => (is => 'ro', isa => 'Int', request_name => 'unhealthyThreshold', traits => ['NameInRequest'], required => 1); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::AppMesh::VirtualGatewayHealthCheckPolicy | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::AppMesh::VirtualGatewayHealthCheckPolicy object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { HealthyThreshold => $value, ..., UnhealthyThreshold => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::AppMesh::VirtualGatewayHealthCheckPolicy object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->HealthyThreshold | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | An object that represents the health check policy for a virtual | ||
| 43 | gateway's listener. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> HealthyThreshold => Int | ||
| 49 | |||
| 50 | The number of consecutive successful health checks that must occur | ||
| 51 | before declaring the listener healthy. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> IntervalMillis => Int | ||
| 55 | |||
| 56 | The time period in milliseconds between each health check execution. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Path => Str | ||
| 60 | |||
| 61 | The destination path for the health check request. This value is only | ||
| 62 | used if the specified protocol is HTTP or HTTP/2. For any other | ||
| 63 | protocol, this value is ignored. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Port => Int | ||
| 67 | |||
| 68 | The destination port for the health check request. This port must match | ||
| 69 | the port defined in the PortMapping for the listener. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> Protocol => Str | ||
| 73 | |||
| 74 | The protocol for the health check request. If you specify C<grpc>, then | ||
| 75 | your service must conform to the GRPC Health Checking Protocol | ||
| 76 | (https://github.com/grpc/grpc/blob/master/doc/health-checking.md). | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> TimeoutMillis => Int | ||
| 80 | |||
| 81 | The amount of time to wait when receiving a response from the health | ||
| 82 | check, in milliseconds. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> UnhealthyThreshold => Int | ||
| 86 | |||
| 87 | The number of consecutive failed health checks that must occur before | ||
| 88 | declaring a virtual gateway unhealthy. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, describing an object used in L<Paws::AppMesh> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |