class QueueProcessingFargateService (construct)
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ECS.Patterns.QueueProcessingFargateService |
 Java | software.amazon.awscdk.services.ecs.patterns.QueueProcessingFargateService |
 Python | aws_cdk.aws_ecs_patterns.QueueProcessingFargateService |
 TypeScript (source) | @aws-cdk/aws-ecs-patterns » QueueProcessingFargateService |
Implements
IConstruct, IConstruct, IDependable
Class to create a queue processing Fargate service.
Example
declare const cluster: ecs.Cluster;
cluster.enableFargateCapacityProviders();
const queueProcessingFargateService = new ecsPatterns.QueueProcessingFargateService(this, 'Service', {
cluster,
memoryLimitMiB: 512,
image: ecs.ContainerImage.fromRegistry('test'),
capacityProviderStrategies: [
{
capacityProvider: 'FARGATE_SPOT',
weight: 2,
},
{
capacityProvider: 'FARGATE',
weight: 1,
},
],
});
Initializer
new QueueProcessingFargateService(scope: Construct, id: string, props: QueueProcessingFargateServiceProps)
Parameters
- scope
Construct - id
string - props
QueueProcessing Fargate Service Props
Constructs a new instance of the QueueProcessingFargateService class.
Construct Props
| Name | Type | Description |
|---|---|---|
| image | Container | The image used to start a container. |
| assign | boolean | Specifies whether the task's elastic network interface receives a public IP address. |
| capacity | Capacity[] | A list of Capacity Provider strategies used to place a service. |
| circuit | Deployment | Whether to enable the deployment circuit breaker. |
| cluster? | ICluster | The name of the cluster that hosts the service. |
| command? | string[] | The command that is passed to the container. |
| container | string | Optional name for the container added. |
| cpu? | number | The number of cpu units used by the task. |
| deployment | Deployment | Specifies which deployment controller to use for the service. |
| desired | number | The desired number of instantiations of the task definition to keep running on the service. |
| enable | boolean | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
| enable | boolean | Flag to indicate whether to enable logging. |
| environment? | { [string]: string } | The environment variables to pass to the container. |
| family? | string | The name of a family that the task definition is registered to. |
| health | Health | The health check command and associated configuration parameters for the container. |
| log | Log | The log driver to use. |
| max | number | 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. |
| max | number | The maximum number of times that a message can be received by consumers. |
| max | number | Maximum capacity to scale to. |
| memory | number | The amount (in MiB) of memory used by the task. |
| min | number | 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. |
| min | number | Minimum capacity to scale to. |
| platform | Fargate | The platform version on which to run your service. |
| propagate | Propagated | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
| queue? | IQueue | A queue for which to process items from. |
| retention | Duration | The number of seconds that Dead Letter Queue retains a message. |
| scaling | Scaling[] | The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric. |
| secrets? | { [string]: Secret } | The secret to expose to the container as an environment variable. |
| security | ISecurity[] | The security groups to associate with the service. |
| service | string | The name of the service. |
| task | Subnet | The subnets to associate with the service. |
| visibility | Duration | Timeout of processing a single message. |
| vpc? | IVpc | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
image
Type:
Container
The image used to start a container.
assignPublicIp?
Type:
boolean
(optional, default: false)
Specifies whether the task's elastic network interface receives a public IP address.
If true, each task will receive a public IP address.
capacityProviderStrategies?
Type:
Capacity[]
(optional, default: undefined)
A list of Capacity Provider strategies used to place a service.
circuitBreaker?
Type:
Deployment
(optional, default: disabled)
Whether to enable the deployment circuit breaker.
If this property is defined, circuit breaker will be implicitly enabled.
cluster?
Type:
ICluster
(optional, default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.)
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.
command?
Type:
string[]
(optional, default: CMD value built into container image.)
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.
containerName?
Type:
string
(optional, default: QueueProcessingContainer)
Optional name for the container added.
cpu?
Type:
number
(optional, default: 256)
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.
deploymentController?
Type:
Deployment
(optional, default: Rolling update (ECS))
Specifies which deployment controller to use for the service.
For more information, see Amazon ECS Deployment Types
desiredTaskCount?
⚠️ Deprecated: - Use minScalingCapacity or a literal object instead.
Type:
number
(optional, default: If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1;
if true, the minScalingCapacity is 1 for all new services and uses the existing services desired count
when updating an existing service.)
The desired number of instantiations of the task definition to keep running on the service.
enableECSManagedTags?
Type:
boolean
(optional, default: false)
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
For more information, see Tagging Your Amazon ECS Resources
enableLogging?
Type:
boolean
(optional, default: true)
Flag to indicate whether to enable logging.
environment?
Type:
{ [string]: string }
(optional, default: 'QUEUE_NAME: queue.queueName')
The environment variables to pass to the container.
The variable QUEUE_NAME with value queue.queueName will
always be passed.
family?
Type:
string
(optional, default: Automatically generated name.)
The name of a family that the task definition is registered to.
A family groups multiple versions of a task definition.
healthCheck?
Type:
Health
(optional, default: Health check configuration from container.)
The health check command and associated configuration parameters for the container.
logDriver?
Type:
Log
(optional, default: AwsLogDriver if enableLogging is true)
The log driver to use.
maxHealthyPercent?
Type:
number
(optional, default: default from underlying service.)
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.
maxReceiveCount?
Type:
number
(optional, default: 3)
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.
maxScalingCapacity?
Type:
number
(optional, default: If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is (desiredTaskCount * 2); if true, the default is 2.)
Maximum capacity to scale to.
memoryLimitMiB?
Type:
number
(optional, default: 512)
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.
minHealthyPercent?
Type:
number
(optional, default: default from underlying service.)
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.
minScalingCapacity?
Type:
number
(optional, default: If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 1.)
Minimum capacity to scale to.
platformVersion?
Type:
Fargate
(optional, default: Latest)
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.
propagateTags?
Type:
Propagated
(optional, default: none)
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.
queue?
Type:
IQueue
(optional, default: 'SQSQueue with CloudFormation-generated name')
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
retentionPeriod?
Type:
Duration
(optional, default: Duration.days(14))
The number of seconds that Dead Letter Queue retains a message.
scalingSteps?
Type:
Scaling[]
(optional, default: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }])
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
secrets?
Type:
{ [string]: Secret }
(optional, default: No secret environment variables.)
The secret to expose to the container as an environment variable.
securityGroups?
Type:
ISecurity[]
(optional, default: A new security group is created.)
The security groups to associate with the service.
If you do not specify a security group, a new security group is created.
serviceName?
Type:
string
(optional, default: CloudFormation-generated name.)
The name of the service.
taskSubnets?
Type:
Subnet
(optional, default: Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.)
The subnets to associate with the service.
visibilityTimeout?
Type:
Duration
(optional, default: Duration.seconds(30))
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).
vpc?
Type:
IVpc
(optional, default: uses the VPC defined in the cluster or creates a new 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.
Properties
| Name | Type | Description |
|---|---|---|
| cluster | ICluster | The cluster where your service will be deployed. |
| desired | number | The minimum number of tasks to run. |
| environment | { [string]: string } | Environment variables that will include the queue name. |
| max | number | The maximum number of instances for autoscaling to scale up to. |
| min | number | The minimum number of instances for autoscaling to scale down to. |
| node | Construct | The construct tree node associated with this construct. |
| scaling | Scaling[] | The scaling interval for autoscaling based off an SQS Queue size. |
| service | Fargate | The Fargate service in this construct. |
| sqs | IQueue | The SQS queue that the service will process from. |
| task | Fargate | The Fargate task definition in this construct. |
| dead | IQueue | The dead letter queue for the primary SQS queue. |
| log | Log | The AwsLogDriver to use for logging if logging is enabled. |
| secrets? | { [string]: Secret } | The secret environment variables. |
cluster
Type:
ICluster
The cluster where your service will be deployed.
desiredCount
⚠️ Deprecated: - Use minCapacity instead.
Type:
number
The minimum number of tasks to run.
environment
Type:
{ [string]: string }
Environment variables that will include the queue name.
maxCapacity
Type:
number
The maximum number of instances for autoscaling to scale up to.
minCapacity
Type:
number
The minimum number of instances for autoscaling to scale down to.
node
Type:
Construct
The construct tree node associated with this construct.
scalingSteps
Type:
Scaling[]
The scaling interval for autoscaling based off an SQS Queue size.
service
Type:
Fargate
The Fargate service in this construct.
sqsQueue
Type:
IQueue
The SQS queue that the service will process from.
taskDefinition
Type:
Fargate
The Fargate task definition in this construct.
deadLetterQueue?
Type:
IQueue
(optional)
The dead letter queue for the primary SQS queue.
logDriver?
Type:
Log
(optional)
The AwsLogDriver to use for logging if logging is enabled.
secrets?
Type:
{ [string]: Secret }
(optional)
The secret environment variables.
Methods
| Name | Description |
|---|---|
| to | Returns a string representation of this construct. |
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.