Package software.amazon.awscdk.services.ecs

Class AppMeshProxyConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.ProxyConfiguration

software.amazon.awscdk.services.ecs.AppMeshProxyConfiguration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:46.973Z")
@Stability(Stable)
public class AppMeshProxyConfiguration
extends ProxyConfiguration

The class for App Mesh proxy configurations.

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 AMIs.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Example:

 // 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.*;
 AppMeshProxyConfiguration appMeshProxyConfiguration = AppMeshProxyConfiguration.Builder.create()
         .containerName("containerName")
         .properties(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())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AppMeshProxyConfiguration.Builder	A fluent builder for AppMeshProxyConfiguration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	AppMeshProxyConfiguration(AppMeshProxyConfigurationConfigProps props)	Constructs a new instance of the AppMeshProxyConfiguration class.
protected	AppMeshProxyConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AppMeshProxyConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
CfnTaskDefinition.ProxyConfigurationProperty	bind(Construct _scope, TaskDefinition _taskDefinition)	Called when the proxy configuration is configured on a task definition.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

AppMeshProxyConfiguration

protected AppMeshProxyConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

AppMeshProxyConfiguration

protected AppMeshProxyConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AppMeshProxyConfiguration

@Stability(Stable)
public AppMeshProxyConfiguration(@NotNull
 AppMeshProxyConfigurationConfigProps props)

Constructs a new instance of the AppMeshProxyConfiguration class.

Parameters:

props - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public CfnTaskDefinition.ProxyConfigurationProperty bind(@NotNull
 Construct _scope,
 @NotNull
 TaskDefinition _taskDefinition)

Called when the proxy configuration is configured on a task definition.

Specified by:

bind in class ProxyConfiguration

Parameters:

_scope - This parameter is required.

_taskDefinition - This parameter is required.