ApplicationLoadBalancedServiceBaseProps.Builder

java.lang.Object
- software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBaseProps.Builder

Enclosing interface:

ApplicationLoadBalancedServiceBaseProps
```
public static final class ApplicationLoadBalancedServiceBaseProps.Builder
extends java.lang.Object
```
A builder for ApplicationLoadBalancedServiceBaseProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - certificate
```
public ApplicationLoadBalancedServiceBaseProps.Builder certificate(ICertificate certificate)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getCertificate()
    
    Parameters:
    
    certificate - Certificate Manager certificate to associate with the load balancer. Setting this option will set the load balancer protocol to HTTPS.
    
    Returns:
    
    this
  - circuitBreaker
```
public ApplicationLoadBalancedServiceBaseProps.Builder circuitBreaker(DeploymentCircuitBreaker circuitBreaker)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getCircuitBreaker()
    
    Parameters:
    
    circuitBreaker - Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled.
    
    Returns:
    
    this
  - cloudMapOptions
```
public ApplicationLoadBalancedServiceBaseProps.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getCloudMapOptions()
    
    Parameters:
    
    cloudMapOptions - The options for configuring an Amazon ECS service to use service discovery.
    
    Returns:
    
    this
  - cluster
```
public ApplicationLoadBalancedServiceBaseProps.Builder cluster(ICluster cluster)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getCluster()
    
    Parameters:
    
    cluster - 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.
    
    Returns:
    
    this
  - deploymentController
```
public ApplicationLoadBalancedServiceBaseProps.Builder deploymentController(DeploymentController deploymentController)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getDeploymentController()
    
    Parameters:
    
    deploymentController - Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types
    
    Returns:
    
    this
  - desiredCount
```
public ApplicationLoadBalancedServiceBaseProps.Builder desiredCount(java.lang.Number desiredCount)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getDesiredCount()
    
    Parameters:
    
    desiredCount - The desired number of instantiations of the task definition to keep running on the service. The minimum value is 1
    
    Returns:
    
    this
  - domainName
```
public ApplicationLoadBalancedServiceBaseProps.Builder domainName(java.lang.String domainName)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainName()
    
    Parameters:
    
    domainName - The domain name for the service, e.g. "api.example.com.".
    
    Returns:
    
    this
  - domainZone
```
public ApplicationLoadBalancedServiceBaseProps.Builder domainZone(IHostedZone domainZone)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainZone()
    
    Parameters:
    
    domainZone - The Route53 hosted zone for the domain, e.g. "example.com.".
    
    Returns:
    
    this
  - enableEcsManagedTags
```
public ApplicationLoadBalancedServiceBaseProps.Builder enableEcsManagedTags(java.lang.Boolean enableEcsManagedTags)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps#getEnableEcsManagedTags
    
    Parameters:
    
    enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources
    
    Returns:
    
    this
  - healthCheckGracePeriod
```
public ApplicationLoadBalancedServiceBaseProps.Builder healthCheckGracePeriod(Duration healthCheckGracePeriod)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
    
    Parameters:
    
    healthCheckGracePeriod - 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.
    
    Returns:
    
    this
  - listenerPort
```
public ApplicationLoadBalancedServiceBaseProps.Builder listenerPort(java.lang.Number listenerPort)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getListenerPort()
    
    Parameters:
    
    listenerPort - Listener port of the application load balancer that will serve traffic to the service.
    
    Returns:
    
    this
  - loadBalancer
```
public ApplicationLoadBalancedServiceBaseProps.Builder loadBalancer(IApplicationLoadBalancer loadBalancer)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancer()
    
    Parameters:
    
    loadBalancer - 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]
    
    Returns:
    
    this
  - loadBalancerName
```
public ApplicationLoadBalancedServiceBaseProps.Builder loadBalancerName(java.lang.String loadBalancerName)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()
    
    Parameters:
    
    loadBalancerName - Name of the load balancer.
    
    Returns:
    
    this
  - maxHealthyPercent
```
public ApplicationLoadBalancedServiceBaseProps.Builder maxHealthyPercent(java.lang.Number maxHealthyPercent)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getMaxHealthyPercent()
    
    Parameters:
    
    maxHealthyPercent - 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.
    
    Returns:
    
    this
  - minHealthyPercent
```
public ApplicationLoadBalancedServiceBaseProps.Builder minHealthyPercent(java.lang.Number minHealthyPercent)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getMinHealthyPercent()
    
    Parameters:
    
    minHealthyPercent - 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.
    
    Returns:
    
    this
  - openListener
```
public ApplicationLoadBalancedServiceBaseProps.Builder openListener(java.lang.Boolean openListener)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getOpenListener()
    
    Parameters:
    
    openListener - Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
    
    Returns:
    
    this
  - propagateTags
```
public ApplicationLoadBalancedServiceBaseProps.Builder propagateTags(PropagatedTagSource propagateTags)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getPropagateTags()
    
    Parameters:
    
    propagateTags - 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.
    
    Returns:
    
    this
  - protocol
```
public ApplicationLoadBalancedServiceBaseProps.Builder protocol(ApplicationProtocol protocol)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocol()
    
    Parameters:
    
    protocol - 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.
    
    Returns:
    
    this
  - protocolVersion
```
public ApplicationLoadBalancedServiceBaseProps.Builder protocolVersion(ApplicationProtocolVersion protocolVersion)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()
    
    Parameters:
    
    protocolVersion - The protocol version to use.
    
    Returns:
    
    this
  - publicLoadBalancer
```
public ApplicationLoadBalancedServiceBaseProps.Builder publicLoadBalancer(java.lang.Boolean publicLoadBalancer)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getPublicLoadBalancer()
    
    Parameters:
    
    publicLoadBalancer - Determines whether the Load Balancer will be internet-facing.
    
    Returns:
    
    this
  - recordType
