aws-cdk-lib.aws_ecs_patterns.NetworkMultipleTargetGroupsServiceBase

class NetworkMultipleTargetGroupsServiceBase

LanguageType name
.NETAmazon.CDK.AWS.ECS.Patterns.NetworkMultipleTargetGroupsServiceBase
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#NetworkMultipleTargetGroupsServiceBase
Javasoftware.amazon.awscdk.services.ecs.patterns.NetworkMultipleTargetGroupsServiceBase
Pythonaws_cdk.aws_ecs_patterns.NetworkMultipleTargetGroupsServiceBase
TypeScript (source)aws-cdk-lib » aws_ecs_patterns » NetworkMultipleTargetGroupsServiceBase

Implements IConstruct, IDependable

Extends Construct

Implemented by NetworkMultipleTargetGroupsEc2Service, NetworkMultipleTargetGroupsFargateService

The base class for NetworkMultipleTargetGroupsEc2Service and NetworkMultipleTargetGroupsFargateService classes.

Initializer

new NetworkMultipleTargetGroupsServiceBase(scope: Construct, id: string, props?: NetworkMultipleTargetGroupsServiceBaseProps)

Parameters

  • scope Construct
  • id string
  • props NetworkMultipleTargetGroupsServiceBaseProps

Constructs a new instance of the NetworkMultipleTargetGroupsServiceBase class.

Properties

NameTypeDescription
clusterIClusterThe cluster that hosts the service.
listener⚠️NetworkListenerThe listener for the service.
listenersNetworkListener[]The listeners of the service.
loadBalancer⚠️NetworkLoadBalancerThe Network Load Balancer for the service.
loadBalancersNetworkLoadBalancer[]The load balancers of the service.
nodeNodeThe tree node.
targetGroupsNetworkTargetGroup[]The target groups of the service.
internalDesiredCount?numberThe desired number of instantiations of the task definition to keep running on the service.
logDriver?LogDriver

cluster

Type: ICluster

The cluster that hosts the service.


listener⚠️

⚠️ Deprecated: - Use listeners instead.

Type: NetworkListener

The listener for the service.


listeners

Type: NetworkListener[]

The listeners of the service.


loadBalancer⚠️

⚠️ Deprecated: - Use loadBalancers instead.

Type: NetworkLoadBalancer

The Network Load Balancer for the service.


loadBalancers

Type: NetworkLoadBalancer[]

The load balancers of the service.


node

Type: Node

The tree node.


targetGroups

Type: NetworkTargetGroup[]

The target groups of 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.


logDriver?

Type: LogDriver (optional)

Methods

NameDescription
toString()Returns a string representation of this construct.
protected addPortMappingForTargets(container, targets)
protected createAWSLogDriver(prefix)
protected findListener(name?)
protected getDefaultCluster(scope, vpc?)Returns the default cluster.
protected registerECSTargets(service, container, targets)

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected addPortMappingForTargets(container, targets)

protected addPortMappingForTargets(container: ContainerDefinition, targets: NetworkTargetProps[]): void

Parameters

  • container ContainerDefinition
  • targets NetworkTargetProps[]

protected createAWSLogDriver(prefix)

protected createAWSLogDriver(prefix: string): AwsLogDriver

Parameters

  • prefix string

Returns

  • AwsLogDriver

protected findListener(name?)

protected findListener(name?: string): NetworkListener

Parameters

  • name string

Returns

  • NetworkListener

protected getDefaultCluster(scope, vpc?)

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

Parameters

  • scope Construct
  • vpc IVpc

Returns

  • Cluster

Returns the default cluster.


protected registerECSTargets(service, container, targets)

protected registerECSTargets(service: BaseService, container: ContainerDefinition, targets: NetworkTargetProps[]): NetworkTargetGroup

Parameters

  • service BaseService
  • container ContainerDefinition
  • targets NetworkTargetProps[]

Returns

  • NetworkTargetGroup