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

Class ApplicationLoadBalancedEc2ServiceProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedEc2ServiceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationLoadBalancedEc2ServiceProps>

Enclosing interface:

ApplicationLoadBalancedEc2ServiceProps

@Stability(Stable)
public static final class ApplicationLoadBalancedEc2ServiceProps.Builder
extends Object
implements software.amazon.jsii.Builder<ApplicationLoadBalancedEc2ServiceProps>

A builder for ApplicationLoadBalancedEc2ServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApplicationLoadBalancedEc2ServiceProps	build()	Builds the configured instance.
ApplicationLoadBalancedEc2ServiceProps.Builder	capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCapacityProviderStrategies()
ApplicationLoadBalancedEc2ServiceProps.Builder	certificate(ICertificate certificate)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCertificate()
ApplicationLoadBalancedEc2ServiceProps.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCircuitBreaker()
ApplicationLoadBalancedEc2ServiceProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCloudMapOptions()
ApplicationLoadBalancedEc2ServiceProps.Builder	cluster(ICluster cluster)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCluster()
ApplicationLoadBalancedEc2ServiceProps.Builder	cpu(Number cpu)	Sets the value of ApplicationLoadBalancedEc2ServiceProps.getCpu()
ApplicationLoadBalancedEc2ServiceProps.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDeploymentController()
ApplicationLoadBalancedEc2ServiceProps.Builder	desiredCount(Number desiredCount)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDesiredCount()
ApplicationLoadBalancedEc2ServiceProps.Builder	domainName(String domainName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainName()
ApplicationLoadBalancedEc2ServiceProps.Builder	domainZone(IHostedZone domainZone)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainZone()
ApplicationLoadBalancedEc2ServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link ApplicationLoadBalancedEc2ServiceProps#getEnableEcsManagedTags
ApplicationLoadBalancedEc2ServiceProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getEnableExecuteCommand()
ApplicationLoadBalancedEc2ServiceProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
ApplicationLoadBalancedEc2ServiceProps.Builder	idleTimeout(Duration idleTimeout)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getIdleTimeout()
ApplicationLoadBalancedEc2ServiceProps.Builder	ipAddressType(IpAddressType ipAddressType)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getIpAddressType()
ApplicationLoadBalancedEc2ServiceProps.Builder	listenerPort(Number listenerPort)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getListenerPort()
ApplicationLoadBalancedEc2ServiceProps.Builder	loadBalancer(IApplicationLoadBalancer loadBalancer)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancer()
ApplicationLoadBalancedEc2ServiceProps.Builder	loadBalancerName(String loadBalancerName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()
ApplicationLoadBalancedEc2ServiceProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getMaxHealthyPercent()
ApplicationLoadBalancedEc2ServiceProps.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of ApplicationLoadBalancedEc2ServiceProps.getMemoryLimitMiB()
ApplicationLoadBalancedEc2ServiceProps.Builder	memoryReservationMiB(Number memoryReservationMiB)	Sets the value of ApplicationLoadBalancedEc2ServiceProps.getMemoryReservationMiB()
ApplicationLoadBalancedEc2ServiceProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getMinHealthyPercent()
ApplicationLoadBalancedEc2ServiceProps.Builder	openListener(Boolean openListener)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getOpenListener()
ApplicationLoadBalancedEc2ServiceProps.Builder	placementConstraints(List<? extends PlacementConstraint> placementConstraints)	Sets the value of ApplicationLoadBalancedEc2ServiceProps.getPlacementConstraints()
ApplicationLoadBalancedEc2ServiceProps.Builder	placementStrategies(List<? extends PlacementStrategy> placementStrategies)	Sets the value of ApplicationLoadBalancedEc2ServiceProps.getPlacementStrategies()
ApplicationLoadBalancedEc2ServiceProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getPropagateTags()
ApplicationLoadBalancedEc2ServiceProps.Builder	protocol(ApplicationProtocol protocol)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocol()
ApplicationLoadBalancedEc2ServiceProps.Builder	protocolVersion(ApplicationProtocolVersion protocolVersion)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()
ApplicationLoadBalancedEc2ServiceProps.Builder	publicLoadBalancer(Boolean publicLoadBalancer)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getPublicLoadBalancer()
ApplicationLoadBalancedEc2ServiceProps.Builder	recordType(ApplicationLoadBalancedServiceRecordType recordType)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getRecordType()
ApplicationLoadBalancedEc2ServiceProps.Builder	redirectHttp(Boolean redirectHttp)	Sets the value of invalid @link ApplicationLoadBalancedEc2ServiceProps#getRedirectHttp
ApplicationLoadBalancedEc2ServiceProps.Builder	serviceName(String serviceName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getServiceName()
ApplicationLoadBalancedEc2ServiceProps.Builder	sslPolicy(SslPolicy sslPolicy)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getSslPolicy()
ApplicationLoadBalancedEc2ServiceProps.Builder	targetProtocol(ApplicationProtocol targetProtocol)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getTargetProtocol()
ApplicationLoadBalancedEc2ServiceProps.Builder	taskDefinition(Ec2TaskDefinition taskDefinition)	Sets the value of ApplicationLoadBalancedEc2ServiceProps.getTaskDefinition()
ApplicationLoadBalancedEc2ServiceProps.Builder	taskImageOptions(ApplicationLoadBalancedTaskImageOptions taskImageOptions)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getTaskImageOptions()
ApplicationLoadBalancedEc2ServiceProps.Builder	vpc(IVpc vpc)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getVpc()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

cpu

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder cpu(Number cpu)

Sets the value of ApplicationLoadBalancedEc2ServiceProps.getCpu()

Parameters:

cpu - The number of cpu units used by the task. Valid values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

memoryLimitMiB

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of ApplicationLoadBalancedEc2ServiceProps.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Returns:

this

memoryReservationMiB

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder memoryReservationMiB(Number memoryReservationMiB)

Sets the value of ApplicationLoadBalancedEc2ServiceProps.getMemoryReservationMiB()

Parameters:

memoryReservationMiB - The soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Returns:

this

placementConstraints

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints)

Sets the value of ApplicationLoadBalancedEc2ServiceProps.getPlacementConstraints()

Parameters:

placementConstraints - The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints.

Returns:

this

placementStrategies

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder placementStrategies(List<? extends PlacementStrategy> placementStrategies)

Sets the value of ApplicationLoadBalancedEc2ServiceProps.getPlacementStrategies()

Parameters:

placementStrategies - The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies.

Returns:

this

taskDefinition

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder taskDefinition(Ec2TaskDefinition taskDefinition)

Sets the value of ApplicationLoadBalancedEc2ServiceProps.getTaskDefinition()

Parameters:

taskDefinition - The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.. [disable-awslint:ref-via-interface]

Returns:

this

capacityProviderStrategies

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getCapacityProviderStrategies()

Parameters:

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

Returns:

this

certificate

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder desiredCount(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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder domainName(String domainName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainName()

Parameters:

domainName - The domain name for the service, e.g. "api.example.com.".

Returns:

this

domainZone

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of

invalid @link

ApplicationLoadBalancedEc2ServiceProps#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

enableExecuteCommand

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

healthCheckGracePeriod

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

idleTimeout

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder idleTimeout(Duration idleTimeout)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getIdleTimeout()

Parameters:

idleTimeout - The load balancer idle timeout, in seconds. Can be between 1 and 4000 seconds

Returns:

this

ipAddressType

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder ipAddressType(IpAddressType ipAddressType)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getIpAddressType()

Parameters:

ipAddressType - The type of IP address to use.

Returns:

this

listenerPort

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder listenerPort(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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder loadBalancerName(String loadBalancerName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()

Parameters:

loadBalancerName - Name of the load balancer.

Returns:

this

maxHealthyPercent

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder maxHealthyPercent(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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder minHealthyPercent(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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder openListener(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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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). If HTTPS, either a certificate or domain name and domain zone must also be specified.

Returns:

this

protocolVersion

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder protocolVersion(ApplicationProtocolVersion protocolVersion)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()

Parameters:

protocolVersion - The protocol version to use.

Returns:

this

publicLoadBalancer

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder publicLoadBalancer(Boolean publicLoadBalancer)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getPublicLoadBalancer()

Parameters:

publicLoadBalancer - Determines whether the Load Balancer will be internet-facing.

Returns:

this

recordType

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder redirectHttp(Boolean redirectHttp)

Sets the value of

invalid @link

ApplicationLoadBalancedEc2ServiceProps#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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.Builder serviceName(String serviceName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

sslPolicy

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps.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

@Stability(Stable)
public ApplicationLoadBalancedEc2ServiceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ApplicationLoadBalancedEc2ServiceProps>

Returns:

a new instance of ApplicationLoadBalancedEc2ServiceProps

Throws:

NullPointerException - if any required attribute was not provided