ApplicationLoadBalancedServiceBaseProps (software.amazon.awscdk:ecs-patterns 1.33.0 API)

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ApplicationLoadBalancedEc2ServiceProps, ApplicationLoadBalancedFargateServiceProps

All Known Implementing Classes:

ApplicationLoadBalancedEc2ServiceProps.Jsii$Proxy, ApplicationLoadBalancedFargateServiceProps.Jsii$Proxy, ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.3.0 (build 8ae966b)",
           date="2020-04-17T19:11:45.407Z")
 @Stability(value=Stable)
public interface ApplicationLoadBalancedServiceBaseProps
extends software.amazon.jsii.JsiiSerializable
```
The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ApplicationLoadBalancedServiceBaseProps.Builder` A builder for `ApplicationLoadBalancedServiceBaseProps`
`static class`	`ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy` An implementation for `ApplicationLoadBalancedServiceBaseProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static ApplicationLoadBalancedServiceBaseProps.Builder`	`builder()`
`default ICertificate`	`getCertificate()` Certificate Manager certificate to associate with the load balancer.
`default CloudMapOptions`	`getCloudMapOptions()` The options for configuring an Amazon ECS service to use service discovery.
`default ICluster`	`getCluster()` The name of the cluster that hosts the service.
`default Number`	`getDesiredCount()` The desired number of instantiations of the task definition to keep running on the service.
`default String`	`getDomainName()` The domain name for the service, e.g.
`default IHostedZone`	`getDomainZone()` The Route53 hosted zone for the domain, e.g.
`default Boolean`	`getEnableEcsManagedTags()` Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`default 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.
`default Number`	`getListenerPort()` Listener port of the application load balancer that will serve traffic to the service.
`default IApplicationLoadBalancer`	`getLoadBalancer()` The application load balancer that will serve traffic to the service.
`default 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.
`default 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.
`default PropagatedTagSource`	`getPropagateTags()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`default ApplicationProtocol`	`getProtocol()` The protocol for connections from clients to the load balancer.
`default Boolean`	`getPublicLoadBalancer()` Determines whether the Load Balancer will be internet-facing.
`default String`	`getServiceName()` The name of the service.
`default ApplicationLoadBalancedTaskImageOptions`	`getTaskImageOptions()` The properties required to create a new task definition.
`default IVpc`	`getVpc()` The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getCertificate
```
@Stability(value=Stable)
 @Nullable
default ICertificate getCertificate()
```
    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.
  - getCloudMapOptions
```
@Stability(value=Stable)
 @Nullable
default CloudMapOptions getCloudMapOptions()
```
    The options for configuring an Amazon ECS service to use service discovery.
    Default: - AWS Cloud Map service discovery is not enabled.
  - getCluster
```
@Stability(value=Stable)
 @Nullable
default ICluster getCluster()
```
    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.
  - getDesiredCount
```
@Stability(value=Stable)
 @Nullable
default Number getDesiredCount()
```
    The desired number of instantiations of the task definition to keep running on the service.
    The minimum value is 1
    Default: 1
  - getDomainName
```
@Stability(value=Stable)
 @Nullable
default String getDomainName()
```
    The domain name for the service, e.g. "api.example.com.".
    Default: - No domain name.
  - getDomainZone
```
@Stability(value=Stable)
 @Nullable
default IHostedZone getDomainZone()
```
    The Route53 hosted zone for the domain, e.g. "example.com.".
    Default: - No Route53 hosted domain zone.
  - getEnableEcsManagedTags
```
@Stability(value=Stable)
 @Nullable
default Boolean getEnableEcsManagedTags()
```
    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
  - getHealthCheckGracePeriod
```
@Stability(value=Stable)
 @Nullable
default 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.
    Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
  - getListenerPort
```
@Stability(value=Stable)
 @Nullable
default Number getListenerPort()
```
    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.
  - getLoadBalancer
```
@Stability(value=Stable)
 @Nullable
default IApplicationLoadBalancer getLoadBalancer()
```
    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.
  - getMaxHealthyPercent
```
@Stability(value=Stable)
 @Nullable
default 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.
    Default: - 100 if daemon, otherwise 200
  - getMinHealthyPercent
```
@Stability(value=Stable)
 @Nullable
default 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.
    Default: - 0 if daemon, otherwise 50
  - getPropagateTags
```
@Stability(value=Stable)
 @Nullable
default PropagatedTagSource getPropagateTags()
```
    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
  - getProtocol
```
@Stability(value=Stable)
 @Nullable
default ApplicationProtocol getProtocol()
```
    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). A domain name and zone must be also be specified if using HTTPS.
    Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
  - getPublicLoadBalancer
```
@Stability(value=Stable)
 @Nullable
default Boolean getPublicLoadBalancer()
```
    Determines whether the Load Balancer will be internet-facing.
    Default: true
  - getServiceName
```
@Stability(value=Stable)
 @Nullable
default String getServiceName()
```
    The name of the service.
    Default: - CloudFormation-generated name.
  - getTaskImageOptions
```
@Stability(value=Stable)
 @Nullable
default ApplicationLoadBalancedTaskImageOptions getTaskImageOptions()
```
    The properties required to create a new task definition.
    TaskDefinition or TaskImageOptions must be specified, but not both.
    Default: none
  - getVpc
```
@Stability(value=Stable)
 @Nullable
default IVpc getVpc()
```
    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.
  - builder
```
@Stability(value=Stable)
static ApplicationLoadBalancedServiceBaseProps.Builder builder()
```
    Returns:
    
    a ApplicationLoadBalancedServiceBaseProps.Builder of ApplicationLoadBalancedServiceBaseProps

Interface ApplicationLoadBalancedServiceBaseProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getCertificate

getCloudMapOptions

getCluster

getDesiredCount

getDomainName

getDomainZone

getEnableEcsManagedTags

getHealthCheckGracePeriod

getListenerPort

getLoadBalancer

getMaxHealthyPercent

getMinHealthyPercent

getPropagateTags

getProtocol

getPublicLoadBalancer

getServiceName

getTaskImageOptions

getVpc

builder