« blib/lib/Paws/ECS/DeploymentCircuitBreaker.pm
↑ Summary
blib/lib/Paws/ECS/DeploymentController.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::DeploymentConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has DeploymentCircuitBreaker => (is => 'ro', isa => 'Paws::ECS::DeploymentCircuitBreaker', request_name => 'deploymentCircuitBreaker', traits => ['NameInRequest']); | ||
| 5 | has MaximumPercent => (is => 'ro', isa => 'Int', request_name => 'maximumPercent', traits => ['NameInRequest']); | ||
| 6 | has MinimumHealthyPercent => (is => 'ro', isa => 'Int', request_name => 'minimumHealthyPercent', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ECS::DeploymentConfiguration | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ECS::DeploymentConfiguration object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { DeploymentCircuitBreaker => $value, ..., MinimumHealthyPercent => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::DeploymentConfiguration object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->DeploymentCircuitBreaker | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Optional deployment parameters that control how many tasks run during a | ||
| 39 | deployment and the ordering of stopping and starting tasks. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 DeploymentCircuitBreaker => L<Paws::ECS::DeploymentCircuitBreaker> | ||
| 45 | |||
| 46 | The deployment circuit breaker can only be used for services using the | ||
| 47 | rolling update (C<ECS>) deployment type. | ||
| 48 | |||
| 49 | The B<deployment circuit breaker> determines whether a service | ||
| 50 | deployment will fail if the service can't reach a steady state. If | ||
| 51 | deployment circuit breaker is enabled, a service deployment will | ||
| 52 | transition to a failed state and stop launching new tasks. If rollback | ||
| 53 | is enabled, when a service deployment fails, the service is rolled back | ||
| 54 | to the last deployment that completed successfully. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 MaximumPercent => Int | ||
| 58 | |||
| 59 | If a service is using the rolling update (C<ECS>) deployment type, the | ||
| 60 | B<maximum percent> parameter represents an upper limit on the number of | ||
| 61 | tasks in a service that are allowed in the C<RUNNING> or C<PENDING> | ||
| 62 | state during a deployment, as a percentage of the desired number of | ||
| 63 | tasks (rounded down to the nearest integer), and while any container | ||
| 64 | instances are in the C<DRAINING> state if the service contains tasks | ||
| 65 | using the EC2 launch type. This parameter enables you to define the | ||
| 66 | deployment batch size. For example, if your service has a desired | ||
| 67 | number of four tasks and a maximum percent value of 200%, the scheduler | ||
| 68 | may start four new tasks before stopping the four older tasks (provided | ||
| 69 | that the cluster resources required to do this are available). The | ||
| 70 | default value for maximum percent is 200%. | ||
| 71 | |||
| 72 | If a service is using the blue/green (C<CODE_DEPLOY>) or C<EXTERNAL> | ||
| 73 | deployment types and tasks that use the EC2 launch type, the B<maximum | ||
| 74 | percent> value is set to the default value and is used to define the | ||
| 75 | upper limit on the number of the tasks in the service that remain in | ||
| 76 | the C<RUNNING> state while the container instances are in the | ||
| 77 | C<DRAINING> state. If the tasks in the service use the Fargate launch | ||
| 78 | type, the maximum percent value is not used, although it is returned | ||
| 79 | when describing your service. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 MinimumHealthyPercent => Int | ||
| 83 | |||
| 84 | If a service is using the rolling update (C<ECS>) deployment type, the | ||
| 85 | B<minimum healthy percent> represents a lower limit on the number of | ||
| 86 | tasks in a service that must remain in the C<RUNNING> state during a | ||
| 87 | deployment, as a percentage of the desired number of tasks (rounded up | ||
| 88 | to the nearest integer), and while any container instances are in the | ||
| 89 | C<DRAINING> state if the service contains tasks using the EC2 launch | ||
| 90 | type. This parameter enables you to deploy without using additional | ||
| 91 | cluster capacity. For example, if your service has a desired number of | ||
| 92 | four tasks and a minimum healthy percent of 50%, the scheduler may stop | ||
| 93 | two existing tasks to free up cluster capacity before starting two new | ||
| 94 | tasks. Tasks for services that I<do not> use a load balancer are | ||
| 95 | considered healthy if they are in the C<RUNNING> state; tasks for | ||
| 96 | services that I<do> use a load balancer are considered healthy if they | ||
| 97 | are in the C<RUNNING> state and they are reported as healthy by the | ||
| 98 | load balancer. The default value for minimum healthy percent is 100%. | ||
| 99 | |||
| 100 | If a service is using the blue/green (C<CODE_DEPLOY>) or C<EXTERNAL> | ||
| 101 | deployment types and tasks that use the EC2 launch type, the B<minimum | ||
| 102 | healthy percent> value is set to the default value and is used to | ||
| 103 | define the lower limit on the number of the tasks in the service that | ||
| 104 | remain in the C<RUNNING> state while the container instances are in the | ||
| 105 | C<DRAINING> state. If the tasks in the service use the Fargate launch | ||
| 106 | type, the minimum healthy percent value is not used, although it is | ||
| 107 | returned when describing your service. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |