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

Class ApplicationLoadBalancedFargateService.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedFargateService.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ApplicationLoadBalancedFargateService>
Enclosing class:
ApplicationLoadBalancedFargateService
@Stability(Stable) public static final class ApplicationLoadBalancedFargateService.Builder extends Object implements software.amazon.jsii.Builder<ApplicationLoadBalancedFargateService>
A fluent builder for ApplicationLoadBalancedFargateService.

  • Method Details

    • create

      @Stability(Stable) public static ApplicationLoadBalancedFargateService.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of ApplicationLoadBalancedFargateService.Builder.

    • capacityProviderStrategies

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)
      A list of Capacity Provider strategies used to place a service.

      Default: - undefined

      Parameters:
      capacityProviderStrategies - A list of Capacity Provider strategies used to place a service. This parameter is required.
      Returns:
      this

    • certificate

      @Stability(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 if a domain name and domain zone are specified.

      Parameters:
      certificate - Certificate Manager certificate to associate with the load balancer. This parameter is required.
      Returns:
      this

    • circuitBreaker

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder circuitBreaker(DeploymentCircuitBreaker circuitBreaker)
      Whether to enable the deployment circuit breaker.

      If this property is defined, circuit breaker will be implicitly enabled.

      Default: - disabled

      Parameters:
      circuitBreaker - Whether to enable the deployment circuit breaker. This parameter is required.
      Returns:
      this

    • cloudMapOptions

      @Stability(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(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

    • deploymentController

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder deploymentController(DeploymentController deploymentController)
      Specifies which deployment controller to use for the service.

      For more information, see Amazon ECS Deployment Types

      Default: - Rolling update (ECS)

      Parameters:
      deploymentController - Specifies which deployment controller to use for the service. This parameter is required.
      Returns:
      this

    • desiredCount

      @Stability(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: - The default is 1 for all new services and uses the existing service's desired count when updating an existing service.

      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(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(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(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

    • enableExecuteCommand

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder enableExecuteCommand(Boolean enableExecuteCommand)
      Whether ECS Exec should be enabled.

      Default: - false

      Parameters:
      enableExecuteCommand - Whether ECS Exec should be enabled. This parameter is required.
      Returns:
      this

    • healthCheckGracePeriod

      @Stability(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

    • idleTimeout

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder idleTimeout(Duration idleTimeout)
      The load balancer idle timeout, in seconds.

      Can be between 1 and 4000 seconds

      Default: - CloudFormation sets idle timeout to 60 seconds

      Parameters:
      idleTimeout - The load balancer idle timeout, in seconds. This parameter is required.
      Returns:
      this

    • listenerPort

      @Stability(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(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

    • loadBalancerName

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder loadBalancerName(String loadBalancerName)
      Name of the load balancer.

      Default: - Automatically generated name.

      Parameters:
      loadBalancerName - Name of the load balancer. This parameter is required.
      Returns:
      this

    • maxHealthyPercent

      @Stability(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(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

    • openListener

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder openListener(Boolean openListener)
      Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.

      Default: true -- The security group allows ingress from all IP addresses.

      Parameters:
      openListener - Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default. This parameter is required.
      Returns:
      this

    • propagateTags

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

      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

    • protocolVersion

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder protocolVersion(ApplicationProtocolVersion protocolVersion)
      The protocol version to use.

      Default: ApplicationProtocolVersion.HTTP1

      Parameters:
      protocolVersion - The protocol version to use. This parameter is required.
      Returns:
      this

    • publicLoadBalancer

      @Stability(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

    • recordType

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder recordType(ApplicationLoadBalancedServiceRecordType 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.

      Default: ApplicationLoadBalancedServiceRecordType.ALIAS

      Parameters:
      recordType - Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. This parameter is required.
      Returns:
      this

    • redirectHttp

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

      Default: false

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

    • serviceName

      @Stability(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

    • sslPolicy

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder sslPolicy(SslPolicy sslPolicy)
      The security policy that defines which ciphers and protocols are supported by the ALB Listener.

      Default: - The recommended elastic load balancing security policy

      Parameters:
      sslPolicy - The security policy that defines which ciphers and protocols are supported by the ALB Listener. This parameter is required.
      Returns:
      this

    • targetProtocol

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

      Default: HTTP.

      Parameters:
      targetProtocol - The protocol for connections from the load balancer to the ECS tasks. This parameter is required.
      Returns:
      this

    • taskImageOptions

      @Stability(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(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

    • cpu

      @Stability(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

      8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments

      16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB 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

    • ephemeralStorageGiB

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder ephemeralStorageGiB(Number ephemeralStorageGiB)
      The amount (in GiB) of ephemeral storage to be allocated to the task.

      The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

      Only supported in Fargate platform version 1.4.0 or later.

      Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.

      Parameters:
      ephemeralStorageGiB - The amount (in GiB) of ephemeral storage to be allocated to the task. This parameter is required.
      Returns:
      this

    • memoryLimitMiB

      @Stability(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)

      Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

      Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 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

    • platformVersion

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder platformVersion(FargatePlatformVersion 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.

      Default: Latest

      Parameters:
      platformVersion - The platform version on which to run your service. This parameter is required.
      Returns:
      this

    • runtimePlatform

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder runtimePlatform(RuntimePlatform runtimePlatform)
      The runtime platform of the task definition.

      Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64

      Parameters:
      runtimePlatform - The runtime platform of the task definition. This parameter is required.
      Returns:
      this

    • taskDefinition

      @Stability(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

    • assignPublicIp

      @Stability(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

    • healthCheck

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder healthCheck(HealthCheck healthCheck)
      The health check command and associated configuration parameters for the container.

      Default: - Health check configuration from container.

      Parameters:
      healthCheck - The health check command and associated configuration parameters for the container. This parameter is required.
      Returns:
      this

    • securityGroups

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
      The security groups to associate with the service.

      If you do not specify a security group, a new security group is created.

      Default: - A new security group is created.

      Parameters:
      securityGroups - The security groups to associate with the service. This parameter is required.
      Returns:
      this

    • taskSubnets

      @Stability(Stable) public ApplicationLoadBalancedFargateService.Builder taskSubnets(SubnetSelection taskSubnets)
      The subnets to associate with the service.

      Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.

      Parameters:
      taskSubnets - The subnets to associate with the service. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public ApplicationLoadBalancedFargateService build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ApplicationLoadBalancedFargateService>
      Returns:
      a newly built instance of ApplicationLoadBalancedFargateService.