« blib/lib/Paws/CodeDeploy/BlueGreenDeploymentConfiguration.pm
↑ Summary
blib/lib/Paws/CodeDeploy/CloudFormationTarget.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeDeploy::BlueInstanceTerminationOption; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str', request_name => 'action', traits => ['NameInRequest']); | ||
| 5 | has TerminationWaitTimeInMinutes => (is => 'ro', isa => 'Int', request_name => 'terminationWaitTimeInMinutes', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CodeDeploy::BlueInstanceTerminationOption | ||
| 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::CodeDeploy::BlueInstanceTerminationOption object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Action => $value, ..., TerminationWaitTimeInMinutes => $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::CodeDeploy::BlueInstanceTerminationOption object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Action | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Information about whether instances in the original environment are | ||
| 38 | terminated when a blue/green deployment is successful. | ||
| 39 | C<BlueInstanceTerminationOption> does not apply to Lambda deployments. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Action => Str | ||
| 45 | |||
| 46 | The action to take on instances in the original environment after a | ||
| 47 | successful blue/green deployment. | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | C<TERMINATE>: Instances are terminated after a specified wait time. | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | C<KEEP_ALIVE>: Instances are left running after they are deregistered | ||
| 58 | from the load balancer and removed from the deployment group. | ||
| 59 | |||
| 60 | =back | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 TerminationWaitTimeInMinutes => Int | ||
| 65 | |||
| 66 | For an Amazon EC2 deployment, the number of minutes to wait after a | ||
| 67 | successful blue/green deployment before terminating instances from the | ||
| 68 | original environment. | ||
| 69 | |||
| 70 | For an Amazon ECS deployment, the number of minutes before deleting the | ||
| 71 | original (blue) task set. During an Amazon ECS deployment, CodeDeploy | ||
| 72 | shifts traffic from the original (blue) task set to a replacement | ||
| 73 | (green) task set. | ||
| 74 | |||
| 75 | The maximum setting is 2880 minutes (2 days). | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeDeploy> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |