aws-cdk-lib.aws_ecs.AppMeshProxyConfiguration

class AppMeshProxyConfiguration

LanguageType name
.NETAmazon.CDK.AWS.ECS.AppMeshProxyConfiguration
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecs#AppMeshProxyConfiguration
Javasoftware.amazon.awscdk.services.ecs.AppMeshProxyConfiguration
Pythonaws_cdk.aws_ecs.AppMeshProxyConfiguration
TypeScript (source)aws-cdk-lib » aws_ecs » 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 { aws_ecs as ecs } from 'aws-cdk-lib';
const appMeshProxyConfiguration = new ecs.AppMeshProxyConfiguration({
  containerName: 'containerName',
  properties: {
    appPorts: [123],
    proxyEgressPort: 123,
    proxyIngressPort: 123,

    // the properties below are optional
    egressIgnoredIPs: ['egressIgnoredIPs'],
    egressIgnoredPorts: [123],
    ignoredGID: 123,
    ignoredUID: 123,
  },
});

Initializer

new AppMeshProxyConfiguration(props: AppMeshProxyConfigurationConfigProps)

Parameters

  • props AppMeshProxyConfigurationConfigProps

Constructs a new instance of the AppMeshProxyConfiguration class.

Methods

NameDescription
bind(_scope, _taskDefinition)Called when the proxy configuration is configured on a task definition.

bind(_scope, _taskDefinition)

public bind(_scope: Construct, _taskDefinition: TaskDefinition): ProxyConfigurationProperty

Parameters

  • _scope Construct
  • _taskDefinition TaskDefinition

Returns

  • ProxyConfigurationProperty

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