ProxyConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.ProxyConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProxyConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProxyConfiguration()

Constructors
Constructor and Description
`ProxyConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProxyConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getContainerName()` The name of the container that will serve as the App Mesh proxy.
`List<KeyValuePair>`	`getProperties()` The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
`String`	`getType()` The proxy type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContainerName(String containerName)` The name of the container that will serve as the App Mesh proxy.
`void`	`setProperties(Collection<KeyValuePair> properties)` The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
`void`	`setType(String type)` The proxy type.
`String`	`toString()` Returns a string representation of this object.
`ProxyConfiguration`	`withContainerName(String containerName)` The name of the container that will serve as the App Mesh proxy.
`ProxyConfiguration`	`withProperties(Collection<KeyValuePair> properties)` The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
`ProxyConfiguration`	`withProperties(KeyValuePair... properties)` The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
`ProxyConfiguration`	`withType(ProxyConfigurationType type)` The proxy type.
`ProxyConfiguration`	`withType(String type)` The proxy type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProxyConfiguration
```
public ProxyConfiguration()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The proxy type. The only supported value is APPMESH.
    
    Parameters:
    
    type - The proxy type. The only supported value is APPMESH.
    
    See Also:
    
    ProxyConfigurationType
  - getType
```
public String getType()
```
    The proxy type. The only supported value is APPMESH.
    
    Returns:
    
    The proxy type. The only supported value is APPMESH.
    
    See Also:
    
    ProxyConfigurationType
  - withType
```
public ProxyConfiguration withType(String type)
```
    The proxy type. The only supported value is APPMESH.
    
    Parameters:
    
    type - The proxy type. The only supported value is APPMESH.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProxyConfigurationType
  - withType
```
public ProxyConfiguration withType(ProxyConfigurationType type)
```
    The proxy type. The only supported value is APPMESH.
    
    Parameters:
    
    type - The proxy type. The only supported value is APPMESH.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProxyConfigurationType
  - setContainerName
```
public void setContainerName(String containerName)
```
    The name of the container that will serve as the App Mesh proxy.
    
    Parameters:
    
    containerName - The name of the container that will serve as the App Mesh proxy.
  - getContainerName
```
public String getContainerName()
```
    The name of the container that will serve as the App Mesh proxy.
    
    Returns:
    
    The name of the container that will serve as the App Mesh proxy.
  - withContainerName
```
public ProxyConfiguration withContainerName(String containerName)
```
    The name of the container that will serve as the App Mesh proxy.
    
    Parameters:
    
    containerName - The name of the container that will serve as the App Mesh proxy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getProperties
```
public List<KeyValuePair> getProperties()
```
    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.
    Returns:
    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.
  - setProperties
```
public void setProperties(Collection<KeyValuePair> 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.
    Parameters:
    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.
  - withProperties
```
public ProxyConfiguration withProperties(KeyValuePair... 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.
    NOTE: This method appends the values to the existing list (if any). Use setProperties(java.util.Collection) or withProperties(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withProperties
```
public ProxyConfiguration withProperties(Collection<KeyValuePair> 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ProxyConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ProxyConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProxyConfiguration

Method Detail

setType

getType

withType

withType

setContainerName

getContainerName

withContainerName

getProperties

setProperties

withProperties

withProperties

toString

equals

hashCode

clone

marshall