AWS::ECS::TaskDefinition ProxyConfiguration
The ProxyConfiguration
property specifies the details for the App Mesh
proxy.
For tasks using the EC2 launch type, the container instances require at least version
1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init
package to enable a proxy configuration. If your container instances are launched from
the Amazon ECS-optimized AMI version 20190301
or later, then they contain
the required versions of the container agent and ecs-init
. For more
information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer
Guide.
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ContainerName" :
String
, "ProxyConfigurationProperties" :[ KeyValuePair, ... ]
, "Type" :String
}
YAML
ContainerName:
String
ProxyConfigurationProperties:- KeyValuePair
Type:String
Properties
ContainerName
-
The name of the container that will serve as the App Mesh proxy.
Required: Yes
Type: String
Update requires: Replacement
ProxyConfigurationProperties
-
The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
-
IgnoredUID
- (Required) The user ID (UID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGID
is specified, this field can be empty. -
IgnoredGID
- (Required) The group ID (GID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUID
is specified, this field can be empty. -
AppPorts
- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPort
andProxyEgressPort
. -
ProxyIngressPort
- (Required) Specifies the port that incoming traffic to theAppPorts
is directed to. -
ProxyEgressPort
- (Required) Specifies the port that outgoing traffic from theAppPorts
is directed to. -
EgressIgnoredPorts
- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort
. It can be an empty list. -
EgressIgnoredIPs
- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort
. It can be an empty list.
Required: No
Type: List of KeyValuePair
Update requires: Replacement
-
Type
-
The proxy type. The only supported value is
APPMESH
.Required: No
Type: String
Allowed values:
APPMESH
Update requires: Replacement