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

Class NetworkLoadBalancedFargateService.Builder

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

  • Method Details

    • create

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

    • circuitBreaker

      @Stability(Stable) public NetworkLoadBalancedFargateService.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 NetworkLoadBalancedFargateService.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 NetworkLoadBalancedFargateService.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 NetworkLoadBalancedFargateService.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 NetworkLoadBalancedFargateService.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: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services 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 NetworkLoadBalancedFargateService.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 NetworkLoadBalancedFargateService.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 NetworkLoadBalancedFargateService.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(Stable) public NetworkLoadBalancedFargateService.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(Stable) public NetworkLoadBalancedFargateService.Builder listenerPort(Number listenerPort)
      Listener port of the network load balancer that will serve traffic to the service.

      Default: 80

      Parameters:
      listenerPort - Listener port of the network load balancer that will serve traffic to the service. This parameter is required.
      Returns:
      this

    • loadBalancer

      @Stability(Stable) public NetworkLoadBalancedFargateService.Builder loadBalancer(INetworkLoadBalancer loadBalancer)
      The network load balancer that will serve traffic to the service.

      If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes().

      [disable-awslint:ref-via-interface]

      Default: - a new load balancer will be created.

      Parameters:
      loadBalancer - The network load balancer that will serve traffic to the service. This parameter is required.
      Returns:
      this

    • maxHealthyPercent

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

    • publicLoadBalancer

      @Stability(Stable) public NetworkLoadBalancedFargateService.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 NetworkLoadBalancedFargateService.Builder recordType(NetworkLoadBalancedServiceRecordType 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: NetworkLoadBalancedServiceRecordType.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

    • serviceName

      @Stability(Stable) public NetworkLoadBalancedFargateService.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(Stable) public NetworkLoadBalancedFargateService.Builder taskImageOptions(NetworkLoadBalancedTaskImageOptions taskImageOptions)
      The properties required to create a new task definition.

      One of taskImageOptions or taskDefinition must be specified.

      Default: - none

      Parameters:
      taskImageOptions - The properties required to create a new task definition. This parameter is required.
      Returns:
      this

    • vpc

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

    • platformVersion

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

    • taskDefinition

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

    • taskSubnets

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