Package software.amazon.awssdk.services.ecs.model

Class ProxyConfiguration

java.lang.Object

software.amazon.awssdk.services.ecs.model.ProxyConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ProxyConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProxyConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ProxyConfiguration.Builder	builder()
String	containerName()	The name of the container that will serve as the App Mesh proxy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProperties()	For responses, this returns true if the service returned a value for the Properties property.
List<KeyValuePair>	properties()	The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ProxyConfiguration.Builder>	serializableBuilderClass()
ProxyConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ProxyConfigurationType	type()	The proxy type.
String	typeAsString()	The proxy type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public final ProxyConfigurationType type()

The proxy type. The only supported value is APPMESH.

If the service returns an enum value that is not available in the current SDK version, type will return ProxyConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The proxy type. The only supported value is APPMESH.

See Also:

ProxyConfigurationType

typeAsString

public final String typeAsString()

The proxy type. The only supported value is APPMESH.

If the service returns an enum value that is not available in the current SDK version, type will return ProxyConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The proxy type. The only supported value is APPMESH.

See Also:

ProxyConfigurationType

containerName

public final String containerName()

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.

hasProperties

public final boolean hasProperties()

For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

properties

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProperties() method.

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.

toBuilder

public ProxyConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

builder

public static ProxyConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ProxyConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo