1.204.0

interface NetworkMultipleTargetGroupsEc2ServiceProps

LanguageType name
.NETAmazon.CDK.AWS.ECS.Patterns.NetworkMultipleTargetGroupsEc2ServiceProps
Javasoftware.amazon.awscdk.services.ecs.patterns.NetworkMultipleTargetGroupsEc2ServiceProps
Pythonaws_cdk.aws_ecs_patterns.NetworkMultipleTargetGroupsEc2ServiceProps
TypeScript (source)@aws-cdk/aws-ecs-patterns » NetworkMultipleTargetGroupsEc2ServiceProps

The properties for the NetworkMultipleTargetGroupsEc2Service service.

Example

// Two network load balancers, each with their own listener and target group.
declare const cluster: ecs.Cluster;
const loadBalancedEc2Service = new ecsPatterns.NetworkMultipleTargetGroupsEc2Service(this, 'Service', {
  cluster,
  memoryLimitMiB: 256,
  taskImageOptions: {
    image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  },
  loadBalancers: [
    {
      name: 'lb1',
      listeners: [
        {
          name: 'listener1',
        },
      ],
    },
    {
      name: 'lb2',
      listeners: [
        {
          name: 'listener2',
        },
      ],
    },
  ],
  targetGroups: [
    {
      containerPort: 80,
      listener: 'listener1',
    },
    {
      containerPort: 90,
      listener: 'listener2',
    },
  ],
});

Properties

NameTypeDescription
cloudMapOptions?CloudMapOptionsThe options for configuring an Amazon ECS service to use service discovery.
cluster?IClusterThe name of the cluster that hosts the service.
cpu?numberThe minimum number of CPU units to reserve for the container.
desiredCount?numberThe desired number of instantiations of the task definition to keep running on the service.
enableECSManagedTags?booleanSpecifies whether to enable Amazon ECS managed tags for the tasks within the service.
healthCheckGracePeriod?DurationThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
loadBalancers?NetworkLoadBalancerProps[]The network load balancer that will serve traffic to the service.
memoryLimitMiB?numberThe amount (in MiB) of memory to present to the container.
memoryReservationMiB?numberThe soft limit (in MiB) of memory to reserve for the container.
placementConstraints?PlacementConstraint[]The placement constraints to use for tasks in the service.
placementStrategies?PlacementStrategy[]The placement strategies to use for tasks in the service.
propagateTags?PropagatedTagSourceSpecifies whether to propagate the tags from the task definition or the service to the tasks in the service.
serviceName?stringName of the service.
targetGroups?NetworkTargetProps[]Properties to specify NLB target groups.
taskDefinition?Ec2TaskDefinitionThe task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.
taskImageOptions?NetworkLoadBalancedTaskImagePropsThe properties required to create a new task definition.
vpc?IVpcThe VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

cloudMapOptions?

Type: CloudMapOptions (optional, default: AWS Cloud Map service discovery is not enabled.)

The options for configuring an Amazon ECS service to use service discovery.

cluster?

Type: ICluster (optional, default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.)

The name of the cluster that hosts the service.

If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

cpu?

Type: number (optional, default: No minimum CPU units reserved.)

The minimum number of CPU units to reserve for the container.

Valid values, which determines your range of valid values for the memory parameter:

desiredCount?

Type: number (optional, default: If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services desired count when updating an existing service.)

The desired number of instantiations of the task definition to keep running on the service.

The minimum value is 1

enableECSManagedTags?

Type: boolean (optional, default: false)

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

healthCheckGracePeriod?

Type: Duration (optional, default: defaults to 60 seconds if at least one load balancer is in-use and it is not already set)

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

loadBalancers?

Type: NetworkLoadBalancerProps[] (optional, default: a new load balancer with a listener will be created.)

The network load balancer that will serve traffic to the service.

memoryLimitMiB?

Type: number (optional, default: No memory limit.)

The amount (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required.

memoryReservationMiB?

Type: number (optional, default: No memory reserved.)

The soft limit (in MiB) of memory to reserve for the container.

When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Note that this setting will be ignored if TaskImagesOptions is specified.

placementConstraints?

Type: PlacementConstraint[] (optional, default: No constraints.)

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.

placementStrategies?

Type: PlacementStrategy[] (optional, default: No strategies.)

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.

propagateTags?

Type: PropagatedTagSource (optional, default: none)

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Tags can only be propagated to the tasks within the service during service creation.

serviceName?

Type: string (optional, default: CloudFormation-generated name.)

Name of the service.

targetGroups?

Type: NetworkTargetProps[] (optional, default: default portMapping registered as target group and attached to the first defined listener)

Properties to specify NLB target groups.

taskDefinition?

Type: Ec2TaskDefinition (optional, default: none)

The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.

[disable-awslint:ref-via-interface]

taskImageOptions?

Type: NetworkLoadBalancedTaskImageProps (optional, default: none)

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

vpc?

Type: IVpc (optional, default: uses the VPC defined in the cluster or creates a new VPC.)

The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

← PreviousNext →