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

Class ApplicationLoadBalancedFargateServiceProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationLoadBalancedFargateServiceProps>

Enclosing interface:

ApplicationLoadBalancedFargateServiceProps

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

A builder for ApplicationLoadBalancedFargateServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApplicationLoadBalancedFargateServiceProps.Builder	assignPublicIp(Boolean assignPublicIp)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getAssignPublicIp()
ApplicationLoadBalancedFargateServiceProps	build()	Builds the configured instance.
ApplicationLoadBalancedFargateServiceProps.Builder	certificate(ICertificate certificate)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCertificate()
ApplicationLoadBalancedFargateServiceProps.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCircuitBreaker()
ApplicationLoadBalancedFargateServiceProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCloudMapOptions()
ApplicationLoadBalancedFargateServiceProps.Builder	cluster(ICluster cluster)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCluster()
ApplicationLoadBalancedFargateServiceProps.Builder	cpu(Number cpu)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getCpu()
ApplicationLoadBalancedFargateServiceProps.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDeploymentController()
ApplicationLoadBalancedFargateServiceProps.Builder	desiredCount(Number desiredCount)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDesiredCount()
ApplicationLoadBalancedFargateServiceProps.Builder	domainName(String domainName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainName()
ApplicationLoadBalancedFargateServiceProps.Builder	domainZone(IHostedZone domainZone)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainZone()
ApplicationLoadBalancedFargateServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link ApplicationLoadBalancedFargateServiceProps#getEnableEcsManagedTags
ApplicationLoadBalancedFargateServiceProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
ApplicationLoadBalancedFargateServiceProps.Builder	listenerPort(Number listenerPort)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getListenerPort()
ApplicationLoadBalancedFargateServiceProps.Builder	loadBalancer(IApplicationLoadBalancer loadBalancer)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancer()
ApplicationLoadBalancedFargateServiceProps.Builder	loadBalancerName(String loadBalancerName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()
ApplicationLoadBalancedFargateServiceProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getMaxHealthyPercent()
ApplicationLoadBalancedFargateServiceProps.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getMemoryLimitMiB()
ApplicationLoadBalancedFargateServiceProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getMinHealthyPercent()
ApplicationLoadBalancedFargateServiceProps.Builder	openListener(Boolean openListener)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getOpenListener()
ApplicationLoadBalancedFargateServiceProps.Builder	platformVersion(FargatePlatformVersion platformVersion)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getPlatformVersion()
ApplicationLoadBalancedFargateServiceProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getPropagateTags()
ApplicationLoadBalancedFargateServiceProps.Builder	protocol(ApplicationProtocol protocol)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocol()
ApplicationLoadBalancedFargateServiceProps.Builder	protocolVersion(ApplicationProtocolVersion protocolVersion)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()
ApplicationLoadBalancedFargateServiceProps.Builder	publicLoadBalancer(Boolean publicLoadBalancer)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getPublicLoadBalancer()
ApplicationLoadBalancedFargateServiceProps.Builder	recordType(ApplicationLoadBalancedServiceRecordType recordType)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getRecordType()
ApplicationLoadBalancedFargateServiceProps.Builder	redirectHttp(Boolean redirectHttp)	Sets the value of invalid @link ApplicationLoadBalancedFargateServiceProps#getRedirectHttp
ApplicationLoadBalancedFargateServiceProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getSecurityGroups()
ApplicationLoadBalancedFargateServiceProps.Builder	serviceName(String serviceName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getServiceName()
ApplicationLoadBalancedFargateServiceProps.Builder	sslPolicy(SslPolicy sslPolicy)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getSslPolicy()
ApplicationLoadBalancedFargateServiceProps.Builder	targetProtocol(ApplicationProtocol targetProtocol)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getTargetProtocol()
ApplicationLoadBalancedFargateServiceProps.Builder	taskDefinition(FargateTaskDefinition taskDefinition)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getTaskDefinition()
ApplicationLoadBalancedFargateServiceProps.Builder	taskImageOptions(ApplicationLoadBalancedTaskImageOptions taskImageOptions)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getTaskImageOptions()
ApplicationLoadBalancedFargateServiceProps.Builder	taskSubnets(SubnetSelection taskSubnets)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getTaskSubnets()
ApplicationLoadBalancedFargateServiceProps.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

assignPublicIp

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.Builder assignPublicIp(Boolean assignPublicIp)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getAssignPublicIp()

Parameters:

assignPublicIp - Determines whether the service will be assigned a public IP address.

Returns:

this

cpu

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

Sets the value of ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The amount (in MiB) of memory used by the task. This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

platformVersion

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.Builder platformVersion(FargatePlatformVersion platformVersion)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getPlatformVersion()

Parameters:

platformVersion - The platform version on which to run your service. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

this

securityGroups

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getSecurityGroups()

Parameters:

securityGroups - The security groups to associate with the service. If you do not specify a security group, a new security group is created.

Returns:

this

taskDefinition

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.Builder taskDefinition(FargateTaskDefinition taskDefinition)

Sets the value of ApplicationLoadBalancedFargateServiceProps.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

taskSubnets

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.Builder taskSubnets(SubnetSelection taskSubnets)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getTaskSubnets()

Parameters:

taskSubnets - The subnets to associate with the service.

Returns:

this

certificate

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of

invalid @link

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

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

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.Builder loadBalancerName(String loadBalancerName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()

Parameters:

loadBalancerName - Name of the load balancer.

Returns:

this

maxHealthyPercent

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

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

Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()

Parameters:

protocolVersion - The protocol version to use.

Returns:

this

publicLoadBalancer

@Stability(Stable)
public ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.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 ApplicationLoadBalancedFargateServiceProps.Builder redirectHttp(Boolean redirectHttp)

Sets the value of

invalid @link

ApplicationLoadBalancedFargateServiceProps#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 ApplicationLoadBalancedFargateServiceProps.Builder serviceName(String serviceName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

sslPolicy

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApplicationLoadBalancedFargateServiceProps

Throws:

NullPointerException - if any required attribute was not provided