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

Class NetworkMultipleTargetGroupsServiceBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.ecs.patterns.NetworkMultipleTargetGroupsServiceBase

All Implemented Interfaces:

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

Direct Known Subclasses:

NetworkMultipleTargetGroupsEc2Service, NetworkMultipleTargetGroupsFargateService

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

The base class for NetworkMultipleTargetGroupsEc2Service and NetworkMultipleTargetGroupsFargateService classes.

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	NetworkMultipleTargetGroupsServiceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkMultipleTargetGroupsServiceBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	NetworkMultipleTargetGroupsServiceBase(software.constructs.Construct scope, String id)	Constructs a new instance of the NetworkMultipleTargetGroupsServiceBase class.
protected	NetworkMultipleTargetGroupsServiceBase(software.constructs.Construct scope, String id, NetworkMultipleTargetGroupsServiceBaseProps props)	Constructs a new instance of the NetworkMultipleTargetGroupsServiceBase class.

Method Summary

Modifier and Type	Method	Description
protected void	addPortMappingForTargets(ContainerDefinition container, List<NetworkTargetProps> targets)
protected AwsLogDriver	createAWSLogDriver(String prefix)
protected NetworkListener	findListener()
protected NetworkListener	findListener(String name)
ICluster	getCluster()	The cluster that hosts the service.
protected Cluster	getDefaultCluster(software.constructs.Construct scope)	Returns the default cluster.
protected Cluster	getDefaultCluster(software.constructs.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.
protected List<NetworkListener>	getListeners()
NetworkLoadBalancer	getLoadBalancer()	The Network Load Balancer for the service.
protected LogDriver	getLogDriver()
protected List<NetworkTargetGroup>	getTargetGroups()
protected NetworkTargetGroup	registerECSTargets(BaseService service, ContainerDefinition container, List<NetworkTargetProps> targets)
protected void	setListeners(List<NetworkListener> value)
protected void	setLogDriver(LogDriver value)
protected void	setTargetGroups(List<NetworkTargetGroup> value)

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

NetworkMultipleTargetGroupsServiceBase

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

NetworkMultipleTargetGroupsServiceBase

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

NetworkMultipleTargetGroupsServiceBase

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

Constructs a new instance of the NetworkMultipleTargetGroupsServiceBase class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

NetworkMultipleTargetGroupsServiceBase

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

Constructs a new instance of the NetworkMultipleTargetGroupsServiceBase class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

addPortMappingForTargets

@Stability(Stable)
protected void addPortMappingForTargets(@NotNull
 ContainerDefinition container,
 @NotNull
 List<NetworkTargetProps> targets)

Parameters:

container - This parameter is required.

targets - This parameter is required.

createAWSLogDriver

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

Parameters:

prefix - This parameter is required.

findListener

@Stability(Stable)
@NotNull
protected NetworkListener findListener(@Nullable
 String name)

Parameters:

name -

findListener

@Stability(Stable)
@NotNull
protected NetworkListener findListener()

getDefaultCluster

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

Returns the default cluster.

Parameters:

scope - This parameter is required.

vpc -

getDefaultCluster

@Stability(Stable)
@NotNull
protected Cluster getDefaultCluster(@NotNull
 software.constructs.Construct scope)

Returns the default cluster.

Parameters:

scope - This parameter is required.

registerECSTargets

@Stability(Stable)
@NotNull
protected NetworkTargetGroup registerECSTargets(@NotNull
 BaseService service,
 @NotNull
 ContainerDefinition container,
 @NotNull
 List<NetworkTargetProps> targets)

Parameters:

service - This parameter is required.

container - This parameter is required.

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

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.

getListeners

@Stability(Stable)
@NotNull
protected List<NetworkListener> getListeners()

setListeners

@Stability(Stable)
protected void setListeners(@NotNull
 List<NetworkListener> value)

getTargetGroups

@Stability(Stable)
@NotNull
protected List<NetworkTargetGroup> getTargetGroups()

setTargetGroups

@Stability(Stable)
protected void setTargetGroups(@NotNull
 List<NetworkTargetGroup> value)

getLogDriver

@Stability(Stable)
@Nullable
protected LogDriver getLogDriver()

setLogDriver

@Stability(Stable)
protected void setLogDriver(@Nullable
 LogDriver value)