Skip to content
v2.278.0

AppMeshProxyConfigurationProps Struct ​

Interface for setting the properties of proxy configuration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const appMeshProxyConfigurationProps: ecs.AppMeshProxyConfigurationProps = {
  appPorts: [123],
  proxyEgressPort: 123,
  proxyIngressPort: 123,

  // the properties below are optional
  egressIgnoredIPs: ['egressIgnoredIPs'],
  egressIgnoredPorts: [123],
  ignoredGID: 123,
  ignoredUID: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ecs as ecs

app_mesh_proxy_configuration_props = ecs.AppMeshProxyConfigurationProps(
    app_ports=[123],
    proxy_egress_port=123,
    proxy_ingress_port=123,

    # the properties below are optional
    egress_ignored_i_ps=["egressIgnoredIPs"],
    egress_ignored_ports=[123],
    ignored_gid=123,
    ignored_uid=123
)
java
// 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.*;

AppMeshProxyConfigurationProps appMeshProxyConfigurationProps = AppMeshProxyConfigurationProps.builder()
        .appPorts(List.of(123))
        .proxyEgressPort(123)
        .proxyIngressPort(123)

        // the properties below are optional
        .egressIgnoredIPs(List.of("egressIgnoredIPs"))
        .egressIgnoredPorts(List.of(123))
        .ignoredGID(123)
        .ignoredUID(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;

var appMeshProxyConfigurationProps = new AppMeshProxyConfigurationProps {
    AppPorts = new [] { 123 },
    ProxyEgressPort = 123,
    ProxyIngressPort = 123,

    // the properties below are optional
    EgressIgnoredIPs = new [] { "egressIgnoredIPs" },
    EgressIgnoredPorts = new [] { 123 },
    IgnoredGID = 123,
    IgnoredUID = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

appMeshProxyConfigurationProps := &AppMeshProxyConfigurationProps{
	AppPorts: []*f64{
		jsii.Number(123),
	},
	ProxyEgressPort: jsii.Number(123),
	ProxyIngressPort: jsii.Number(123),

	// the properties below are optional
	EgressIgnoredIPs: []*string{
		jsii.String("egressIgnoredIPs"),
	},
	EgressIgnoredPorts: []*f64{
		jsii.Number(123),
	},
	IgnoredGID: jsii.Number(123),
	IgnoredUID: jsii.Number(123),
}

Properties ​

appPortsnumber[]app_portstyping.List[int | float]appPortsList<Number>AppPortsdouble[]AppPorts*[]*float64 required #
The list of ports that the application uses.

Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.

egressIgnoredIPsoptionalstring[]egress_ignored_i_psoptionaltyping.List[str]egressIgnoredIPsoptionalList<String>EgressIgnoredIPsoptionalstring[]EgressIgnoredIPsoptional*[]*string #
The egress traffic going to these specified IP addresses is ignored and not redirected to the ProxyEgressPort.

It can be an empty list.

egressIgnoredPortsoptionalnumber[]egress_ignored_portsoptionaltyping.List[int | float]egressIgnoredPortsoptionalList<Number>EgressIgnoredPortsoptionaldouble[]EgressIgnoredPortsoptional*[]*float64 #
The egress traffic going to these specified ports is ignored and not redirected to the ProxyEgressPort.

It can be an empty list.

ignoredGIDoptionalnumberignored_gidoptionalint | floatignoredGIDoptionalNumberIgnoredGIDoptionaldoubleIgnoredGIDoptional*float64 #
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.

ignoredUIDoptionalnumberignored_uidoptionalint | floatignoredUIDoptionalNumberIgnoredUIDoptionaldoubleIgnoredUIDoptional*float64 #
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.

proxyEgressPortnumberproxy_egress_portint | floatproxyEgressPortNumberProxyEgressPortdoubleProxyEgressPort*float64 required #
Specifies the port that outgoing traffic from the AppPorts is directed to.
proxyIngressPortnumberproxy_ingress_portint | floatproxyIngressPortNumberProxyIngressPortdoubleProxyIngressPort*float64 required #
Specifies the port that incoming traffic to the AppPorts is directed to.