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

Interface ProxyConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>, SdkBuilder<ProxyConfiguration.Builder,ProxyConfiguration>, SdkPojo
Enclosing class:
ProxyConfiguration
public static interface ProxyConfiguration.Builder extends SdkPojo, CopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

  • Method Details

    • type

      ProxyConfiguration.Builder type(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:

    • type

      ProxyConfiguration.Builder type(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:

    • containerName

      ProxyConfiguration.Builder containerName(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.

    • properties

      ProxyConfiguration.Builder properties(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.

    • properties

      ProxyConfiguration.Builder properties(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.

    • properties

      ProxyConfiguration.Builder properties(Consumer<KeyValuePair.Builder>... 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.

      This is a convenience method that creates an instance of the KeyValuePair.Builder avoiding the need to create one manually via KeyValuePair.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to properties(List<KeyValuePair>).

      Parameters:
      properties - a consumer that will call methods on KeyValuePair.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: