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

Class QueueProcessingServiceBaseProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.patterns.QueueProcessingServiceBaseProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<QueueProcessingServiceBaseProps>

Enclosing interface:

QueueProcessingServiceBaseProps

@Stability(Stable)
public static final class QueueProcessingServiceBaseProps.Builder
extends Object
implements software.amazon.jsii.Builder<QueueProcessingServiceBaseProps>

A builder for QueueProcessingServiceBaseProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QueueProcessingServiceBaseProps	build()	Builds the configured instance.
QueueProcessingServiceBaseProps.Builder	capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)	Sets the value of QueueProcessingServiceBaseProps.getCapacityProviderStrategies()
QueueProcessingServiceBaseProps.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of QueueProcessingServiceBaseProps.getCircuitBreaker()
QueueProcessingServiceBaseProps.Builder	cluster(ICluster cluster)	Sets the value of QueueProcessingServiceBaseProps.getCluster()
QueueProcessingServiceBaseProps.Builder	command(List<String> command)	Sets the value of QueueProcessingServiceBaseProps.getCommand()
QueueProcessingServiceBaseProps.Builder	cooldown(Duration cooldown)	Sets the value of QueueProcessingServiceBaseProps.getCooldown()
QueueProcessingServiceBaseProps.Builder	cpuTargetUtilizationPercent(Number cpuTargetUtilizationPercent)	Sets the value of QueueProcessingServiceBaseProps.getCpuTargetUtilizationPercent()
QueueProcessingServiceBaseProps.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of QueueProcessingServiceBaseProps.getDeploymentController()
QueueProcessingServiceBaseProps.Builder	disableCpuBasedScaling(Boolean disableCpuBasedScaling)	Sets the value of QueueProcessingServiceBaseProps.getDisableCpuBasedScaling()
QueueProcessingServiceBaseProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link QueueProcessingServiceBaseProps#getEnableEcsManagedTags
QueueProcessingServiceBaseProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of QueueProcessingServiceBaseProps.getEnableExecuteCommand()
QueueProcessingServiceBaseProps.Builder	enableLogging(Boolean enableLogging)	Sets the value of QueueProcessingServiceBaseProps.getEnableLogging()
QueueProcessingServiceBaseProps.Builder	environment(Map<String,String> environment)	Sets the value of QueueProcessingServiceBaseProps.getEnvironment()
QueueProcessingServiceBaseProps.Builder	family(String family)	Sets the value of QueueProcessingServiceBaseProps.getFamily()
QueueProcessingServiceBaseProps.Builder	image(ContainerImage image)	Sets the value of QueueProcessingServiceBaseProps.getImage()
QueueProcessingServiceBaseProps.Builder	logDriver(LogDriver logDriver)	Sets the value of QueueProcessingServiceBaseProps.getLogDriver()
QueueProcessingServiceBaseProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of QueueProcessingServiceBaseProps.getMaxHealthyPercent()
QueueProcessingServiceBaseProps.Builder	maxReceiveCount(Number maxReceiveCount)	Sets the value of QueueProcessingServiceBaseProps.getMaxReceiveCount()
QueueProcessingServiceBaseProps.Builder	maxScalingCapacity(Number maxScalingCapacity)	Sets the value of QueueProcessingServiceBaseProps.getMaxScalingCapacity()
QueueProcessingServiceBaseProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of QueueProcessingServiceBaseProps.getMinHealthyPercent()
QueueProcessingServiceBaseProps.Builder	minScalingCapacity(Number minScalingCapacity)	Sets the value of QueueProcessingServiceBaseProps.getMinScalingCapacity()
QueueProcessingServiceBaseProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of QueueProcessingServiceBaseProps.getPropagateTags()
QueueProcessingServiceBaseProps.Builder	queue(IQueue queue)	Sets the value of QueueProcessingServiceBaseProps.getQueue()
QueueProcessingServiceBaseProps.Builder	retentionPeriod(Duration retentionPeriod)	Sets the value of QueueProcessingServiceBaseProps.getRetentionPeriod()
QueueProcessingServiceBaseProps.Builder	scalingSteps(List<? extends ScalingInterval> scalingSteps)	Sets the value of QueueProcessingServiceBaseProps.getScalingSteps()
QueueProcessingServiceBaseProps.Builder	secrets(Map<String,? extends Secret> secrets)	Sets the value of QueueProcessingServiceBaseProps.getSecrets()
QueueProcessingServiceBaseProps.Builder	serviceName(String serviceName)	Sets the value of QueueProcessingServiceBaseProps.getServiceName()
QueueProcessingServiceBaseProps.Builder	visibilityTimeout(Duration visibilityTimeout)	Sets the value of QueueProcessingServiceBaseProps.getVisibilityTimeout()
QueueProcessingServiceBaseProps.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 Details