```
public ApplicationLoadBalancedServiceBaseProps.Builder recordType(ApplicationLoadBalancedServiceRecordType recordType)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getRecordType()
    
    Parameters:
    
    recordType - 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.
    
    Returns:
    
    this
  - redirectHttp
```
public ApplicationLoadBalancedServiceBaseProps.Builder redirectHttp(java.lang.Boolean redirectHttp)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps#getRedirectHttp
    
    Parameters:
    
    redirectHttp - 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.
    
    Returns:
    
    this
  - serviceName
```
public ApplicationLoadBalancedServiceBaseProps.Builder serviceName(java.lang.String serviceName)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getServiceName()
    
    Parameters:
    
    serviceName - The name of the service.
    
    Returns:
    
    this
  - sslPolicy
```
public ApplicationLoadBalancedServiceBaseProps.Builder sslPolicy(SslPolicy sslPolicy)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getSslPolicy()
    
    Parameters:
    
    sslPolicy - The security policy that defines which ciphers and protocols are supported by the ALB Listener.
    
    Returns:
    
    this
  - targetProtocol
```
public ApplicationLoadBalancedServiceBaseProps.Builder targetProtocol(ApplicationProtocol targetProtocol)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getTargetProtocol()
    
    Parameters:
    
    targetProtocol - 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).
    
    Returns:
    
    this
  - taskImageOptions
```
public ApplicationLoadBalancedServiceBaseProps.Builder taskImageOptions(ApplicationLoadBalancedTaskImageOptions taskImageOptions)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getTaskImageOptions()
    
    Parameters:
    
    taskImageOptions - The properties required to create a new task definition. TaskDefinition or TaskImageOptions must be specified, but not both.
    
    Returns:
    
    this
  - vpc
```
public ApplicationLoadBalancedServiceBaseProps.Builder vpc(IVpc vpc)
```
    Sets the value of ApplicationLoadBalancedServiceBaseProps.getVpc()
    
    Parameters:
    
    vpc - 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.
    
    Returns:
    
    this
  - build
```
public ApplicationLoadBalancedServiceBaseProps build()
```
    Builds the configured instance.
    
    Returns:
    
    a new instance of ApplicationLoadBalancedServiceBaseProps
    
    Throws:
    
    java.lang.NullPointerException - if any required attribute was not provided

Modifier and Type	Method and Description
`ApplicationLoadBalancedServiceBaseProps`	`build()` Builds the configured instance.
`ApplicationLoadBalancedServiceBaseProps.Builder`	`certificate(ICertificate certificate)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getCertificate()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`circuitBreaker(DeploymentCircuitBreaker circuitBreaker)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getCircuitBreaker()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`cloudMapOptions(CloudMapOptions cloudMapOptions)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getCloudMapOptions()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`cluster(ICluster cluster)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getCluster()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`deploymentController(DeploymentController deploymentController)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getDeploymentController()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`desiredCount(java.lang.Number desiredCount)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getDesiredCount()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`domainName(java.lang.String domainName)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getDomainName()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`domainZone(IHostedZone domainZone)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getDomainZone()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`enableEcsManagedTags(java.lang.Boolean enableEcsManagedTags)` Sets the value of `ApplicationLoadBalancedServiceBaseProps#getEnableEcsManagedTags`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`healthCheckGracePeriod(Duration healthCheckGracePeriod)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`listenerPort(java.lang.Number listenerPort)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getListenerPort()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`loadBalancer(IApplicationLoadBalancer loadBalancer)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getLoadBalancer()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`loadBalancerName(java.lang.String loadBalancerName)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`maxHealthyPercent(java.lang.Number maxHealthyPercent)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getMaxHealthyPercent()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`minHealthyPercent(java.lang.Number minHealthyPercent)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getMinHealthyPercent()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`openListener(java.lang.Boolean openListener)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getOpenListener()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`propagateTags(PropagatedTagSource propagateTags)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getPropagateTags()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`protocol(ApplicationProtocol protocol)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getProtocol()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`protocolVersion(ApplicationProtocolVersion protocolVersion)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`publicLoadBalancer(java.lang.Boolean publicLoadBalancer)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getPublicLoadBalancer()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`recordType(ApplicationLoadBalancedServiceRecordType recordType)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getRecordType()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`redirectHttp(java.lang.Boolean redirectHttp)` Sets the value of `ApplicationLoadBalancedServiceBaseProps#getRedirectHttp`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`serviceName(java.lang.String serviceName)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getServiceName()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`sslPolicy(SslPolicy sslPolicy)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getSslPolicy()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`targetProtocol(ApplicationProtocol targetProtocol)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getTargetProtocol()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`taskImageOptions(ApplicationLoadBalancedTaskImageOptions taskImageOptions)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getTaskImageOptions()`
`ApplicationLoadBalancedServiceBaseProps.Builder`	`vpc(IVpc vpc)` Sets the value of `ApplicationLoadBalancedServiceBaseProps.getVpc()`

Class ApplicationLoadBalancedServiceBaseProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

certificate

circuitBreaker

cloudMapOptions

cluster

deploymentController

desiredCount

domainName

domainZone

enableEcsManagedTags

healthCheckGracePeriod

listenerPort

loadBalancer

loadBalancerName

maxHealthyPercent

minHealthyPercent

openListener

propagateTags

protocol

protocolVersion

publicLoadBalancer

recordType

redirectHttp

serviceName

sslPolicy

targetProtocol

taskImageOptions

vpc

build