| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::DeploymentCircuitBreaker; | ||
| 3 | use Moose; | ||
| 4 | has Enable => (is => 'ro', isa => 'Bool', request_name => 'enable', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Rollback => (is => 'ro', isa => 'Bool', request_name => 'rollback', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::ECS::DeploymentCircuitBreaker | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::ECS::DeploymentCircuitBreaker object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Enable => $value, ..., Rollback => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::DeploymentCircuitBreaker object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Enable | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The deployment circuit breaker can only be used for services using the | ||
| 38 | rolling update (C<ECS>) deployment type that are not behind a Classic | ||
| 39 | Load Balancer. | ||
| 40 | |||
| 41 | The B<deployment circuit breaker> determines whether a service | ||
| 42 | deployment will fail if the service can't reach a steady state. If | ||
| 43 | enabled, a service deployment will transition to a failed state and | ||
| 44 | stop launching new tasks. You can also enable Amazon ECS to roll back | ||
| 45 | your service to the last completed deployment after a failure. For more | ||
| 46 | information, see Rolling update | ||
| 47 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) | ||
| 48 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> Enable => Bool | ||
| 54 | |||
| 55 | Whether to enable the deployment circuit breaker logic for the service. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> Rollback => Bool | ||
| 59 | |||
| 60 | Whether to enable Amazon ECS to roll back the service if a service | ||
| 61 | deployment fails. If rollback is enabled, when a service deployment | ||
| 62 | fails, the service is rolled back to the last deployment that completed | ||
| 63 | successfully. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 70 | |||
| 71 | =head1 BUGS and CONTRIBUTIONS | ||
| 72 | |||
| 73 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 74 | |||
| 75 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 76 | |||
| 77 | =cut | ||
| 78 |