class NetworkLoadBalancedServiceBase

Language	Type name
.NET	Amazon.CDK.AWS.ECS.Patterns.NetworkLoadBalancedServiceBase
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#NetworkLoadBalancedServiceBase
Java	software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceBase
Python	aws_cdk.aws_ecs_patterns.NetworkLoadBalancedServiceBase
TypeScript (source)	aws-cdk-lib » aws_ecs_patterns » NetworkLoadBalancedServiceBase

Implements IConstruct, IDependable

Extends Construct

Implemented by NetworkLoadBalancedEc2Service, NetworkLoadBalancedFargateService

The base class for NetworkLoadBalancedEc2Service and NetworkLoadBalancedFargateService services.

Initializer

new NetworkLoadBalancedServiceBase(scope: Construct, id: string, props?: NetworkLoadBalancedServiceBaseProps)

Parameters

• scope Construct
• id string
• props NetworkLoadBalancedServiceBaseProps

Constructs a new instance of the NetworkLoadBalancedServiceBase class.

Properties

Name	Type	Description
cluster	ICluster	The cluster that hosts the service.
listener	NetworkListener	The listener for the service.
loadBalancer	NetworkLoadBalancer	The Network Load Balancer for the service.
node	Node	The tree node.
targetGroup	NetworkTargetGroup	The target group for the service.
internalDesiredCount?	number	The desired number of instantiations of the task definition to keep running on the service.

---

cluster

Type: ICluster

The cluster that hosts the service.

---

listener

Type: NetworkListener

The listener for the service.

---

loadBalancer

Type: NetworkLoadBalancer

The Network Load Balancer for the service.

---

node

Type: Node

The tree node.

---

targetGroup

Type: NetworkTargetGroup

The target group for the service.

---

internalDesiredCount?

Type: number (optional)

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.

Methods

Name	Description
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.
protected addServiceAsTarget(service)	Adds service as a target of the target group.
protected createAWSLogDriver(prefix)
protected getDefaultCluster(scope, vpc?)	Returns the default cluster.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

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

---

protected addServiceAsTarget(service)

protected addServiceAsTarget(service: BaseService): void

Parameters

• service BaseService

Adds service as a target of the target group.

---

protected createAWSLogDriver(prefix)

protected createAWSLogDriver(prefix: string): AwsLogDriver

Parameters

• prefix string

Returns

• AwsLogDriver

---

protected getDefaultCluster(scope, vpc?)

protected getDefaultCluster(scope: Construct, vpc?: IVpc): Cluster

Parameters

• scope Construct
• vpc IVpc

Returns

• Cluster

Returns the default cluster.