software.amazon.awscdk.services.ecs.patterns

Class QueueProcessingFargateServiceProps.Builder

java.lang.Object

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

Enclosing interface:

QueueProcessingFargateServiceProps

@Stability(value=Stable)
public static final class QueueProcessingFargateServiceProps.Builder
extends Object

A builder for QueueProcessingFargateServiceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
QueueProcessingFargateServiceProps	build() Builds the configured instance.
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	cpu(Number cpu) Sets the value of QueueProcessingFargateServiceProps.getCpu()
QueueProcessingFargateServiceProps.Builder	desiredTaskCount(Number desiredTaskCount) Sets the value of QueueProcessingServiceBaseProps.getDesiredTaskCount()
QueueProcessingFargateServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags) Sets the value of QueueProcessingServiceBaseProps.getEnableEcsManagedTags()
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	image(ContainerImage image) Sets the value of QueueProcessingServiceBaseProps.getImage()
QueueProcessingFargateServiceProps.Builder	logDriver(LogDriver logDriver) Sets the value of QueueProcessingServiceBaseProps.getLogDriver()
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 QueueProcessingFargateServiceProps.getMemoryLimitMiB()
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	scalingSteps(List<ScalingInterval> scalingSteps) Sets the value of QueueProcessingServiceBaseProps.getScalingSteps()
QueueProcessingFargateServiceProps.Builder	secrets(Map<String,Secret> secrets) Sets the value of QueueProcessingServiceBaseProps.getSecrets()
QueueProcessingFargateServiceProps.Builder	serviceName(String serviceName) Sets the value of QueueProcessingServiceBaseProps.getServiceName()
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

cpu

@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder cpu(Number cpu)

Sets the value of QueueProcessingFargateServiceProps.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 QueueProcessingFargateServiceProps.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:

0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)

1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)

2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)

Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)

Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

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

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

desiredTaskCount

@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder desiredTaskCount(Number desiredTaskCount)

Sets the value of QueueProcessingServiceBaseProps.getDesiredTaskCount()

Parameters:

desiredTaskCount - The desired number of instantiations of the task definition to keep running on the service.

Returns:

this

enableEcsManagedTags

@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of 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

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

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.

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

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.

Returns:

this

scalingSteps

@Stability(value=Stable)
public QueueProcessingFargateServiceProps.Builder scalingSteps(List<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,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

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

build

@Stability(value=Stable)
public QueueProcessingFargateServiceProps build()

Builds the configured instance.

Returns:

a new instance of QueueProcessingFargateServiceProps

Throws:

NullPointerException - if any required attribute was not provided