software.amazon.awscdk.services.ecs.patterns

Class ApplicationLoadBalancedFargateService.Builder

java.lang.Object

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

Enclosing class:

ApplicationLoadBalancedFargateService

@Stability(value=Stable)
public static final class ApplicationLoadBalancedFargateService.Builder
extends Object

A fluent builder for ApplicationLoadBalancedFargateService.

Method Summary

Modifier and Type	Method and Description
ApplicationLoadBalancedFargateService.Builder	assignPublicIp(Boolean assignPublicIp) Determines whether the service will be assigned a public IP address.
ApplicationLoadBalancedFargateService	build()
ApplicationLoadBalancedFargateService.Builder	certificate(ICertificate certificate) Certificate Manager certificate to associate with the load balancer.
ApplicationLoadBalancedFargateService.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions) The options for configuring an Amazon ECS service to use service discovery.
ApplicationLoadBalancedFargateService.Builder	cluster(ICluster cluster) The name of the cluster that hosts the service.
ApplicationLoadBalancedFargateService.Builder	cpu(Number cpu) The number of cpu units used by the task.
static ApplicationLoadBalancedFargateService.Builder	create(Construct scope, String id)
ApplicationLoadBalancedFargateService.Builder	desiredCount(Number desiredCount) The desired number of instantiations of the task definition to keep running on the service.
ApplicationLoadBalancedFargateService.Builder	domainName(String domainName) The domain name for the service, e.g.
ApplicationLoadBalancedFargateService.Builder	domainZone(IHostedZone domainZone) The Route53 hosted zone for the domain, e.g.
ApplicationLoadBalancedFargateService.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
ApplicationLoadBalancedFargateService.Builder	healthCheckGracePeriod(Duration 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.
ApplicationLoadBalancedFargateService.Builder	listenerPort(Number listenerPort) Listener port of the application load balancer that will serve traffic to the service.
ApplicationLoadBalancedFargateService.Builder	loadBalancer(IApplicationLoadBalancer loadBalancer) The application load balancer that will serve traffic to the service.
ApplicationLoadBalancedFargateService.Builder	maxHealthyPercent(Number 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.
ApplicationLoadBalancedFargateService.Builder	memoryLimitMiB(Number memoryLimitMiB) The amount (in MiB) of memory used by the task.
ApplicationLoadBalancedFargateService.Builder	minHealthyPercent(Number 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.
ApplicationLoadBalancedFargateService.Builder	propagateTags(PropagatedTagSource propagateTags) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
ApplicationLoadBalancedFargateService.Builder	protocol(ApplicationProtocol protocol) The protocol for connections from clients to the load balancer.
ApplicationLoadBalancedFargateService.Builder	publicLoadBalancer(Boolean publicLoadBalancer) Determines whether the Load Balancer will be internet-facing.
ApplicationLoadBalancedFargateService.Builder	serviceName(String serviceName) The name of the service.
ApplicationLoadBalancedFargateService.Builder	taskDefinition(FargateTaskDefinition taskDefinition) The task definition to use for tasks in the service.
ApplicationLoadBalancedFargateService.Builder	taskImageOptions(ApplicationLoadBalancedTaskImageOptions taskImageOptions) The properties required to create a new task definition.
ApplicationLoadBalancedFargateService.Builder	vpc(IVpc vpc) The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static ApplicationLoadBalancedFargateService.Builder create(Construct scope,
                                                                                            String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ApplicationLoadBalancedFargateService.Builder.

certificate

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder certificate(ICertificate certificate)

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.

Parameters:

certificate - Certificate Manager certificate to associate with the load balancer. This parameter is required.

Returns:

this

cloudMapOptions

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)

The options for configuring an Amazon ECS service to use service discovery.

Default: - AWS Cloud Map service discovery is not enabled.

Parameters:

cloudMapOptions - The options for configuring an Amazon ECS service to use service discovery. This parameter is required.

Returns:

this

cluster

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder cluster(ICluster 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.

Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

Parameters:

cluster - The name of the cluster that hosts the service. This parameter is required.

Returns:

this

desiredCount

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder desiredCount(Number desiredCount)

The desired number of instantiations of the task definition to keep running on the service.

The minimum value is 1

Default: 1

Parameters:

desiredCount - The desired number of instantiations of the task definition to keep running on the service. This parameter is required.

Returns:

this

domainName

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder domainName(String domainName)

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

Default: - No domain name.

Parameters:

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

Returns:

this

domainZone

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder domainZone(IHostedZone domainZone)

The Route53 hosted zone for the domain, e.g. "example.com.".

Default: - No Route53 hosted domain zone.

Parameters:

domainZone - The Route53 hosted zone for the domain, e.g. "example.com.". This parameter is required.

Returns:

this

enableEcsManagedTags

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

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

Parameters:

enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. This parameter is required.

Returns:

this

healthCheckGracePeriod

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder healthCheckGracePeriod(Duration 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.

Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

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. This parameter is required.

Returns:

this

listenerPort

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder listenerPort(Number listenerPort)

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.

Parameters:

listenerPort - Listener port of the application load balancer that will serve traffic to the service. This parameter is required.

Returns:

this

loadBalancer

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder loadBalancer(IApplicationLoadBalancer 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]

Default: - a new load balancer will be created.

Parameters:

loadBalancer - The application load balancer that will serve traffic to the service. This parameter is required.

Returns:

this

maxHealthyPercent

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder maxHealthyPercent(Number 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.

Default: - 100 if daemon, otherwise 200

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. This parameter is required.

Returns:

this

minHealthyPercent

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder minHealthyPercent(Number 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.

Default: - 0 if daemon, otherwise 50

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. This parameter is required.

Returns:

this

propagateTags

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder propagateTags(PropagatedTagSource 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.

Default: - none

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. This parameter is required.

Returns:

this

protocol

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder protocol(ApplicationProtocol 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.

Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.

Parameters:

protocol - The protocol for connections from clients to the load balancer. This parameter is required.

Returns:

this

publicLoadBalancer

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder publicLoadBalancer(Boolean publicLoadBalancer)

Determines whether the Load Balancer will be internet-facing.

Default: true

Parameters:

publicLoadBalancer - Determines whether the Load Balancer will be internet-facing. This parameter is required.

Returns:

this

serviceName

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder serviceName(String serviceName)

The name of the service.

Default: - CloudFormation-generated name.

Parameters:

serviceName - The name of the service. This parameter is required.

Returns:

this

taskImageOptions

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder taskImageOptions(ApplicationLoadBalancedTaskImageOptions taskImageOptions)

The properties required to create a new task definition.

TaskDefinition or TaskImageOptions must be specified, but not both.

Default: none

Parameters:

taskImageOptions - The properties required to create a new task definition. This parameter is required.

Returns:

this

vpc

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder vpc(IVpc 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.

Default: - uses the VPC defined in the cluster or creates a new VPC.

Parameters:

vpc - The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. This parameter is required.

Returns:

this

assignPublicIp

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder assignPublicIp(Boolean assignPublicIp)

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

Default: false

Parameters:

assignPublicIp - Determines whether the service will be assigned a public IP address. This parameter is required.

Returns:

this

cpu

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder cpu(Number 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.

Default: 256

Parameters:

cpu - The number of cpu units used by the task. This parameter is required.

Returns:

this

memoryLimitMiB

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder memoryLimitMiB(Number 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.

Default: 512

Parameters:

memoryLimitMiB - The amount (in MiB) of memory used by the task. This parameter is required.

Returns:

this

taskDefinition

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService.Builder taskDefinition(FargateTaskDefinition 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]

Default: - none

Parameters:

taskDefinition - The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ApplicationLoadBalancedFargateService build()