AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::ProxyConfiguration Class Reference

#include <ProxyConfiguration.h>

Public Member Functions

 ProxyConfiguration ()
 
 ProxyConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
ProxyConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ProxyConfigurationTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ProxyConfigurationType &value)
 
void SetType (ProxyConfigurationType &&value)
 
ProxyConfigurationWithType (const ProxyConfigurationType &value)
 
ProxyConfigurationWithType (ProxyConfigurationType &&value)
 
const Aws::StringGetContainerName () const
 
bool ContainerNameHasBeenSet () const
 
void SetContainerName (const Aws::String &value)
 
void SetContainerName (Aws::String &&value)
 
void SetContainerName (const char *value)
 
ProxyConfigurationWithContainerName (const Aws::String &value)
 
ProxyConfigurationWithContainerName (Aws::String &&value)
 
ProxyConfigurationWithContainerName (const char *value)
 
const Aws::Vector< KeyValuePair > & GetProperties () const
 
bool PropertiesHasBeenSet () const
 
void SetProperties (const Aws::Vector< KeyValuePair > &value)
 
void SetProperties (Aws::Vector< KeyValuePair > &&value)
 
ProxyConfigurationWithProperties (const Aws::Vector< KeyValuePair > &value)
 
ProxyConfigurationWithProperties (Aws::Vector< KeyValuePair > &&value)
 
ProxyConfigurationAddProperties (const KeyValuePair &value)
 
ProxyConfigurationAddProperties (KeyValuePair &&value)
 

Detailed Description

The configuration details for the App Mesh proxy.

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

See Also:

AWS API Reference

Definition at line 42 of file ProxyConfiguration.h.

Constructor & Destructor Documentation

◆ ProxyConfiguration() [1/2]

Aws::ECS::Model::ProxyConfiguration::ProxyConfiguration ( )

◆ ProxyConfiguration() [2/2]

Aws::ECS::Model::ProxyConfiguration::ProxyConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddProperties() [1/2]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::AddProperties ( const KeyValuePair value)
inline

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.

Definition at line 303 of file ProxyConfiguration.h.

◆ AddProperties() [2/2]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::AddProperties ( KeyValuePair &&  value)
inline

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.

Definition at line 329 of file ProxyConfiguration.h.

◆ ContainerNameHasBeenSet()

bool Aws::ECS::Model::ProxyConfiguration::ContainerNameHasBeenSet ( ) const
inline

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

Definition at line 90 of file ProxyConfiguration.h.

◆ GetContainerName()

const Aws::String& Aws::ECS::Model::ProxyConfiguration::GetContainerName ( ) const
inline

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

Definition at line 85 of file ProxyConfiguration.h.

◆ GetProperties()

const Aws::Vector<KeyValuePair>& Aws::ECS::Model::ProxyConfiguration::GetProperties ( ) const
inline

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.

Definition at line 147 of file ProxyConfiguration.h.

◆ GetType()

const ProxyConfigurationType& Aws::ECS::Model::ProxyConfiguration::GetType ( ) const
inline

The proxy type. The only supported value is APPMESH.

Definition at line 54 of file ProxyConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::ProxyConfiguration::Jsonize ( ) const

◆ operator=()

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PropertiesHasBeenSet()

bool Aws::ECS::Model::ProxyConfiguration::PropertiesHasBeenSet ( ) const
inline

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.

Definition at line 173 of file ProxyConfiguration.h.

◆ SetContainerName() [1/3]

void Aws::ECS::Model::ProxyConfiguration::SetContainerName ( const Aws::String value)
inline

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

Definition at line 95 of file ProxyConfiguration.h.

◆ SetContainerName() [2/3]

void Aws::ECS::Model::ProxyConfiguration::SetContainerName ( Aws::String &&  value)
inline

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

Definition at line 100 of file ProxyConfiguration.h.

◆ SetContainerName() [3/3]

void Aws::ECS::Model::ProxyConfiguration::SetContainerName ( const char *  value)
inline

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

Definition at line 105 of file ProxyConfiguration.h.

◆ SetProperties() [1/2]

void Aws::ECS::Model::ProxyConfiguration::SetProperties ( const Aws::Vector< KeyValuePair > &  value)
inline

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.

Definition at line 199 of file ProxyConfiguration.h.

◆ SetProperties() [2/2]

void Aws::ECS::Model::ProxyConfiguration::SetProperties ( Aws::Vector< KeyValuePair > &&  value)
inline

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.

Definition at line 225 of file ProxyConfiguration.h.

◆ SetType() [1/2]

void Aws::ECS::Model::ProxyConfiguration::SetType ( const ProxyConfigurationType value)
inline

The proxy type. The only supported value is APPMESH.

Definition at line 64 of file ProxyConfiguration.h.

◆ SetType() [2/2]

void Aws::ECS::Model::ProxyConfiguration::SetType ( ProxyConfigurationType &&  value)
inline

The proxy type. The only supported value is APPMESH.

Definition at line 69 of file ProxyConfiguration.h.

◆ TypeHasBeenSet()

bool Aws::ECS::Model::ProxyConfiguration::TypeHasBeenSet ( ) const
inline

The proxy type. The only supported value is APPMESH.

Definition at line 59 of file ProxyConfiguration.h.

◆ WithContainerName() [1/3]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::WithContainerName ( const Aws::String value)
inline

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

Definition at line 110 of file ProxyConfiguration.h.

◆ WithContainerName() [2/3]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::WithContainerName ( Aws::String &&  value)
inline

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

Definition at line 115 of file ProxyConfiguration.h.

◆ WithContainerName() [3/3]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::WithContainerName ( const char *  value)
inline

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

Definition at line 120 of file ProxyConfiguration.h.

◆ WithProperties() [1/2]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::WithProperties ( const Aws::Vector< KeyValuePair > &  value)
inline

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.

Definition at line 251 of file ProxyConfiguration.h.

◆ WithProperties() [2/2]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::WithProperties ( Aws::Vector< KeyValuePair > &&  value)
inline

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.

Definition at line 277 of file ProxyConfiguration.h.

◆ WithType() [1/2]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::WithType ( const ProxyConfigurationType value)
inline

The proxy type. The only supported value is APPMESH.

Definition at line 74 of file ProxyConfiguration.h.

◆ WithType() [2/2]

ProxyConfiguration& Aws::ECS::Model::ProxyConfiguration::WithType ( ProxyConfigurationType &&  value)
inline

The proxy type. The only supported value is APPMESH.

Definition at line 79 of file ProxyConfiguration.h.


The documentation for this class was generated from the following file: