Skip to content

/AWS1/CL_ECSPROXYCONFIGURATION

The configuration details for the App Mesh proxy.

For tasks that use 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 use 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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_containername TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The name of the container that will serve as the App Mesh proxy.

Optional arguments:

iv_type TYPE /AWS1/ECSPROXYCONFTYPE /AWS1/ECSPROXYCONFTYPE

The proxy type. The only supported value is APPMESH.

it_properties TYPE /AWS1/CL_ECSKEYVALUEPAIR=>TT_PROXYCONFPROPERTIES TT_PROXYCONFPROPERTIES

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 the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.

  • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID 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 the ProxyIngressPort and ProxyEgressPort.

  • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.

  • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.

  • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

  • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

Queryable Attributes

type

The proxy type. The only supported value is APPMESH.

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value

containerName

The name of the container that will serve as the App Mesh proxy.

Accessible with the following methods

Method Description
GET_CONTAINERNAME() Getter for CONTAINERNAME, with configurable default
ASK_CONTAINERNAME() Getter for CONTAINERNAME w/ exceptions if field has no value
HAS_CONTAINERNAME() Determine if CONTAINERNAME has a value

properties

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 the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.

  • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID 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 the ProxyIngressPort and ProxyEgressPort.

  • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.

  • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.

  • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

  • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

Accessible with the following methods

Method Description
GET_PROPERTIES() Getter for PROPERTIES, with configurable default
ASK_PROPERTIES() Getter for PROPERTIES w/ exceptions if field has no value
HAS_PROPERTIES() Determine if PROPERTIES has a value