NetworkLoadBalancedFargateServiceProps
- class aws_cdk.aws_ecs_patterns.NetworkLoadBalancedFargateServiceProps(*, 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_certificate=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, ephemeral_storage_gib=None, memory_limit_mib=None, platform_version=None, runtime_platform=None, task_definition=None, assign_public_ip=None, security_groups=None, task_subnets=None)
Bases:
NetworkLoadBalancedServiceBaseProps
,FargateServiceBaseProps
The properties for the NetworkLoadBalancedFargateService service.
- Parameters:
capacity_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_certificate (
Optional
[IListenerCertificate
]) – Listener certificate list of ACM cert ARNs. If you provide a certificate, the listener’s protocol will be TLS. If not, the listener’s protocol will be TCP. Default: - nonelistener_port (
Union
[int
,float
,None
]) – Listener port of the network load balancer that will serve traffic to the service. Default: 80 or 443 with listenerCertificate providedload_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.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 8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments 16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments This default is set in the underlying FargateTaskDefinition construct. Default: 256ephemeral_storage_gib (
Union
[int
,float
,None
]) – The amount (in GiB) of ephemeral storage to be allocated to the task. The minimum supported value is21
GiB and the maximum supported value is200
GiB. Only supported in Fargate platform version 1.4.0 or later. Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.memory_limit_mib (
Union
[int
,float
,None
]) – The amount (in MiB) of memory used by the task. This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU) Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU) This default is set in the underlying FargateTaskDefinition construct. Default: 512platform_version (
Optional
[FargatePlatformVersion
]) – The platform version on which to run your service. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. Default: Latestruntime_platform (
Union
[RuntimePlatform
,Dict
[str
,Any
],None
]) – The runtime platform of the task definition. Default: - If the property is undefined,operatingSystemFamily
is LINUX andcpuArchitecture
is X86_64task_definition (
Optional
[FargateTaskDefinition
]) – 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: - noneassign_public_ip (
Optional
[bool
]) – Determines whether the service will be assigned a public IP address. Default: falsesecurity_groups (
Optional
[Sequence
[ISecurityGroup
]]) – The security groups to associate with the service. If you do not specify a security group, a new security group is created. Default: - A new security group is created.task_subnets (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – The subnets to associate with the service. Default: - Public subnets ifassignPublicIp
is set, otherwise the first available one of Private, Isolated, Public, in that order.
- ExampleMetadata:
infused
Example:
from aws_cdk.aws_certificatemanager import Certificate certificate = Certificate.from_certificate_arn(self, "Cert", "arn:aws:acm:us-east-1:123456:certificate/abcdefg") load_balanced_fargate_service = ecs_patterns.NetworkLoadBalancedFargateService(self, "Service", # The default value of listenerPort is 443 if you pass in listenerCertificate # It is configured to port 4443 here listener_port=4443, listener_certificate=certificate, task_image_options=ecsPatterns.NetworkLoadBalancedTaskImageOptions( image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample"), # The default value of containerPort is 443 if you pass in listenerCertificate # It is configured to port 8443 here container_port=8443 ) )
Attributes
- assign_public_ip
Determines whether the service will be assigned a public IP address.
- Default:
false
- capacity_provider_strategies
A list of Capacity Provider strategies used to place a service.
- Default:
undefined
- circuit_breaker
Whether to enable the deployment circuit breaker.
If this property is defined, circuit breaker will be implicitly enabled.
- Default:
disabled
- cloud_map_options
The options for configuring an Amazon ECS service to use service discovery.
- Default:
AWS Cloud Map service discovery is not enabled.
- 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.
- 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
8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments
16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments
This default is set in the underlying FargateTaskDefinition construct.
- Default:
256
- deployment_controller
Specifies which deployment controller to use for the service.
For more information, see Amazon ECS Deployment Types
- Default:
Rolling update (ECS)
- desired_count
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
The domain name for the service, e.g. “api.example.com.”.
- Default:
No domain name.
- domain_zone
The Route53 hosted zone for the domain, e.g. “example.com.”.
- Default:
No Route53 hosted domain zone.
- 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
- enable_execute_command
Whether ECS Exec should be enabled.
- Default:
false
- ephemeral_storage_gib
The amount (in GiB) of ephemeral storage to be allocated to the task.
The minimum supported value is
21
GiB and the maximum supported value is200
GiB.Only supported in Fargate platform version 1.4.0 or later.
- Default:
Undefined, in which case, the task will receive 20GiB ephemeral storage.
- 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
- ip_address_type
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.IPV4
- See:
https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-ip-address-type.html
- listener_certificate
Listener certificate list of ACM cert ARNs.
If you provide a certificate, the listener’s protocol will be TLS. If not, the listener’s protocol will be TCP.
- Default:
none
- listener_port
Listener port of the network load balancer that will serve traffic to the service.
- Default:
80 or 443 with listenerCertificate provided
- 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.
- 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
- memory_limit_mib
The amount (in MiB) of memory used by the task.
This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)
Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
This default is set in the underlying FargateTaskDefinition construct.
- Default:
512
- 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
- platform_version
The platform version on which to run your service.
If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
- Default:
Latest
- 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
- public_load_balancer
Determines whether the Load Balancer will be internet-facing.
- Default:
true
- 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
- runtime_platform
The runtime platform of the task definition.
- Default:
If the property is undefined,
operatingSystemFamily
is LINUX andcpuArchitecture
is X86_64
- security_groups
The security groups to associate with the service.
If you do not specify a security group, a new security group is created.
- Default:
A new security group is created.
- service_name
The name of the service.
- Default:
CloudFormation-generated name.
- 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
- task_image_options
The properties required to create a new task definition.
One of taskImageOptions or taskDefinition must be specified.
- Default:
none
- task_subnets
The subnets to associate with the service.
- Default:
Public subnets if
assignPublicIp
is set, otherwise the first available one of Private, Isolated, Public, in that order.
- 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.