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

Class NetworkMultipleTargetGroupsFargateService.Builder

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

  • Method Details

    • create

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

    • cloudMapOptions

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

    • enableEcsManagedTags

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

    • loadBalancers

      @Stability(Stable) public NetworkMultipleTargetGroupsFargateService.Builder loadBalancers(List<? extends NetworkLoadBalancerProps> loadBalancers)
      The network load balancer that will serve traffic to the service.

      Default: - a new load balancer with a listener will be created.

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

    • propagateTags

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

    • serviceName

      @Stability(Stable) public NetworkMultipleTargetGroupsFargateService.Builder serviceName(String serviceName)
      Name of the service.

      Default: - CloudFormation-generated name.

      Parameters:
      serviceName - Name of the service. This parameter is required.
      Returns:
      this

    • targetGroups

      @Stability(Stable) public NetworkMultipleTargetGroupsFargateService.Builder targetGroups(List<? extends NetworkTargetProps> targetGroups)
      Properties to specify NLB target groups.

      Default: - default portMapping registered as target group and attached to the first defined listener

      Parameters:
      targetGroups - Properties to specify NLB target groups. This parameter is required.
      Returns:
      this

    • taskImageOptions

      @Stability(Stable) public NetworkMultipleTargetGroupsFargateService.Builder taskImageOptions(NetworkLoadBalancedTaskImageProps taskImageOptions)
      The properties required to create a new task definition.

      Only one of TaskDefinition or TaskImageOptions 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 NetworkMultipleTargetGroupsFargateService.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 NetworkMultipleTargetGroupsFargateService.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 NetworkMultipleTargetGroupsFargateService.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 NetworkMultipleTargetGroupsFargateService.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 NetworkMultipleTargetGroupsFargateService.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 NetworkMultipleTargetGroupsFargateService.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 NetworkMultipleTargetGroupsFargateService.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 NetworkMultipleTargetGroupsFargateService.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

    • build

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