NetworkLoadBalancedEc2ServiceProps

class aws_cdk.aws_ecs_patterns.NetworkLoadBalancedEc2ServiceProps(*, cloud_map_options=None, cluster=None, deployment_controller=None, desired_count=None, domain_name=None, domain_zone=None, enable_ecs_managed_tags=None, health_check_grace_period=None, listener_port=None, load_balancer=None, max_healthy_percent=None, min_healthy_percent=None, propagate_tags=None, public_load_balancer=None, record_type=None, service_name=None, task_image_options=None, vpc=None, cpu=None, memory_limit_mib=None, memory_reservation_mib=None, task_definition=None)

Bases: aws_cdk.aws_ecs_patterns.NetworkLoadBalancedServiceBaseProps

The properties for the NetworkLoadBalancedEc2Service 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.

  • deployment_controller (Optional[DeploymentController]) – Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types Default: - Rolling update (ECS)

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

  • domain_name (Optional[str]) – The domain name for the service, e.g. “api.example.com.”. Default: - No domain name.

  • domain_zone (Optional[IHostedZone]) – The Route53 hosted zone for the domain, e.g. “example.com.”. Default: - No Route53 hosted domain zone.

  • 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

  • listener_port (Union[int, float, None]) – Listener port of the network load balancer that will serve traffic to the service. Default: 80

  • load_balancer (Optional[INetworkLoadBalancer]) – The network load balancer that will serve traffic to the service. If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes(). [disable-awslint:ref-via-interface] Default: - a new load balancer will be created.

  • max_healthy_percent (Union[int, float, None]) – The maximum number of tasks, specified as a percentage of the Amazon ECS service’s DesiredCount value, that can run in a service during a deployment. Default: - 100 if daemon, otherwise 200

  • min_healthy_percent (Union[int, float, None]) – The minimum number of tasks, specified as a percentage of the Amazon ECS service’s DesiredCount value, that must continue to run and remain healthy during a deployment. Default: - 0 if daemon, otherwise 50

  • 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

  • public_load_balancer (Optional[bool]) – Determines whether the Load Balancer will be internet-facing. Default: true

  • record_type (Optional[NetworkLoadBalancedServiceRecordType]) – Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. This is useful if you need to work with DNS systems that do not support alias records. Default: NetworkLoadBalancedServiceRecordType.ALIAS

  • service_name (Optional[str]) – The name of the service. Default: - CloudFormation-generated name.

  • task_image_options (Optional[NetworkLoadBalancedTaskImageOptions]) – The properties required to create a new task definition. One of taskImageOptions or taskDefinition 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 number of cpu units used by the task. Valid values, which determines your range of valid values for the memory parameter: 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments This default is set in the underlying FargateTaskDefinition construct. Default: none

  • memory_limit_mib (Union[int, float, None]) – The hard limit (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 contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first. At least one of memoryLimitMiB and memoryReservationMiB is required. Default: - No memory reserved.

  • task_definition (Optional[Ec2TaskDefinition]) – The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.. [disable-awslint:ref-via-interface] Default: - none

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 number of cpu units used by the task.

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

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

This default is set in the underlying FargateTaskDefinition construct.

Default

none

Return type

Union[int, float, None]

deployment_controller

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default

  • Rolling update (ECS)

Return type

Optional[DeploymentController]

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]

domain_name

The domain name for the service, e.g. “api.example.com.”.

Default

  • No domain name.

Return type

Optional[str]

domain_zone

The Route53 hosted zone for the domain, e.g. “example.com.”.

Default

  • No Route53 hosted domain zone.

Return type

Optional[IHostedZone]

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]

listener_port

Listener port of the network load balancer that will serve traffic to the service.

Default

80

Return type

Union[int, float, None]

load_balancer

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

If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes().

[disable-awslint:ref-via-interface]

Default

  • a new load balancer will be created.

Return type

Optional[INetworkLoadBalancer]

max_healthy_percent

The maximum number of tasks, specified as a percentage of the Amazon ECS service’s DesiredCount value, that can run in a service during a deployment.

Default

  • 100 if daemon, otherwise 200

Return type

Union[int, float, None]

memory_limit_mib

The hard limit (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 contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Default

  • No memory reserved.

Return type

Union[int, float, None]

min_healthy_percent

The minimum number of tasks, specified as a percentage of the Amazon ECS service’s DesiredCount value, that must continue to run and remain healthy during a deployment.

Default

  • 0 if daemon, otherwise 50

Return type

Union[int, float, None]

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]

public_load_balancer

Determines whether the Load Balancer will be internet-facing.

Default

true

Return type

Optional[bool]

record_type

Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.

This is useful if you need to work with DNS systems that do not support alias records.

Default

NetworkLoadBalancedServiceRecordType.ALIAS

Return type

Optional[NetworkLoadBalancedServiceRecordType]

service_name

The name of the service.

Default

  • CloudFormation-generated name.

Return type

Optional[str]

task_definition

The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both..

[disable-awslint:ref-via-interface]

Default

  • none

Return type

Optional[Ec2TaskDefinition]

task_image_options

The properties required to create a new task definition.

One of taskImageOptions or taskDefinition must be specified.

Default

  • none

Return type

Optional[NetworkLoadBalancedTaskImageOptions]

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]