Package software.amazon.awscdk.services.ecs.patterns

Class NetworkLoadBalancedServiceBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceBase

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

NetworkLoadBalancedEc2Service, NetworkLoadBalancedFargateService

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:20.427Z")
@Stability(Stable)
public abstract class NetworkLoadBalancedServiceBase
extends Construct

The base class for NetworkLoadBalancedEc2Service and NetworkLoadBalancedFargateService services.

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NetworkLoadBalancedServiceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkLoadBalancedServiceBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	NetworkLoadBalancedServiceBase(software.constructs.Construct scope, String id)	Constructs a new instance of the NetworkLoadBalancedServiceBase class.
protected	NetworkLoadBalancedServiceBase(software.constructs.Construct scope, String id, NetworkLoadBalancedServiceBaseProps props)	Constructs a new instance of the NetworkLoadBalancedServiceBase class.

Method Summary

Modifier and Type	Method	Description
protected void	addServiceAsTarget(BaseService service)	Adds service as a target of the target group.
protected AwsLogDriver	createAWSLogDriver(String prefix)
ICluster	getCluster()	The cluster that hosts the service.
protected Cluster	getDefaultCluster(Construct scope)	Returns the default cluster.
protected Cluster	getDefaultCluster(Construct scope, IVpc vpc)	Returns the default cluster.
Number	getDesiredCount()	Deprecated. - Use `internalDesiredCount` instead.
Number	getInternalDesiredCount()	The desired number of instantiations of the task definition to keep running on the service.
NetworkListener	getListener()	The listener for the service.
NetworkLoadBalancer	getLoadBalancer()	The Network Load Balancer for the service.
NetworkTargetGroup	getTargetGroup()	The target group for the service.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

NetworkLoadBalancedServiceBase

protected NetworkLoadBalancedServiceBase(software.amazon.jsii.JsiiObjectRef objRef)

NetworkLoadBalancedServiceBase

protected NetworkLoadBalancedServiceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

NetworkLoadBalancedServiceBase

@Stability(Stable)
protected NetworkLoadBalancedServiceBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 NetworkLoadBalancedServiceBaseProps props)

Constructs a new instance of the NetworkLoadBalancedServiceBase class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

NetworkLoadBalancedServiceBase

@Stability(Stable)
protected NetworkLoadBalancedServiceBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Constructs a new instance of the NetworkLoadBalancedServiceBase class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

addServiceAsTarget

@Stability(Stable)
protected void addServiceAsTarget(@NotNull
 BaseService service)

Adds service as a target of the target group.

Parameters:

service - This parameter is required.

createAWSLogDriver

@Stability(Stable)
@NotNull
protected AwsLogDriver createAWSLogDriver(@NotNull
 String prefix)

Parameters:

prefix - This parameter is required.

getDefaultCluster

@Stability(Stable)
@NotNull
protected Cluster getDefaultCluster(@NotNull
 Construct scope,
 @Nullable
 IVpc vpc)

Returns the default cluster.

Parameters:

scope - This parameter is required.

vpc -

getDefaultCluster

@Stability(Stable)
@NotNull
protected Cluster getDefaultCluster(@NotNull
 Construct scope)

Returns the default cluster.

Parameters:

scope - This parameter is required.

getCluster

@Stability(Stable)
@NotNull
public ICluster getCluster()

The cluster that hosts the service.

getDesiredCount

@Stability(Deprecated)
@Deprecated
@NotNull
public Number getDesiredCount()

Deprecated.

- Use `internalDesiredCount` instead.

(deprecated) The desired number of instantiations of the task definition to keep running on the service.

getListener

@Stability(Stable)
@NotNull
public NetworkListener getListener()

The listener for the service.

getLoadBalancer

@Stability(Stable)
@NotNull
public NetworkLoadBalancer getLoadBalancer()

The Network Load Balancer for the service.

getTargetGroup

@Stability(Stable)
@NotNull
public NetworkTargetGroup getTargetGroup()

The target group for the service.

getInternalDesiredCount

@Stability(Stable)
@Nullable
public Number getInternalDesiredCount()

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.