public static interface CfnTaskDefinition.ProxyConfigurationProperty
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ecs.*; ProxyConfigurationProperty proxyConfigurationProperty = ProxyConfigurationProperty.builder() .containerName("containerName") // the properties below are optional .proxyConfigurationProperties(List.of(KeyValuePairProperty.builder() .name("name") .value("value") .build())) .type("type") .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnTaskDefinition.ProxyConfigurationProperty.Builder
A builder for
CfnTaskDefinition.ProxyConfigurationProperty |
static class |
CfnTaskDefinition.ProxyConfigurationProperty.Jsii$Proxy
An implementation for
CfnTaskDefinition.ProxyConfigurationProperty |
Modifier and Type | Method and Description |
---|---|
static CfnTaskDefinition.ProxyConfigurationProperty.Builder |
builder() |
java.lang.String |
getContainerName()
The name of the container that will serve as the App Mesh proxy.
|
default java.lang.Object |
getProxyConfigurationProperties()
The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
|
default java.lang.String |
getType()
The proxy type.
|
java.lang.String getContainerName()
default java.lang.Object getProxyConfigurationProperties()
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.default java.lang.String getType()
The only supported value is APPMESH
.
static CfnTaskDefinition.ProxyConfigurationProperty.Builder builder()