Builder

public Builder()

Method Details

capacityProviderStrategies

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

cooldown

@Stability(Stable)
public QueueProcessingServiceBaseProps.Builder cooldown(Duration cooldown)

Sets the value of QueueProcessingServiceBaseProps.getCooldown()

Parameters:

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.

Returns:

this

cpuTargetUtilizationPercent

@Stability(Stable)
public QueueProcessingServiceBaseProps.Builder cpuTargetUtilizationPercent(Number cpuTargetUtilizationPercent)

Sets the value of QueueProcessingServiceBaseProps.getCpuTargetUtilizationPercent()

Parameters:

cpuTargetUtilizationPercent - The target CPU utilization percentage for CPU based scaling strategy when enabled.

Returns:

this

deploymentController

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

disableCpuBasedScaling

@Stability(Stable)
public QueueProcessingServiceBaseProps.Builder disableCpuBasedScaling(Boolean disableCpuBasedScaling)

Sets the value of QueueProcessingServiceBaseProps.getDisableCpuBasedScaling()

Parameters:

disableCpuBasedScaling - Flag to disable CPU based auto scaling strategy on the service.

Returns:

this

enableEcsManagedTags

@Stability(Stable)
public QueueProcessingServiceBaseProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of

invalid @link

QueueProcessingServiceBaseProps#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(Stable)
public QueueProcessingServiceBaseProps.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of QueueProcessingServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

enableLogging

@Stability(Stable)
public QueueProcessingServiceBaseProps.Builder enableLogging(Boolean enableLogging)

Sets the value of QueueProcessingServiceBaseProps.getEnableLogging()

Parameters:

enableLogging - Flag to indicate whether to enable logging.

Returns:

this

environment

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

image

@Stability(Stable)
public QueueProcessingServiceBaseProps.Builder image(ContainerImage image)

Sets the value of QueueProcessingServiceBaseProps.getImage()

Parameters:

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.

Returns:

this

logDriver

@Stability(Stable)
public QueueProcessingServiceBaseProps.Builder logDriver(LogDriver logDriver)

Sets the value of QueueProcessingServiceBaseProps.getLogDriver()

Parameters:

logDriver - The log driver to use.

Returns:

this

maxHealthyPercent

@Stability(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.Builder maxScalingCapacity(Number maxScalingCapacity)

Sets the value of QueueProcessingServiceBaseProps.getMaxScalingCapacity()

Parameters:

maxScalingCapacity - Maximum capacity to scale to.

Returns:

this

minHealthyPercent

@Stability(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.Builder minScalingCapacity(Number minScalingCapacity)

Sets the value of QueueProcessingServiceBaseProps.getMinScalingCapacity()

Parameters:

minScalingCapacity - Minimum capacity to scale to.

Returns:

this

propagateTags

@Stability(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.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(Stable)
public QueueProcessingServiceBaseProps.Builder serviceName(String serviceName)

Sets the value of QueueProcessingServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

visibilityTimeout

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

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<QueueProcessingServiceBaseProps>

Returns:

a new instance of QueueProcessingServiceBaseProps

Throws:

NullPointerException - if any required attribute was not provided