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

Class QueueProcessingFargateService.Builder

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

  • Method Details

    • create

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

    • capacityProviderStrategies

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

    • circuitBreaker

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

    • cluster

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

    • command

      @Stability(Stable) public QueueProcessingFargateService.Builder command(List<String> command)
      The command that is passed to the container.

      If you provide a shell command as a single string, you have to quote command-line arguments.

      Default: - CMD value built into container image.

      Parameters:
      command - The command that is passed to the container. This parameter is required.
      Returns:
      this

    • cooldown

      @Stability(Stable) public QueueProcessingFargateService.Builder cooldown(Duration cooldown)
      Grace period after scaling activity in seconds.

      Subsequent scale outs during the cooldown period are squashed so that only the biggest scale out happens.

      Subsequent scale ins during the cooldown period are ignored.

      Default: 300 seconds

      Parameters:
      cooldown - Grace period after scaling activity in seconds. This parameter is required.
      Returns:
      this
      See Also:

    • cpuTargetUtilizationPercent

      @Stability(Stable) public QueueProcessingFargateService.Builder cpuTargetUtilizationPercent(Number cpuTargetUtilizationPercent)
      The target CPU utilization percentage for CPU based scaling strategy when enabled.

      Default: - 50

      Parameters:
      cpuTargetUtilizationPercent - The target CPU utilization percentage for CPU based scaling strategy when enabled. This parameter is required.
      Returns:
      this

    • deploymentController

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

    • disableCpuBasedScaling

      @Stability(Stable) public QueueProcessingFargateService.Builder disableCpuBasedScaling(Boolean disableCpuBasedScaling)
      Flag to disable CPU based auto scaling strategy on the service.

      Default: - false

      Parameters:
      disableCpuBasedScaling - Flag to disable CPU based auto scaling strategy on the service. This parameter is required.
      Returns:
      this

    • enableEcsManagedTags

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

    • enableLogging

      @Stability(Stable) public QueueProcessingFargateService.Builder enableLogging(Boolean enableLogging)
      Flag to indicate whether to enable logging.

      Default: true

      Parameters:
      enableLogging - Flag to indicate whether to enable logging. This parameter is required.
      Returns:
      this

    • environment

      @Stability(Stable) public QueueProcessingFargateService.Builder environment(Map<String,String> environment)
      The environment variables to pass to the container.

      The variable QUEUE_NAME with value queue.queueName will always be passed.

      Default: 'QUEUE_NAME: queue.queueName'

      Parameters:
      environment - The environment variables to pass to the container. This parameter is required.
      Returns:
      this

    • family

      @Stability(Stable) public QueueProcessingFargateService.Builder family(String family)
      The name of a family that the task definition is registered to.

      A family groups multiple versions of a task definition.

      Default: - Automatically generated name.

      Parameters:
      family - The name of a family that the task definition is registered to. This parameter is required.
      Returns:
      this

    • image

      @Stability(Stable) public QueueProcessingFargateService.Builder image(ContainerImage image)
      The image used to start a container.

      For QueueProcessingFargateService, either image or taskDefinition must be specified, but not both. For QueueProcessingEc2Service, image is required.

      Default: - the image of the task definition is used for Fargate, required otherwise

      Parameters:
      image - The image used to start a container. This parameter is required.
      Returns:
      this

    • logDriver

      @Stability(Stable) public QueueProcessingFargateService.Builder logDriver(LogDriver logDriver)
      The log driver to use.

      Default: - AwsLogDriver if enableLogging is true

      Parameters:
      logDriver - The log driver to use. This parameter is required.
      Returns:
      this

    • maxHealthyPercent

      @Stability(Stable) public QueueProcessingFargateService.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: - default from underlying service.

      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

    • maxReceiveCount

      @Stability(Stable) public QueueProcessingFargateService.Builder maxReceiveCount(Number maxReceiveCount)
      The maximum number of times that a message can be received by consumers.

      When this value is exceeded for a message the message will be automatically sent to the Dead Letter Queue.

      If the queue construct is specified, maxReceiveCount should be omitted.

      Default: 3

      Parameters:
      maxReceiveCount - The maximum number of times that a message can be received by consumers. This parameter is required.
      Returns:
      this

    • maxScalingCapacity

      @Stability(Stable) public QueueProcessingFargateService.Builder maxScalingCapacity(Number maxScalingCapacity)
      Maximum capacity to scale to.

      Default: 2

      Parameters:
      maxScalingCapacity - Maximum capacity to scale to. This parameter is required.
      Returns:
      this

    • minHealthyPercent

      @Stability(Stable) public QueueProcessingFargateService.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: - default from underlying service.

      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

    • minScalingCapacity

      @Stability(Stable) public QueueProcessingFargateService.Builder minScalingCapacity(Number minScalingCapacity)
      Minimum capacity to scale to.

      Default: 1

      Parameters:
      minScalingCapacity - Minimum capacity to scale to. This parameter is required.
      Returns:
      this

    • propagateTags

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

    • queue

      @Stability(Stable) public QueueProcessingFargateService.Builder queue(IQueue queue)
      A queue for which to process items from.

      If specified and this is a FIFO queue, the queue name must end in the string '.fifo'. See CreateQueue

      Default: 'SQSQueue with CloudFormation-generated name'

      Parameters:
      queue - A queue for which to process items from. This parameter is required.
      Returns:
      this

    • retentionPeriod

      @Stability(Stable) public QueueProcessingFargateService.Builder retentionPeriod(Duration retentionPeriod)
      The number of seconds that Dead Letter Queue retains a message.

      If the queue construct is specified, retentionPeriod should be omitted.

      Default: Duration.days(14)

      Parameters:
      retentionPeriod - The number of seconds that Dead Letter Queue retains a message. This parameter is required.
      Returns:
      this

    • scalingSteps

      @Stability(Stable) public QueueProcessingFargateService.Builder scalingSteps(List<? extends ScalingInterval> scalingSteps)
      The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.

      Maps a range of metric values to a particular scaling behavior. See Simple and Step Scaling Policies for Amazon EC2 Auto Scaling

      Default: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }]

      Parameters:
      scalingSteps - The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric. This parameter is required.
      Returns:
      this

    • secrets

      @Stability(Stable) public QueueProcessingFargateService.Builder secrets(Map<String,? extends Secret> secrets)
      The secret to expose to the container as an environment variable.

      Default: - No secret environment variables.

      Parameters:
      secrets - The secret to expose to the container as an environment variable. This parameter is required.
      Returns:
      this

    • serviceName

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

    • visibilityTimeout

      @Stability(Stable) public QueueProcessingFargateService.Builder visibilityTimeout(Duration visibilityTimeout)
      Timeout of processing a single message.

      After dequeuing, the processor has this much time to handle the message and delete it from the queue before it becomes visible again for dequeueing by another processor. Values must be between 0 and (12 hours).

      If the queue construct is specified, visibilityTimeout should be omitted.

      Default: Duration.seconds(30)

      Parameters:
      visibilityTimeout - Timeout of processing a single message. This parameter is required.
      Returns:
      this

    • vpc

      @Stability(Stable) public QueueProcessingFargateService.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 QueueProcessingFargateService.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 QueueProcessingFargateService.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 QueueProcessingFargateService.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 QueueProcessingFargateService.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 QueueProcessingFargateService.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 QueueProcessingFargateService.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 QueueProcessingFargateService.Builder assignPublicIp(Boolean assignPublicIp)
      Specifies whether the task's elastic network interface receives a public IP address.

      If true, each task will receive a public IP address.

      Default: false

      Parameters:
      assignPublicIp - Specifies whether the task's elastic network interface receives a public IP address. This parameter is required.
      Returns:
      this

    • containerName

      @Stability(Stable) public QueueProcessingFargateService.Builder containerName(String containerName)
      Optional name for the container added.

      This name is not used when taskDefinition is provided.

      Default: - QueueProcessingContainer

      Parameters:
      containerName - Optional name for the container added. This parameter is required.
      Returns:
      this

    • healthCheck

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