| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::ProxyConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has ContainerName => (is => 'ro', isa => 'Str', request_name => 'containerName', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Properties => (is => 'ro', isa => 'ArrayRef[Paws::ECS::KeyValuePair]', request_name => 'properties', traits => ['NameInRequest']); | ||
| 6 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ECS::ProxyConfiguration | ||
| 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::ProxyConfiguration object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { ContainerName => $value, ..., Type => $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::ProxyConfiguration object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->ContainerName | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The configuration details for the App Mesh proxy. | ||
| 39 | |||
| 40 | For tasks using the EC2 launch type, the container instances require at | ||
| 41 | least version 1.26.0 of the container agent and at least version | ||
| 42 | 1.26.0-1 of the C<ecs-init> package to enable a proxy configuration. If | ||
| 43 | your container instances are launched from the Amazon ECS-optimized AMI | ||
| 44 | version C<20190301> or later, then they contain the required versions | ||
| 45 | of the container agent and C<ecs-init>. For more information, see | ||
| 46 | Amazon ECS-optimized Linux AMI | ||
| 47 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> ContainerName => Str | ||
| 53 | |||
| 54 | The name of the container that will serve as the App Mesh proxy. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Properties => ArrayRef[L<Paws::ECS::KeyValuePair>] | ||
| 58 | |||
| 59 | The set of network configuration parameters to provide the Container | ||
| 60 | Network Interface (CNI) plugin, specified as key-value pairs. | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<IgnoredUID> - (Required) The user ID (UID) of the proxy container as | ||
| 67 | defined by the C<user> parameter in a container definition. This is | ||
| 68 | used to ensure the proxy ignores its own traffic. If C<IgnoredGID> is | ||
| 69 | specified, this field can be empty. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<IgnoredGID> - (Required) The group ID (GID) of the proxy container as | ||
| 74 | defined by the C<user> parameter in a container definition. This is | ||
| 75 | used to ensure the proxy ignores its own traffic. If C<IgnoredUID> is | ||
| 76 | specified, this field can be empty. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<AppPorts> - (Required) The list of ports that the application uses. | ||
| 81 | Network traffic to these ports is forwarded to the C<ProxyIngressPort> | ||
| 82 | and C<ProxyEgressPort>. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<ProxyIngressPort> - (Required) Specifies the port that incoming | ||
| 87 | traffic to the C<AppPorts> is directed to. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<ProxyEgressPort> - (Required) Specifies the port that outgoing | ||
| 92 | traffic from the C<AppPorts> is directed to. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<EgressIgnoredPorts> - (Required) The egress traffic going to the | ||
| 97 | specified ports is ignored and not redirected to the | ||
| 98 | C<ProxyEgressPort>. It can be an empty list. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<EgressIgnoredIPs> - (Required) The egress traffic going to the | ||
| 103 | specified IP addresses is ignored and not redirected to the | ||
| 104 | C<ProxyEgressPort>. It can be an empty list. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 Type => Str | ||
| 111 | |||
| 112 | The proxy type. The only supported value is C<APPMESH>. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |