java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy

All Implemented Interfaces:: ApplicationLoadBalancedServiceBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: ApplicationLoadBalancedServiceBaseProps

@Stability(Stable) @Internal public static final class ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ApplicationLoadBalancedServiceBaseProps

An implementation for ApplicationLoadBalancedServiceBaseProps

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBaseProps
ApplicationLoadBalancedServiceBaseProps.Builder, ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(ApplicationLoadBalancedServiceBaseProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the ApplicationLoadBalancedServiceBaseProps.Builder.

protected

Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.
Method Summary

Modifier and Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final List<CapacityProviderStrategy>

getCapacityProviderStrategies()

A list of Capacity Provider strategies used to place a service.

final ICertificate

getCertificate()

Certificate Manager certificate to associate with the load balancer.

final DeploymentCircuitBreaker

getCircuitBreaker()

Whether to enable the deployment circuit breaker.

final CloudMapOptions

getCloudMapOptions()

The options for configuring an Amazon ECS service to use service discovery.

final ICluster

getCluster()

The name of the cluster that hosts the service.

final DeploymentController

getDeploymentController()

Specifies which deployment controller to use for the service.

final Number

getDesiredCount()

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

final String

getDomainName()

The domain name for the service, e.g.

final IHostedZone

getDomainZone()

The Route53 hosted zone for the domain, e.g.

final Boolean

getEnableECSManagedTags()

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

final Boolean

getEnableExecuteCommand()

Whether ECS Exec should be enabled.

final Duration

getHealthCheckGracePeriod()

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

final Duration

getIdleTimeout()

The load balancer idle timeout, in seconds.

final IpAddressType

getIpAddressType()

The type of IP address to use.

final Number

getListenerPort()

Listener port of the application load balancer that will serve traffic to the service.

final IApplicationLoadBalancer

getLoadBalancer()

The application load balancer that will serve traffic to the service.

final String

getLoadBalancerName()

Name of the load balancer.

final Number

getMaxHealthyPercent()

The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.

final Number

getMinHealthyPercent()

The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.

final Boolean

getOpenListener()

Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.

final PropagatedTagSource

getPropagateTags()

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

final ApplicationProtocol

getProtocol()

The protocol for connections from clients to the load balancer.

final ApplicationProtocolVersion

getProtocolVersion()

The protocol version to use.

final Boolean

getPublicLoadBalancer()

Determines whether the Load Balancer will be internet-facing.

final ApplicationLoadBalancedServiceRecordType

getRecordType()

Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.

final Boolean

getRedirectHTTP()

Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.

final String

getServiceName()

The name of the service.

final SslPolicy

getSslPolicy()

The security policy that defines which ciphers and protocols are supported by the ALB Listener.

final ApplicationProtocol

getTargetProtocol()

The protocol for connections from the load balancer to the ECS tasks.

final ApplicationLoadBalancedTaskImageOptions

getTaskImageOptions()

The properties required to create a new task definition.

final IVpc

getVpc()

The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

final int

hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Jsii$Proxy
  
  protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
  
  Constructor that initializes the object based on values retrieved from the JsiiObject.
  
  Parameters:
  
  objRef - Reference to the JSII managed object.
- Jsii$Proxy
  
  protected Jsii$Proxy(ApplicationLoadBalancedServiceBaseProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the ApplicationLoadBalancedServiceBaseProps.Builder.
Method Details
- getCapacityProviderStrategies
  
  public final List<CapacityProviderStrategy> getCapacityProviderStrategies()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  A list of Capacity Provider strategies used to place a service.
  Default: - undefined
  
  Specified by:
  
  getCapacityProviderStrategies in interface ApplicationLoadBalancedServiceBaseProps
- getCertificate
  
  public final ICertificate getCertificate()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Certificate Manager certificate to associate with the load balancer.
  Setting this option will set the load balancer protocol to HTTPS.
  Default: - No certificate associated with the load balancer, if using the HTTP protocol. For HTTPS, a DNS-validated certificate will be created for the load balancer's specified domain name if a domain name and domain zone are specified.
  
  Specified by:
  
  getCertificate in interface ApplicationLoadBalancedServiceBaseProps
- getCircuitBreaker
  
  public final DeploymentCircuitBreaker getCircuitBreaker()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Whether to enable the deployment circuit breaker.
  If this property is defined, circuit breaker will be implicitly enabled.
  Default: - disabled
  
  Specified by:
  
  getCircuitBreaker in interface ApplicationLoadBalancedServiceBaseProps
- getCloudMapOptions
  
  public final CloudMapOptions getCloudMapOptions()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The options for configuring an Amazon ECS service to use service discovery.
  Default: - AWS Cloud Map service discovery is not enabled.
  
  Specified by:
  
  getCloudMapOptions in interface ApplicationLoadBalancedServiceBaseProps
- getCluster
  
  public final ICluster getCluster()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The name of the cluster that hosts the service.
  If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
  Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
  
  Specified by:
  
  getCluster in interface ApplicationLoadBalancedServiceBaseProps
- getDeploymentController
  
  public final DeploymentController getDeploymentController()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Specifies which deployment controller to use for the service.
  For more information, see Amazon ECS Deployment Types
  Default: - Rolling update (ECS)
  
  Specified by:
  
  getDeploymentController in interface ApplicationLoadBalancedServiceBaseProps
- getDesiredCount
  
  public final Number getDesiredCount()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The desired number of instantiations of the task definition to keep running on the service.
  The minimum value is 1
  Default: - The default is 1 for all new services and uses the existing service's desired count when updating an existing service.
  
  Specified by:
  
  getDesiredCount in interface ApplicationLoadBalancedServiceBaseProps
- getDomainName
  
  public final String getDomainName()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The domain name for the service, e.g. "api.example.com.".
  Default: - No domain name.
  
  Specified by:
  
  getDomainName in interface ApplicationLoadBalancedServiceBaseProps
- getDomainZone
  
  public final IHostedZone getDomainZone()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The Route53 hosted zone for the domain, e.g. "example.com.".
  Default: - No Route53 hosted domain zone.
  
  Specified by:
  
  getDomainZone in interface ApplicationLoadBalancedServiceBaseProps
- getEnableECSManagedTags
  
  public final Boolean getEnableECSManagedTags()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
  For more information, see Tagging Your Amazon ECS Resources
  Default: false
  
  Specified by:
  
  getEnableECSManagedTags in interface ApplicationLoadBalancedServiceBaseProps
- getEnableExecuteCommand
  
  public final Boolean getEnableExecuteCommand()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Whether ECS Exec should be enabled.
  Default: - false
  
  Specified by:
  
  getEnableExecuteCommand in interface ApplicationLoadBalancedServiceBaseProps
- getHealthCheckGracePeriod
  
  public final Duration getHealthCheckGracePeriod()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
  Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
  
  Specified by:
  
  getHealthCheckGracePeriod in interface ApplicationLoadBalancedServiceBaseProps
- getIdleTimeout
  
  public final Duration getIdleTimeout()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The load balancer idle timeout, in seconds.
  Can be between 1 and 4000 seconds
  Default: - CloudFormation sets idle timeout to 60 seconds
  
  Specified by:
  
  getIdleTimeout in interface ApplicationLoadBalancedServiceBaseProps
- getIpAddressType
  
  public final IpAddressType getIpAddressType()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The type of IP address to use.
  Default: - IpAddressType.IPV4
  
  Specified by:
  
  getIpAddressType in interface ApplicationLoadBalancedServiceBaseProps
- getListenerPort
  
  public final Number getListenerPort()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Listener port of the application load balancer that will serve traffic to the service.
  Default: - The default listener port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.
  
  Specified by:
  
  getListenerPort in interface ApplicationLoadBalancedServiceBaseProps
- getLoadBalancer
  
  public final IApplicationLoadBalancer getLoadBalancer()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The application load balancer that will serve traffic to the service.
  The VPC attribute of a load balancer must be specified for it to be used to create a new service with this pattern.
  [disable-awslint:ref-via-interface]
  Default: - a new load balancer will be created.
  
  Specified by:
  
  getLoadBalancer in interface ApplicationLoadBalancedServiceBaseProps
- getLoadBalancerName
  
  public final String getLoadBalancerName()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Name of the load balancer.
  Default: - Automatically generated name.
  
  Specified by:
  
  getLoadBalancerName in interface ApplicationLoadBalancedServiceBaseProps
- getMaxHealthyPercent
  
  public final Number getMaxHealthyPercent()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
  Default: - 100 if daemon, otherwise 200
  
  Specified by:
  
  getMaxHealthyPercent in interface ApplicationLoadBalancedServiceBaseProps
- getMinHealthyPercent
  
  public final Number getMinHealthyPercent()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
  Default: - 0 if daemon, otherwise 50
  
  Specified by:
  
  getMinHealthyPercent in interface ApplicationLoadBalancedServiceBaseProps
- getOpenListener
  
  public final Boolean getOpenListener()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
  Default: true -- The security group allows ingress from all IP addresses.
  
  Specified by:
  
  getOpenListener in interface ApplicationLoadBalancedServiceBaseProps
- getPropagateTags
  
  public final PropagatedTagSource getPropagateTags()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
  Tags can only be propagated to the tasks within the service during service creation.
  Default: - none
  
  Specified by:
  
  getPropagateTags in interface ApplicationLoadBalancedServiceBaseProps
- getProtocol
  
  public final ApplicationProtocol getProtocol()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The protocol for connections from clients to the load balancer.
  The load balancer port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). If HTTPS, either a certificate or domain name and domain zone must also be specified.
  Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
  
  Specified by:
  
  getProtocol in interface ApplicationLoadBalancedServiceBaseProps
- getProtocolVersion
  
  public final ApplicationProtocolVersion getProtocolVersion()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The protocol version to use.
  Default: ApplicationProtocolVersion.HTTP1
  
  Specified by:
  
  getProtocolVersion in interface ApplicationLoadBalancedServiceBaseProps
- getPublicLoadBalancer
  
  public final Boolean getPublicLoadBalancer()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Determines whether the Load Balancer will be internet-facing.
  Default: true
  
  Specified by:
  
  getPublicLoadBalancer in interface ApplicationLoadBalancedServiceBaseProps
- getRecordType
  
  public final ApplicationLoadBalancedServiceRecordType getRecordType()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
  This is useful if you need to work with DNS systems that do not support alias records.
  Default: ApplicationLoadBalancedServiceRecordType.ALIAS
  
  Specified by:
  
  getRecordType in interface ApplicationLoadBalancedServiceBaseProps
- getRedirectHTTP
  
  public final Boolean getRedirectHTTP()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.
  Default: false
  
  Specified by:
  
  getRedirectHTTP in interface ApplicationLoadBalancedServiceBaseProps
- getServiceName
  
  public final String getServiceName()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The name of the service.
  Default: - CloudFormation-generated name.
  
  Specified by:
  
  getServiceName in interface ApplicationLoadBalancedServiceBaseProps
- getSslPolicy
  
  public final SslPolicy getSslPolicy()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The security policy that defines which ciphers and protocols are supported by the ALB Listener.
  Default: - The recommended elastic load balancing security policy
  
  Specified by:
  
  getSslPolicy in interface ApplicationLoadBalancedServiceBaseProps
- getTargetProtocol
  
  public final ApplicationProtocol getTargetProtocol()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The protocol for connections from the load balancer to the ECS tasks.
  The default target port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS).
  Default: HTTP.
  
  Specified by:
  
  getTargetProtocol in interface ApplicationLoadBalancedServiceBaseProps
- getTaskImageOptions
  
  public final ApplicationLoadBalancedTaskImageOptions getTaskImageOptions()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The properties required to create a new task definition.
  TaskDefinition or TaskImageOptions must be specified, but not both.
  Default: none
  
  Specified by:
  
  getTaskImageOptions in interface ApplicationLoadBalancedServiceBaseProps
- getVpc
  
  public final IVpc getVpc()
  
  Description copied from interface: ApplicationLoadBalancedServiceBaseProps
  
  The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
  If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.
  Default: - uses the VPC defined in the cluster or creates a new VPC.
  
  Specified by:
  
  getVpc in interface ApplicationLoadBalancedServiceBaseProps
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBaseProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getCapacityProviderStrategies

getCertificate

getCircuitBreaker

getCloudMapOptions

getCluster

getDeploymentController

getDesiredCount

getDomainName

getDomainZone

getEnableECSManagedTags

getEnableExecuteCommand

getHealthCheckGracePeriod

getIdleTimeout

getIpAddressType

getListenerPort

getLoadBalancer

getLoadBalancerName

getMaxHealthyPercent

getMinHealthyPercent

getOpenListener

getPropagateTags

getProtocol

getProtocolVersion

getPublicLoadBalancer

getRecordType

getRedirectHTTP

getServiceName

getSslPolicy

getTargetProtocol

getTaskImageOptions

getVpc

$jsii$toJson

equals

hashCode