NetworkLoadBalancedEc2Service
- class aws_cdk.aws_ecs_patterns.NetworkLoadBalancedEc2Service(scope, id, *, cpu=None, memory_limit_mib=None, memory_reservation_mib=None, placement_constraints=None, placement_strategies=None, task_definition=None, capacity_provider_strategies=None, circuit_breaker=None, cloud_map_options=None, cluster=None, deployment_controller=None, desired_count=None, domain_name=None, domain_zone=None, enable_ecs_managed_tags=None, enable_execute_command=None, health_check_grace_period=None, ip_address_type=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)
Bases:
NetworkLoadBalancedServiceBase
An EC2 service running on an ECS cluster fronted by a network load balancer.
- ExampleMetadata:
infused
Example:
# cluster: ecs.Cluster load_balanced_ecs_service = ecs_patterns.NetworkLoadBalancedEc2Service(self, "Service", cluster=cluster, memory_limit_mi_b=1024, task_image_options=ecsPatterns.NetworkLoadBalancedTaskImageOptions( image=ecs.ContainerImage.from_registry("test"), environment={ "TEST_ENVIRONMENT_VARIABLE1": "test environment variable 1 value", "TEST_ENVIRONMENT_VARIABLE2": "test environment variable 2 value" } ), desired_count=2 )
Constructs a new instance of the NetworkLoadBalancedEc2Service class.
- Parameters:
scope (
Construct
) –id (
str
) –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: nonememory_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.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. TaskDefinition or TaskImageOptions must be specified, but not both.. [disable-awslint:ref-via-interface] Default: - nonecapacity_provider_strategies (
Optional
[Sequence
[Union
[CapacityProviderStrategy
,Dict
[str
,Any
]]]]) – A list of Capacity Provider strategies used to place a service. Default: - undefinedcircuit_breaker (
Union
[DeploymentCircuitBreaker
,Dict
[str
,Any
],None
]) – Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled. Default: - disabledcloud_map_options (
Union
[CloudMapOptions
,Dict
[str
,Any
],None
]) – 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 (
Union
[DeploymentController
,Dict
[str
,Any
],None
]) – 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: - The default is 1 for all new services and uses the existing service’s 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: falseenable_execute_command (
Optional
[bool
]) – Whether ECS Exec should be enabled. Default: - falsehealth_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 setip_address_type (
Optional
[IpAddressType
]) – The type of IP addresses to use. If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4. Default: IpAddressType.IPV4listener_port (
Union
[int
,float
,None
]) – Listener port of the network load balancer that will serve traffic to the service. Default: 80load_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 200min_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 50propagate_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: - nonepublic_load_balancer (
Optional
[bool
]) – Determines whether the Load Balancer will be internet-facing. Default: truerecord_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.ALIASservice_name (
Optional
[str
]) – The name of the service. Default: - CloudFormation-generated name.task_image_options (
Union
[NetworkLoadBalancedTaskImageOptions
,Dict
[str
,Any
],None
]) – The properties required to create a new task definition. One of taskImageOptions or taskDefinition must be specified. Default: - nonevpc (
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.
Methods
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- cluster
The cluster that hosts the service.
- internal_desired_count
The desired number of instantiations of the task definition to keep running on the service.
The default is 1 for all new services and uses the existing services desired count when updating an existing service, if one is not provided.
- listener
The listener for the service.
- load_balancer
The Network Load Balancer for the service.
- node
The tree node.
- service
The ECS service in this construct.
- target_group
The target group for the service.
- task_definition
The EC2 Task Definition in this construct.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.