AWS CDK Reference

Appearance

v2.274.0

NetworkLoadBalancedServiceBase L3 construct ​

The base class for NetworkLoadBalancedEc2Service and NetworkLoadBalancedFargateService services.

Source
aws-ecs-patterns/lib/base/network-load-balanced-service-base.ts

Initializer ​

ts
new NetworkLoadBalancedServiceBase(scope: Construct, id: string, props?: NetworkLoadBalancedServiceBaseProps)
python
NetworkLoadBalancedServiceBase(scope: Construct, id: str, props: typing.Optional[NetworkLoadBalancedServiceBaseProps] = None)
java
new NetworkLoadBalancedServiceBase(Construct scope, String id, NetworkLoadBalancedServiceBaseProps props)
csharp
new NetworkLoadBalancedServiceBase(Construct scope, string id, NetworkLoadBalancedServiceBaseProps? props = null)
go
NewNetworkLoadBalancedServiceBase(Scope Construct, Id *string, Props NetworkLoadBalancedServiceBaseProps)

Construct Props ​

capacityProviderStrategiesoptionalCapacityProviderStrategy[]capacity_provider_strategiesoptionaltyping.List[CapacityProviderStrategy]capacityProviderStrategiesoptionalList<CapacityProviderStrategy>CapacityProviderStrategiesoptionalCapacityProviderStrategy[]CapacityProviderStrategiesoptional*[]CapacityProviderStrategy= undefined#
A list of Capacity Provider strategies used to place a service.
circuitBreakeroptionalDeploymentCircuitBreakercircuit_breakeroptionalDeploymentCircuitBreakercircuitBreakeroptionalDeploymentCircuitBreakerCircuitBreakeroptionalDeploymentCircuitBreakerCircuitBreakeroptionalDeploymentCircuitBreaker= disabled#
Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

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

Default: AWS Cloud Map service discovery is not enabled.

clusteroptionalIClusterclusteroptionalIClusterclusteroptionalIClusterClusteroptionalIClusterClusteroptionalICluster#
The name of the cluster that hosts the service.

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

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

deploymentControlleroptionalDeploymentControllerdeployment_controlleroptionalDeploymentControllerdeploymentControlleroptionalDeploymentControllerDeploymentControlleroptionalDeploymentControllerDeploymentControlleroptionalDeploymentController#
Specifies which deployment controller to use for the service.

Default: Rolling update (ECS)

For more information, see Amazon ECS Deployment Types

desiredCountoptionalnumberdesired_countoptionalint | floatdesiredCountoptionalNumberDesiredCountoptionaldoubleDesiredCountoptional*float64#
The desired number of instantiations of the task definition to keep running on the service.

Default: The default is 1 for all new services and uses the existing service's desired count when updating an existing service.

The minimum value is 1

domainNameoptionalstringdomain_nameoptionalstrdomainNameoptionalStringDomainNameoptionalstringDomainNameoptional*string#
The domain name for the service, e.g. "api.example.com.".

Default: No domain name.

domainZoneoptionalIHostedZonedomain_zoneoptionalIHostedZonedomainZoneoptionalIHostedZoneDomainZoneoptionalIHostedZoneDomainZoneoptionalIHostedZone#
The Route53 hosted zone for the domain, e.g. "example.com.".

Default: No Route53 hosted domain zone.

enableECSManagedTagsoptionalbooleanenable_ecs_managed_tagsoptionalboolenableECSManagedTagsoptionalBooleanEnableECSManagedTagsoptionalboolEnableECSManagedTagsoptional*bool= false#
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

enableExecuteCommandoptionalbooleanenable_execute_commandoptionalboolenableExecuteCommandoptionalBooleanEnableExecuteCommandoptionalboolEnableExecuteCommandoptional*bool= false#
Whether ECS Exec should be enabled.
healthCheckGracePeriodoptionalDurationhealth_check_grace_periodoptionalDurationhealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDuration#
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

ipAddressTypeoptionalIpAddressTypeip_address_typeoptionalIpAddressTypeipAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressType= IpAddressType.IPV4#
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.

listenerCertificateoptionalIListenerCertificatelistener_certificateoptionalIListenerCertificatelistenerCertificateoptionalIListenerCertificateListenerCertificateoptionalIListenerCertificateListenerCertificateoptionalIListenerCertificate= none#
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.

listenerPortoptionalnumberlistener_portoptionalint | floatlistenerPortoptionalNumberListenerPortoptionaldoubleListenerPortoptional*float64#
Listener port of the network load balancer that will serve traffic to the service.

Default: 80 or 443 with listenerCertificate provided

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

Default: a new load balancer will be created.

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

[disable-awslint:ref-via-interface]

maxHealthyPercentoptionalnumbermax_healthy_percentoptionalint | floatmaxHealthyPercentoptionalNumberMaxHealthyPercentoptionaldoubleMaxHealthyPercentoptional*float64#
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

minHealthyPercentoptionalnumbermin_healthy_percentoptionalint | floatminHealthyPercentoptionalNumberMinHealthyPercentoptionaldoubleMinHealthyPercentoptional*float64#
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

propagateTagsoptionalPropagatedTagSourcepropagate_tagsoptionalPropagatedTagSourcepropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSource= 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.

publicLoadBalanceroptionalbooleanpublic_load_balanceroptionalboolpublicLoadBalanceroptionalBooleanPublicLoadBalanceroptionalboolPublicLoadBalanceroptional*bool= true#
Determines whether the Load Balancer will be internet-facing.
recordTypeoptionalNetworkLoadBalancedServiceRecordTyperecord_typeoptionalNetworkLoadBalancedServiceRecordTyperecordTypeoptionalNetworkLoadBalancedServiceRecordTypeRecordTypeoptionalNetworkLoadBalancedServiceRecordTypeRecordTypeoptionalNetworkLoadBalancedServiceRecordType#
Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.

Default: NetworkLoadBalancedServiceRecordType.ALIAS

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

serviceNameoptionalstringservice_nameoptionalstrserviceNameoptionalStringServiceNameoptionalstringServiceNameoptional*string#
The name of the service.

Default: CloudFormation-generated name.

taskImageOptionsoptionalNetworkLoadBalancedTaskImageOptionstask_image_optionsoptionalNetworkLoadBalancedTaskImageOptionstaskImageOptionsoptionalNetworkLoadBalancedTaskImageOptionsTaskImageOptionsoptionalNetworkLoadBalancedTaskImageOptionsTaskImageOptionsoptionalNetworkLoadBalancedTaskImageOptions= none#
The properties required to create a new task definition.

One of taskImageOptions or taskDefinition must be specified.

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

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

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

Properties ​

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#
The cluster that hosts the service.
internalDesiredCountmay be undefinednumberinternal_desired_countmay be undefinedint | floatinternalDesiredCountmay be undefinedNumberInternalDesiredCountmay be undefineddoubleInternalDesiredCountmay be undefined*float64#
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.

listenerNetworkListenerlistenerNetworkListenerlistenerNetworkListenerListenerNetworkListenerListenerNetworkListenerrequired#
The listener for the service.
loadBalancerNetworkLoadBalancerload_balancerNetworkLoadBalancerloadBalancerNetworkLoadBalancerLoadBalancerNetworkLoadBalancerLoadBalancerNetworkLoadBalancerrequired#
The Network Load Balancer for the service.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
targetGroupNetworkTargetGrouptarget_groupNetworkTargetGrouptargetGroupNetworkTargetGroupTargetGroupNetworkTargetGroupTargetGroupNetworkTargetGrouprequired#
The target group for the service.

Methods ​

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct 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 class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof 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 the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining