NetworkMultipleTargetGroupsEc2ServiceProps¶

class aws_cdk.aws_ecs_patterns.NetworkMultipleTargetGroupsEc2ServiceProps(*, cloud_map_options=None, cluster=None, desired_count=None, enable_ecs_managed_tags=None, health_check_grace_period=None, load_balancers=None, propagate_tags=None, service_name=None, target_groups=None, task_image_options=None, vpc=None, cpu=None, memory_limit_mib=None, memory_reservation_mib=None, placement_constraints=None, placement_strategies=None, task_definition=None)¶

Bases: aws_cdk.aws_ecs_patterns.NetworkMultipleTargetGroupsServiceBaseProps

The properties for the NetworkMultipleTargetGroupsEc2Service service.

Parameters

cloud_map_options (Optional[CloudMapOptions]) – The options for configuring an Amazon ECS service to use service discovery. Default: - AWS Cloud Map service discovery is not enabled.
cluster (Optional[ICluster]) – 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. Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
desired_count (Union[int, float, None]) – The desired number of instantiations of the task definition to keep running on the service. The minimum value is 1 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.
enable_ecs_managed_tags (Optional[bool]) – Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources Default: false
health_check_grace_period (Optional[Duration]) – 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. Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
load_balancers (Optional[Sequence[NetworkLoadBalancerProps]]) – The network load balancer that will serve traffic to the service. Default: - a new load balancer with a listener will be created.
propagate_tags (Optional[PropagatedTagSource]) – 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. Default: - none
service_name (Optional[str]) – Name of the service. Default: - CloudFormation-generated name.
target_groups (Optional[Sequence[NetworkTargetProps]]) – Properties to specify NLB target groups. Default: - default portMapping registered as target group and attached to the first defined listener
task_image_options (Optional[NetworkLoadBalancedTaskImageProps]) – The properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified. Default: - none
vpc (Optional[IVpc]) – 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. Default: - uses the VPC defined in the cluster or creates a new VPC.
cpu (Union[int, float, None]) – The minimum number of CPU units to reserve for the container. Valid values, which determines your range of valid values for the memory parameter: Default: - No minimum CPU units reserved.
memory_limit_mib (Union[int, float, None]) – 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. Default: - No memory limit.
memory_reservation_mib (Union[int, float, None]) – 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. Default: - No memory reserved.
placement_constraints (Optional[Sequence[PlacementConstraint]]) – The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints. Default: - No constraints.
placement_strategies (Optional[Sequence[PlacementStrategy]]) – The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies. Default: - No strategies.
task_definition (Optional[Ec2TaskDefinition]) – The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified. [disable-awslint:ref-via-interface] Default: - none

ExampleMetadata

infused

Example:

# Two network load balancers, each with their own listener and target group.
# cluster: ecs.Cluster

load_balanced_ec2_service = ecs_patterns.NetworkMultipleTargetGroupsEc2Service(self, "Service",
    cluster=cluster,
    memory_limit_mi_b=256,
    task_image_options=ecsPatterns.NetworkLoadBalancedTaskImageProps(
        image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample")
    ),
    load_balancers=[ecsPatterns.NetworkLoadBalancerProps(
        name="lb1",
        listeners=[ecsPatterns.NetworkListenerProps(
            name="listener1"
        )
        ]
    ), ecsPatterns.NetworkLoadBalancerProps(
        name="lb2",
        listeners=[ecsPatterns.NetworkListenerProps(
            name="listener2"
        )
        ]
    )
    ],
    target_groups=[ecsPatterns.NetworkTargetProps(
        container_port=80,
        listener="listener1"
    ), ecsPatterns.NetworkTargetProps(
        container_port=90,
        listener="listener2"
    )
    ]
)

Attributes

cloud_map_options¶

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

Default

AWS Cloud Map service discovery is not enabled.

Return type

Optional[CloudMapOptions]

cluster¶

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.

Default

create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

Return type

Optional[ICluster]

cpu¶

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

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

Default

No minimum CPU units reserved.

Return type

Union[int, float, None]

desired_count¶

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

The minimum value is 1

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.

Return type: Union[int, float, None]

enable_ecs_managed_tags¶

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

For more information, see Tagging Your Amazon ECS Resources

Default: false
Return type: Optional[bool]

health_check_grace_period¶

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.

Default

defaults to 60 seconds if at least one load balancer is in-use and it is not already set

Return type

Optional[Duration]

load_balancers¶

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

Default

a new load balancer with a listener will be created.

Return type

Optional[List[NetworkLoadBalancerProps]]

memory_limit_mib¶

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.

Default

No memory limit.

Return type

Union[int, float, None]

memory_reservation_mib¶

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.

Default

No memory reserved.

Return type

Union[int, float, None]

placement_constraints¶

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.

Default

No constraints.

Return type

Optional[List[PlacementConstraint]]

placement_strategies¶

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.

Default

No strategies.

Return type

Optional[List[PlacementStrategy]]

propagate_tags¶

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.

Default

none

Return type

Optional[PropagatedTagSource]

service_name¶

Name of the service.

Default

CloudFormation-generated name.

Return type

Optional[str]

target_groups¶

Properties to specify NLB target groups.

Default

default portMapping registered as target group and attached to the first defined listener

Return type

Optional[List[NetworkTargetProps]]

task_definition¶

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

[disable-awslint:ref-via-interface]

Default

none

Return type

Optional[Ec2TaskDefinition]

task_image_options¶

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

Default

none

Return type

Optional[NetworkLoadBalancedTaskImageProps]

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.

Default

uses the VPC defined in the cluster or creates a new VPC.

Return type

Optional[IVpc]