| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::ContainerDependency; | ||
| 3 | use Moose; | ||
| 4 | has Condition => (is => 'ro', isa => 'Str', request_name => 'condition', traits => ['NameInRequest'], required => 1); | ||
| 5 | has ContainerName => (is => 'ro', isa => 'Str', request_name => 'containerName', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::ECS::ContainerDependency | ||
| 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::ContainerDependency object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Condition => $value, ..., ContainerName => $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::ContainerDependency object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Condition | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The dependencies defined for container startup and shutdown. A | ||
| 38 | container can contain multiple dependencies. When a dependency is | ||
| 39 | defined for container startup, for container shutdown it is reversed. | ||
| 40 | |||
| 41 | Your Amazon ECS container instances require at least version 1.26.0 of | ||
| 42 | the container agent to enable container dependencies. However, we | ||
| 43 | recommend using the latest container agent version. For information | ||
| 44 | about checking your agent version and updating to the latest version, | ||
| 45 | see Updating the Amazon ECS Container Agent | ||
| 46 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) | ||
| 47 | in the I<Amazon Elastic Container Service Developer Guide>. If you are | ||
| 48 | using an Amazon ECS-optimized Linux AMI, your instance needs at least | ||
| 49 | version 1.26.0-1 of the C<ecs-init> package. If your container | ||
| 50 | instances are launched from version C<20190301> or later, then they | ||
| 51 | contain the required versions of the container agent and C<ecs-init>. | ||
| 52 | For more information, see Amazon ECS-optimized Linux AMI | ||
| 53 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) | ||
| 54 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 55 | |||
| 56 | For tasks using the Fargate launch type, this parameter requires that | ||
| 57 | the task or service uses platform version 1.3.0 or later. | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Condition => Str | ||
| 63 | |||
| 64 | The dependency condition of the container. The following are the | ||
| 65 | available conditions and their behavior: | ||
| 66 | |||
| 67 | =over | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<START> - This condition emulates the behavior of links and volumes | ||
| 72 | today. It validates that a dependent container is started before | ||
| 73 | permitting other containers to start. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<COMPLETE> - This condition validates that a dependent container runs | ||
| 78 | to completion (exits) before permitting other containers to start. This | ||
| 79 | can be useful for nonessential containers that run a script and then | ||
| 80 | exit. This condition cannot be set on an essential container. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<SUCCESS> - This condition is the same as C<COMPLETE>, but it also | ||
| 85 | requires that the container exits with a C<zero> status. This condition | ||
| 86 | cannot be set on an essential container. | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<HEALTHY> - This condition validates that the dependent container | ||
| 91 | passes its Docker health check before permitting other containers to | ||
| 92 | start. This requires that the dependent container has health checks | ||
| 93 | configured. This condition is confirmed only at task startup. | ||
| 94 | |||
| 95 | =back | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> ContainerName => Str | ||
| 100 | |||
| 101 | The name of a container. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |