software.amazon.awscdk.services.ecs.patterns

Class NetworkLoadBalancedServiceBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

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

All Implemented Interfaces:

IConstruct, IDependable

Direct Known Subclasses:

NetworkLoadBalancedEc2Service, NetworkLoadBalancedFargateService

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:01.635Z")
public abstract class NetworkLoadBalancedServiceBase
extends Construct

The base class for NetworkLoadBalancedEc2Service and NetworkLoadBalancedFargateService services.

Nested Class Summary

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

IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addServiceAsTarget(BaseService service) Adds service as a target of the target group.
protected AwsLogDriver	createAWSLogDriver(java.lang.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.
java.lang.Number	getDesiredCount() Deprecated. - Use `internalDesiredCount` instead.
java.lang.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 java.lang.Object

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

Constructor Detail

NetworkLoadBalancedServiceBase

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

NetworkLoadBalancedServiceBase

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

NetworkLoadBalancedServiceBase

protected NetworkLoadBalancedServiceBase(software.constructs.Construct scope,
                                         java.lang.String id,
                                         NetworkLoadBalancedServiceBaseProps props)

Constructs a new instance of the NetworkLoadBalancedServiceBase class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

NetworkLoadBalancedServiceBase

protected NetworkLoadBalancedServiceBase(software.constructs.Construct scope,
                                         java.lang.String id)

Constructs a new instance of the NetworkLoadBalancedServiceBase class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addServiceAsTarget

protected void addServiceAsTarget(BaseService service)

Adds service as a target of the target group.

Parameters:

service - This parameter is required.

createAWSLogDriver

protected AwsLogDriver createAWSLogDriver(java.lang.String prefix)

Parameters:

prefix - This parameter is required.

getDefaultCluster

protected Cluster getDefaultCluster(Construct scope,
                                    IVpc vpc)

Returns the default cluster.

Parameters:

scope - This parameter is required.

vpc -

getDefaultCluster

protected Cluster getDefaultCluster(Construct scope)

Returns the default cluster.

Parameters:

scope - This parameter is required.

getCluster

public ICluster getCluster()

The cluster that hosts the service.

getDesiredCount

@Deprecated
public java.lang.Number getDesiredCount()

Deprecated. - Use `internalDesiredCount` instead.

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

getListener

public NetworkListener getListener()

The listener for the service.

getLoadBalancer

public NetworkLoadBalancer getLoadBalancer()

The Network Load Balancer for the service.

getTargetGroup

public NetworkTargetGroup getTargetGroup()

The target group for the service.

getInternalDesiredCount

public java.lang.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.