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

Class ApplicationLoadBalancedServiceBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBase
All Implemented Interfaces:
software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
Direct Known Subclasses:
ApplicationLoadBalancedEc2Service, ApplicationLoadBalancedFargateService
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:20.391Z") @Stability(Stable) public abstract class ApplicationLoadBalancedServiceBase extends software.amazon.awscdk.core.Construct
The base class for ApplicationLoadBalancedEc2Service and ApplicationLoadBalancedFargateService 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

    software.amazon.awscdk.core.IConstruct.Jsii$Default

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

    software.constructs.IConstruct.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ApplicationLoadBalancedServiceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ApplicationLoadBalancedServiceBase(software.amazon.jsii.JsiiObjectRef objRef)
     
    protected
    ApplicationLoadBalancedServiceBase(software.constructs.Construct scope, String id)
    Constructs a new instance of the ApplicationLoadBalancedServiceBase class.
    protected
    ApplicationLoadBalancedServiceBase(software.constructs.Construct scope, String id, ApplicationLoadBalancedServiceBaseProps props)
    Constructs a new instance of the ApplicationLoadBalancedServiceBase 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)
     
    ICertificate
    getCertificate()
    Certificate Manager certificate to associate with the load balancer.
    ICluster
    getCluster()
    The cluster that hosts the service.
    protected Cluster
    getDefaultCluster(software.amazon.awscdk.core.Construct scope)
    Returns the default cluster.
    protected Cluster
    getDefaultCluster(software.amazon.awscdk.core.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.
    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 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

    • ApplicationLoadBalancedServiceBase

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

    • ApplicationLoadBalancedServiceBase

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

    • ApplicationLoadBalancedServiceBase

      @Stability(Stable) protected ApplicationLoadBalancedServiceBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ApplicationLoadBalancedServiceBaseProps props)
      Constructs a new instance of the ApplicationLoadBalancedServiceBase class.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • ApplicationLoadBalancedServiceBase

      @Stability(Stable) protected ApplicationLoadBalancedServiceBase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Constructs a new instance of the ApplicationLoadBalancedServiceBase 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 software.amazon.awscdk.core.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.amazon.awscdk.core.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 ApplicationListener getListener()
      The listener for the service.

    • getLoadBalancer

      @Stability(Stable) @NotNull public ApplicationLoadBalancer getLoadBalancer()
      The Application Load Balancer for the service.

    • getTargetGroup

      @Stability(Stable) @NotNull public ApplicationTargetGroup getTargetGroup()
      The target group for the service.

    • getCertificate

      @Stability(Stable) @Nullable public ICertificate getCertificate()
      Certificate Manager certificate to associate with the load balancer.

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

    • getRedirectListener

      @Stability(Stable) @Nullable public ApplicationListener getRedirectListener()
      The redirect listener for the service if redirectHTTP is enabled.