QueueProcessingFargateServiceProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.ecs.patterns.QueueProcessingFargateServiceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<QueueProcessingFargateServiceProps>

Enclosing interface:

QueueProcessingFargateServiceProps
```
@Stability(value=Stable)
public static final class QueueProcessingFargateServiceProps.Builder
extends Object
implements software.amazon.jsii.Builder<QueueProcessingFargateServiceProps>
```
A builder for QueueProcessingFargateServiceProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueueProcessingFargateServiceProps.Builder`	`assignPublicIp(Boolean assignPublicIp)` Sets the value of `QueueProcessingFargateServiceProps.getAssignPublicIp()`
`QueueProcessingFargateServiceProps`	`build()` Builds the configured instance.
`QueueProcessingFargateServiceProps.Builder`	`capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)` Sets the value of `QueueProcessingServiceBaseProps.getCapacityProviderStrategies()`
`QueueProcessingFargateServiceProps.Builder`	`circuitBreaker(DeploymentCircuitBreaker circuitBreaker)` Sets the value of `QueueProcessingServiceBaseProps.getCircuitBreaker()`
`QueueProcessingFargateServiceProps.Builder`	`cluster(ICluster cluster)` Sets the value of `QueueProcessingServiceBaseProps.getCluster()`
`QueueProcessingFargateServiceProps.Builder`	`command(List<String> command)` Sets the value of `QueueProcessingServiceBaseProps.getCommand()`
`QueueProcessingFargateServiceProps.Builder`	`containerName(String containerName)` Sets the value of `QueueProcessingFargateServiceProps.getContainerName()`
`QueueProcessingFargateServiceProps.Builder`	`cpu(Number cpu)` Sets the value of `FargateServiceBaseProps.getCpu()`
`QueueProcessingFargateServiceProps.Builder`	`deploymentController(DeploymentController deploymentController)` Sets the value of `QueueProcessingServiceBaseProps.getDeploymentController()`
`QueueProcessingFargateServiceProps.Builder`	`enableEcsManagedTags(Boolean enableEcsManagedTags)` Sets the value of `QueueProcessingFargateServiceProps#getEnableEcsManagedTags`
`QueueProcessingFargateServiceProps.Builder`	`enableExecuteCommand(Boolean enableExecuteCommand)` Sets the value of `QueueProcessingServiceBaseProps.getEnableExecuteCommand()`
`QueueProcessingFargateServiceProps.Builder`	`enableLogging(Boolean enableLogging)` Sets the value of `QueueProcessingServiceBaseProps.getEnableLogging()`
`QueueProcessingFargateServiceProps.Builder`	`environment(Map<String,String> environment)` Sets the value of `QueueProcessingServiceBaseProps.getEnvironment()`
`QueueProcessingFargateServiceProps.Builder`	`family(String family)` Sets the value of `QueueProcessingServiceBaseProps.getFamily()`
`QueueProcessingFargateServiceProps.Builder`	`healthCheck(HealthCheck healthCheck)` Sets the value of `QueueProcessingFargateServiceProps.getHealthCheck()`
`QueueProcessingFargateServiceProps.Builder`	`image(ContainerImage image)` Sets the value of `QueueProcessingServiceBaseProps.getImage()`
`QueueProcessingFargateServiceProps.Builder`	`logDriver(LogDriver logDriver)` Sets the value of `QueueProcessingServiceBaseProps.getLogDriver()`
`QueueProcessingFargateServiceProps.Builder`	`maxHealthyPercent(Number maxHealthyPercent)` Sets the value of `QueueProcessingServiceBaseProps.getMaxHealthyPercent()`
`QueueProcessingFargateServiceProps.Builder`	`maxReceiveCount(Number maxReceiveCount)` Sets the value of `QueueProcessingServiceBaseProps.getMaxReceiveCount()`
`QueueProcessingFargateServiceProps.Builder`	`maxScalingCapacity(Number maxScalingCapacity)` Sets the value of `QueueProcessingServiceBaseProps.getMaxScalingCapacity()`
`QueueProcessingFargateServiceProps.Builder`	`memoryLimitMiB(Number memoryLimitMiB)` Sets the value of `FargateServiceBaseProps.getMemoryLimitMiB()`
`QueueProcessingFargateServiceProps.Builder`	`minHealthyPercent(Number minHealthyPercent)` Sets the value of `QueueProcessingServiceBaseProps.getMinHealthyPercent()`
`QueueProcessingFargateServiceProps.Builder`	`minScalingCapacity(Number minScalingCapacity)` Sets the value of `QueueProcessingServiceBaseProps.getMinScalingCapacity()`
`QueueProcessingFargateServiceProps.Builder`	`platformVersion(FargatePlatformVersion platformVersion)` Sets the value of `FargateServiceBaseProps.getPlatformVersion()`
`QueueProcessingFargateServiceProps.Builder`	`propagateTags(PropagatedTagSource propagateTags)` Sets the value of `QueueProcessingServiceBaseProps.getPropagateTags()`
`QueueProcessingFargateServiceProps.Builder`	`queue(IQueue queue)` Sets the value of `QueueProcessingServiceBaseProps.getQueue()`
`QueueProcessingFargateServiceProps.Builder`	`retentionPeriod(Duration retentionPeriod)` Sets the value of `QueueProcessingServiceBaseProps.getRetentionPeriod()`
`QueueProcessingFargateServiceProps.Builder`	`runtimePlatform(RuntimePlatform runtimePlatform)` Sets the value of `FargateServiceBaseProps.getRuntimePlatform()`
`QueueProcessingFargateServiceProps.Builder`	`scalingSteps(List<? extends ScalingInterval> scalingSteps)` Sets the value of `QueueProcessingServiceBaseProps.getScalingSteps()`
`QueueProcessingFargateServiceProps.Builder`	`secrets(Map<String,? extends Secret> secrets)` Sets the value of `QueueProcessingServiceBaseProps.getSecrets()`
`QueueProcessingFargateServiceProps.Builder`	`securityGroups(List<? extends ISecurityGroup> securityGroups)` Sets the value of `QueueProcessingFargateServiceProps.getSecurityGroups()`
`QueueProcessingFargateServiceProps.Builder`	`serviceName(String serviceName)` Sets the value of `QueueProcessingServiceBaseProps.getServiceName()`
`QueueProcessingFargateServiceProps.Builder`	`taskDefinition(FargateTaskDefinition taskDefinition)` Sets the value of `FargateServiceBaseProps.getTaskDefinition()`
`QueueProcessingFargateServiceProps.Builder`	`taskSubnets(SubnetSelection taskSubnets)` Sets the value of `QueueProcessingFargateServiceProps.getTaskSubnets()`
`QueueProcessingFargateServiceProps.Builder`	`visibilityTimeout(Duration visibilityTimeout)` Sets the value of `QueueProcessingServiceBaseProps.getVisibilityTimeout()`
`QueueProcessingFargateServiceProps.Builder`	`vpc(IVpc vpc)` Sets the value of `QueueProcessingServiceBaseProps.getVpc()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - assignPublicIp
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder assignPublicIp(Boolean assignPublicIp)
```
    Sets the value of QueueProcessingFargateServiceProps.getAssignPublicIp()
    
    Parameters:
    
    assignPublicIp - Specifies whether the task's elastic network interface receives a public IP address. If true, each task will receive a public IP address.
    
    Returns:
    
    this
  - containerName
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder containerName(String containerName)
```
    Sets the value of QueueProcessingFargateServiceProps.getContainerName()
    
    Parameters:
    
    containerName - Optional name for the container added.
    
    Returns:
    
    this
  - healthCheck
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder healthCheck(HealthCheck healthCheck)
```
    Sets the value of QueueProcessingFargateServiceProps.getHealthCheck()
    
    Parameters:
    
    healthCheck - The health check command and associated configuration parameters for the container.
    
    Returns:
    
    this
  - securityGroups
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
```
    Sets the value of QueueProcessingFargateServiceProps.getSecurityGroups()
    
    Parameters:
    
    securityGroups - The security groups to associate with the service. If you do not specify a security group, a new security group is created.
    
    Returns:
    
    this
  - taskSubnets
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder taskSubnets(SubnetSelection taskSubnets)
```
    Sets the value of QueueProcessingFargateServiceProps.getTaskSubnets()
    
    Parameters:
    
    taskSubnets - The subnets to associate with the service.
    
    Returns:
    
    this
  - image
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder image(ContainerImage image)
```
    Sets the value of QueueProcessingServiceBaseProps.getImage()
    
    Parameters:
    
    image - The image used to start a container. This parameter is required.
    
    Returns:
    
    this
  - capacityProviderStrategies
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)
```
    Sets the value of QueueProcessingServiceBaseProps.getCapacityProviderStrategies()
    
    Parameters:
    
    capacityProviderStrategies - A list of Capacity Provider strategies used to place a service.
    
    Returns:
    
    this
  - circuitBreaker
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder circuitBreaker(DeploymentCircuitBreaker circuitBreaker)
```
    Sets the value of QueueProcessingServiceBaseProps.getCircuitBreaker()
    
    Parameters:
    
    circuitBreaker - Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled.
    
    Returns:
    
    this
  - cluster
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder cluster(ICluster cluster)
```
    Sets the value of QueueProcessingServiceBaseProps.getCluster()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - command
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder command(List<String> command)
```
    Sets the value of QueueProcessingServiceBaseProps.getCommand()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - deploymentController
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder deploymentController(DeploymentController deploymentController)
```
    Sets the value of QueueProcessingServiceBaseProps.getDeploymentController()
    
    Parameters:
    
    deploymentController - Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types
    
    Returns:
    
    this
  - enableEcsManagedTags
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)
```
    Sets the value of QueueProcessingFargateServiceProps#getEnableEcsManagedTags
    
    Parameters:
    
    enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources
    
    Returns:
    
    this
  - enableExecuteCommand
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder enableExecuteCommand(Boolean enableExecuteCommand)
```
    Sets the value of QueueProcessingServiceBaseProps.getEnableExecuteCommand()
    
    Parameters:
    
    enableExecuteCommand - Whether ECS Exec should be enabled.
    
    Returns:
    
    this
  - enableLogging
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder enableLogging(Boolean enableLogging)
```
    Sets the value of QueueProcessingServiceBaseProps.getEnableLogging()
    
    Parameters:
    
    enableLogging - Flag to indicate whether to enable logging.
    
    Returns:
    
    this
  - environment
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder environment(Map<String,String> environment)
```
    Sets the value of QueueProcessingServiceBaseProps.getEnvironment()
    
    Parameters:
    
    environment - The environment variables to pass to the container. The variable QUEUE_NAME with value queue.queueName will always be passed.
    
    Returns:
    
    this
  - family
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder family(String family)
```
    Sets the value of QueueProcessingServiceBaseProps.getFamily()
    
    Parameters:
    
    family - The name of a family that the task definition is registered to. A family groups multiple versions of a task definition.
    
    Returns:
    
    this
  - logDriver
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder logDriver(LogDriver logDriver)
```
    Sets the value of QueueProcessingServiceBaseProps.getLogDriver()
    
    Parameters:
    
    logDriver - The log driver to use.
    
    Returns:
    
    this
  - maxHealthyPercent
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder maxHealthyPercent(Number maxHealthyPercent)
```
    Sets the value of QueueProcessingServiceBaseProps.getMaxHealthyPercent()
    
    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.
    
    Returns:
    
    this
  - maxReceiveCount
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder maxReceiveCount(Number maxReceiveCount)
```
    Sets the value of QueueProcessingServiceBaseProps.getMaxReceiveCount()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - maxScalingCapacity
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder maxScalingCapacity(Number maxScalingCapacity)
```
    Sets the value of QueueProcessingServiceBaseProps.getMaxScalingCapacity()
    
    Parameters:
    
    maxScalingCapacity - Maximum capacity to scale to.
    
    Returns:
    
    this
  - minHealthyPercent
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder minHealthyPercent(Number minHealthyPercent)
```
    Sets the value of QueueProcessingServiceBaseProps.getMinHealthyPercent()
    
    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.
    
    Returns:
    
    this
  - minScalingCapacity
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder minScalingCapacity(Number minScalingCapacity)
```
    Sets the value of QueueProcessingServiceBaseProps.getMinScalingCapacity()
    
    Parameters:
    
    minScalingCapacity - Minimum capacity to scale to.
    
    Returns:
    
    this
  - propagateTags
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder propagateTags(PropagatedTagSource propagateTags)
```
    Sets the value of QueueProcessingServiceBaseProps.getPropagateTags()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - queue
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder queue(IQueue queue)
```
    Sets the value of QueueProcessingServiceBaseProps.getQueue()
    
    Parameters:
    
    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
    
    Returns:
    
    this
  - retentionPeriod
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder retentionPeriod(Duration retentionPeriod)
```
    Sets the value of QueueProcessingServiceBaseProps.getRetentionPeriod()
    
    Parameters:
    
    retentionPeriod - The number of seconds that Dead Letter Queue retains a message. If the queue construct is specified, retentionPeriod should be omitted.
    
    Returns:
    
    this
  - scalingSteps
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder scalingSteps(List<? extends ScalingInterval> scalingSteps)
```
    Sets the value of QueueProcessingServiceBaseProps.getScalingSteps()
    
    Parameters:
    
    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
    
    Returns:
    
    this
  - secrets
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder secrets(Map<String,? extends Secret> secrets)
```
    Sets the value of QueueProcessingServiceBaseProps.getSecrets()
    
    Parameters:
    
    secrets - The secret to expose to the container as an environment variable.
    
    Returns:
    
    this
  - serviceName
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder serviceName(String serviceName)
```
    Sets the value of QueueProcessingServiceBaseProps.getServiceName()
    
    Parameters:
    
    serviceName - The name of the service.
    
    Returns:
    
    this
  - visibilityTimeout
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder visibilityTimeout(Duration visibilityTimeout)
```
    Sets the value of QueueProcessingServiceBaseProps.getVisibilityTimeout()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - vpc
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder vpc(IVpc vpc)
```
    Sets the value of QueueProcessingServiceBaseProps.getVpc()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - cpu
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder cpu(Number cpu)
```
    Sets the value of FargateServiceBaseProps.getCpu()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - memoryLimitMiB
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder memoryLimitMiB(Number memoryLimitMiB)
```
    Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - platformVersion
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder platformVersion(FargatePlatformVersion platformVersion)
```
    Sets the value of FargateServiceBaseProps.getPlatformVersion()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - runtimePlatform
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder runtimePlatform(RuntimePlatform runtimePlatform)
```
    Sets the value of FargateServiceBaseProps.getRuntimePlatform()
    
    Parameters:
    
    runtimePlatform - The runtime platform of the task definition.
    
    Returns:
    
    this
  - taskDefinition
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder taskDefinition(FargateTaskDefinition taskDefinition)
```
    Sets the value of FargateServiceBaseProps.getTaskDefinition()
    
    Parameters:
    
    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]
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public QueueProcessingFargateServiceProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<QueueProcessingFargateServiceProps>
    
    Returns:
    
    a new instance of QueueProcessingFargateServiceProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class QueueProcessingFargateServiceProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

assignPublicIp

containerName

healthCheck

securityGroups

taskSubnets

image

capacityProviderStrategies

circuitBreaker

cluster

command

deploymentController

enableEcsManagedTags

enableExecuteCommand

enableLogging

environment

family

logDriver

maxHealthyPercent

maxReceiveCount

maxScalingCapacity

minHealthyPercent

minScalingCapacity

propagateTags

queue

retentionPeriod

scalingSteps

secrets

serviceName

visibilityTimeout

vpc

cpu

memoryLimitMiB

platformVersion

runtimePlatform

taskDefinition

build