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