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

Class ApplicationLoadBalancedEc2Service.Builder

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

  • Method Details

    • create

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

    • capacityProviderStrategies

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

    • ipAddressType

      @Stability(Stable) public ApplicationLoadBalancedEc2Service.Builder ipAddressType(IpAddressType ipAddressType)
      The type of IP address to use.

      Default: - IpAddressType.IPV4

      Parameters:
      ipAddressType - The type of IP address to use. This parameter is required.
      Returns:
      this

    • listenerPort

      @Stability(Stable) public ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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 ApplicationLoadBalancedEc2Service.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: none

      Parameters:
      cpu - The number of cpu units used by the task. This parameter is required.
      Returns:
      this

    • memoryLimitMiB

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

      Default: - No memory limit.

      Parameters:
      memoryLimitMiB - The hard limit (in MiB) of memory to present to the container. This parameter is required.
      Returns:
      this

    • memoryReservationMiB

      @Stability(Stable) public ApplicationLoadBalancedEc2Service.Builder memoryReservationMiB(Number 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.

      Default: - No memory reserved.

      Parameters:
      memoryReservationMiB - The soft limit (in MiB) of memory to reserve for the container. This parameter is required.
      Returns:
      this

    • placementConstraints

      @Stability(Stable) public ApplicationLoadBalancedEc2Service.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints)
      The placement constraints to use for tasks in the service.

      For more information, see Amazon ECS Task Placement Constraints.

      Default: - No constraints.

      Parameters:
      placementConstraints - The placement constraints to use for tasks in the service. This parameter is required.
      Returns:
      this

    • placementStrategies

      @Stability(Stable) public ApplicationLoadBalancedEc2Service.Builder placementStrategies(List<? extends PlacementStrategy> placementStrategies)
      The placement strategies to use for tasks in the service.

      For more information, see Amazon ECS Task Placement Strategies.

      Default: - No strategies.

      Parameters:
      placementStrategies - The placement strategies to use for tasks in the service. This parameter is required.
      Returns:
      this

    • taskDefinition

      @Stability(Stable) public ApplicationLoadBalancedEc2Service.Builder taskDefinition(Ec2TaskDefinition 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(Stable) public ApplicationLoadBalancedEc2Service build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ApplicationLoadBalancedEc2Service>
      Returns:
      a newly built instance of ApplicationLoadBalancedEc2Service.