QueueProcessingEc2ServiceProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

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

All Implemented Interfaces:: software.amazon.jsii.Builder<QueueProcessingEc2ServiceProps>

Enclosing interface:: QueueProcessingEc2ServiceProps

@Stability(value=Experimental)
public static final class QueueProcessingEc2ServiceProps.Builder
extends Object
implements software.amazon.jsii.Builder<QueueProcessingEc2ServiceProps>

A builder for QueueProcessingEc2ServiceProps

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
`QueueProcessingEc2ServiceProps`	`build()` Builds the configured instance.
`QueueProcessingEc2ServiceProps.Builder`	`circuitBreaker(DeploymentCircuitBreaker circuitBreaker)` Sets the value of `QueueProcessingServiceBaseProps.getCircuitBreaker()`
`QueueProcessingEc2ServiceProps.Builder`	`cluster(ICluster cluster)` Sets the value of `QueueProcessingServiceBaseProps.getCluster()`
`QueueProcessingEc2ServiceProps.Builder`	`command(List<String> command)` Sets the value of `QueueProcessingServiceBaseProps.getCommand()`
`QueueProcessingEc2ServiceProps.Builder`	`containerName(String containerName)` Sets the value of `QueueProcessingEc2ServiceProps.getContainerName()`
`QueueProcessingEc2ServiceProps.Builder`	`cpu(Number cpu)` Sets the value of `QueueProcessingEc2ServiceProps.getCpu()`
`QueueProcessingEc2ServiceProps.Builder`	`deploymentController(DeploymentController deploymentController)` Sets the value of `QueueProcessingServiceBaseProps.getDeploymentController()`
`QueueProcessingEc2ServiceProps.Builder`	`enableEcsManagedTags(Boolean enableEcsManagedTags)` Sets the value of `QueueProcessingEc2ServiceProps#getEnableEcsManagedTags`
`QueueProcessingEc2ServiceProps.Builder`	`enableLogging(Boolean enableLogging)` Sets the value of `QueueProcessingServiceBaseProps.getEnableLogging()`
`QueueProcessingEc2ServiceProps.Builder`	`environment(Map<String,String> environment)` Sets the value of `QueueProcessingServiceBaseProps.getEnvironment()`
`QueueProcessingEc2ServiceProps.Builder`	`family(String family)` Sets the value of `QueueProcessingServiceBaseProps.getFamily()`
`QueueProcessingEc2ServiceProps.Builder`	`image(ContainerImage image)` Sets the value of `QueueProcessingServiceBaseProps.getImage()`
`QueueProcessingEc2ServiceProps.Builder`	`logDriver(LogDriver logDriver)` Sets the value of `QueueProcessingServiceBaseProps.getLogDriver()`
`QueueProcessingEc2ServiceProps.Builder`	`maxHealthyPercent(Number maxHealthyPercent)` Sets the value of `QueueProcessingServiceBaseProps.getMaxHealthyPercent()`
`QueueProcessingEc2ServiceProps.Builder`	`maxReceiveCount(Number maxReceiveCount)` Sets the value of `QueueProcessingServiceBaseProps.getMaxReceiveCount()`
`QueueProcessingEc2ServiceProps.Builder`	`maxScalingCapacity(Number maxScalingCapacity)` Sets the value of `QueueProcessingServiceBaseProps.getMaxScalingCapacity()`
`QueueProcessingEc2ServiceProps.Builder`	`memoryLimitMiB(Number memoryLimitMiB)` Sets the value of `QueueProcessingEc2ServiceProps.getMemoryLimitMiB()`
`QueueProcessingEc2ServiceProps.Builder`	`memoryReservationMiB(Number memoryReservationMiB)` Sets the value of `QueueProcessingEc2ServiceProps.getMemoryReservationMiB()`
`QueueProcessingEc2ServiceProps.Builder`	`minHealthyPercent(Number minHealthyPercent)` Sets the value of `QueueProcessingServiceBaseProps.getMinHealthyPercent()`
`QueueProcessingEc2ServiceProps.Builder`	`minScalingCapacity(Number minScalingCapacity)` Sets the value of `QueueProcessingServiceBaseProps.getMinScalingCapacity()`
`QueueProcessingEc2ServiceProps.Builder`	`propagateTags(PropagatedTagSource propagateTags)` Sets the value of `QueueProcessingServiceBaseProps.getPropagateTags()`
`QueueProcessingEc2ServiceProps.Builder`	`queue(IQueue queue)` Sets the value of `QueueProcessingServiceBaseProps.getQueue()`
`QueueProcessingEc2ServiceProps.Builder`	`retentionPeriod(Duration retentionPeriod)` Sets the value of `QueueProcessingServiceBaseProps.getRetentionPeriod()`
`QueueProcessingEc2ServiceProps.Builder`	`scalingSteps(List<? extends ScalingInterval> scalingSteps)` Sets the value of `QueueProcessingServiceBaseProps.getScalingSteps()`
`QueueProcessingEc2ServiceProps.Builder`	`secrets(Map<String,? extends Secret> secrets)` Sets the value of `QueueProcessingServiceBaseProps.getSecrets()`
`QueueProcessingEc2ServiceProps.Builder`	`serviceName(String serviceName)` Sets the value of `QueueProcessingServiceBaseProps.getServiceName()`
`QueueProcessingEc2ServiceProps.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
  - containerName
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.Builder containerName(String containerName)
```
    Sets the value of QueueProcessingEc2ServiceProps.getContainerName()
    
    Parameters:
    
    containerName - Optional name for the container added.
    
    Returns:
    
    this
  - cpu
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.Builder cpu(Number cpu)
```
    Sets the value of QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.Builder memoryLimitMiB(Number memoryLimitMiB)
```
    Sets the value of QueueProcessingEc2ServiceProps.getMemoryLimitMiB()
    
    Parameters:
    
    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 for non-Fargate services.
    
    Returns:
    
    this
  - memoryReservationMiB
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.Builder memoryReservationMiB(Number memoryReservationMiB)
```
    Sets the value of QueueProcessingEc2ServiceProps.getMemoryReservationMiB()
    
    Parameters:
    
    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 for non-Fargate services.
    
    Returns:
    
    this
  - image
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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
  - circuitBreaker
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)
```
    Sets the value of QueueProcessingEc2ServiceProps#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
  - enableLogging
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.Builder enableLogging(Boolean enableLogging)
```
    Sets the value of QueueProcessingServiceBaseProps.getEnableLogging()
    
    Parameters:
    
    enableLogging - Flag to indicate whether to enable logging.
    
    Returns:
    
    this
  - environment
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.Builder logDriver(LogDriver logDriver)
```
    Sets the value of QueueProcessingServiceBaseProps.getLogDriver()
    
    Parameters:
    
    logDriver - The log driver to use.
    
    Returns:
    
    this
  - maxHealthyPercent
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.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.
    
    Returns:
    
    this
  - maxScalingCapacity
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.Builder maxScalingCapacity(Number maxScalingCapacity)
```
    Sets the value of QueueProcessingServiceBaseProps.getMaxScalingCapacity()
    
    Parameters:
    
    maxScalingCapacity - Maximum capacity to scale to.
    
    Returns:
    
    this
  - minHealthyPercent
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.Builder minScalingCapacity(Number minScalingCapacity)
```
    Sets the value of QueueProcessingServiceBaseProps.getMinScalingCapacity()
    
    Parameters:
    
    minScalingCapacity - Minimum capacity to scale to.
    
    Returns:
    
    this
  - propagateTags
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.Builder retentionPeriod(Duration retentionPeriod)
```
    Sets the value of QueueProcessingServiceBaseProps.getRetentionPeriod()
    
    Parameters:
    
    retentionPeriod - The number of seconds that Dead Letter Queue retains a message.
    
    Returns:
    
    this
  - scalingSteps
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.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=Experimental)
public QueueProcessingEc2ServiceProps.Builder serviceName(String serviceName)
```
    Sets the value of QueueProcessingServiceBaseProps.getServiceName()
    
    Parameters:
    
    serviceName - The name of the service.
    
    Returns:
    
    this
  - vpc
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps.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
  - build
```
@Stability(value=Experimental)
public QueueProcessingEc2ServiceProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<QueueProcessingEc2ServiceProps>
    
    Returns:
    
    a new instance of QueueProcessingEc2ServiceProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class QueueProcessingEc2ServiceProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

containerName

cpu

memoryLimitMiB

memoryReservationMiB

image

circuitBreaker

cluster

command

deploymentController

enableEcsManagedTags

enableLogging

environment

family

logDriver

maxHealthyPercent

maxReceiveCount

maxScalingCapacity

minHealthyPercent

minScalingCapacity

propagateTags

queue

retentionPeriod

scalingSteps

secrets

serviceName

vpc

build