software.amazon.awscdk.services.ecs.patterns

Class ApplicationLoadBalancedServiceBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBase

All Implemented Interfaces:

IConstruct, IDependable

Direct Known Subclasses:

ApplicationLoadBalancedEc2Service, ApplicationLoadBalancedFargateService

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:36.687Z")
public abstract class ApplicationLoadBalancedServiceBase
extends Construct

The base class for ApplicationLoadBalancedEc2Service and ApplicationLoadBalancedFargateService 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	ApplicationLoadBalancedServiceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApplicationLoadBalancedServiceBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	ApplicationLoadBalancedServiceBase(software.constructs.Construct scope, java.lang.String id) Constructs a new instance of the ApplicationLoadBalancedServiceBase class.
protected	ApplicationLoadBalancedServiceBase(software.constructs.Construct scope, java.lang.String id, ApplicationLoadBalancedServiceBaseProps props) Constructs a new instance of the ApplicationLoadBalancedServiceBase 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)
ICertificate	getCertificate() Certificate Manager certificate to associate with the load balancer.
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.
ApplicationListener	getListener() The listener for the service.
ApplicationLoadBalancer	getLoadBalancer() The Application Load Balancer for the service.
ApplicationListener	getRedirectListener() The redirect listener for the service if redirectHTTP is enabled.
ApplicationTargetGroup	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

ApplicationLoadBalancedServiceBase

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

ApplicationLoadBalancedServiceBase

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

ApplicationLoadBalancedServiceBase

protected ApplicationLoadBalancedServiceBase(software.constructs.Construct scope,
                                             java.lang.String id,
                                             ApplicationLoadBalancedServiceBaseProps props)

Constructs a new instance of the ApplicationLoadBalancedServiceBase class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ApplicationLoadBalancedServiceBase

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

Constructs a new instance of the ApplicationLoadBalancedServiceBase 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 ApplicationListener getListener()

The listener for the service.

getLoadBalancer

public ApplicationLoadBalancer getLoadBalancer()

The Application Load Balancer for the service.

getTargetGroup

public ApplicationTargetGroup getTargetGroup()

The target group for the service.

getCertificate

public ICertificate getCertificate()

Certificate Manager certificate to associate with the load balancer.

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.

getRedirectListener

public ApplicationListener getRedirectListener()

The redirect listener for the service if redirectHTTP is enabled.