QueueProcessingFargateServiceProps

class aws_cdk.aws_ecs_patterns.QueueProcessingFargateServiceProps(*, capacity_provider_strategies=None, circuit_breaker=None, cluster=None, command=None, cooldown=None, cpu_target_utilization_percent=None, deployment_controller=None, disable_cpu_based_scaling=None, enable_ecs_managed_tags=None, enable_execute_command=None, enable_logging=None, environment=None, family=None, image=None, log_driver=None, max_healthy_percent=None, max_receive_count=None, max_scaling_capacity=None, min_healthy_percent=None, min_scaling_capacity=None, propagate_tags=None, queue=None, retention_period=None, scaling_steps=None, secrets=None, service_name=None, visibility_timeout=None, vpc=None, cpu=None, ephemeral_storage_gib=None, memory_limit_mib=None, platform_version=None, runtime_platform=None, task_definition=None, assign_public_ip=None, container_name=None, health_check=None, security_groups=None, task_subnets=None)

Bases: QueueProcessingServiceBaseProps, FargateServiceBaseProps

The properties for the QueueProcessingFargateService service.

Parameters:

capacity_provider_strategies (Optional[Sequence[Union[CapacityProviderStrategy, Dict[str, Any]]]]) – A list of Capacity Provider strategies used to place a service. Default: - undefined
circuit_breaker (Union[DeploymentCircuitBreaker, Dict[str, Any], None]) – Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled. Default: - disabled
cluster (Optional[ICluster]) – 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. Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
command (Optional[Sequence[str]]) – 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. Default: - CMD value built into container image.
cooldown (Optional[Duration]) – 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. Default: 300 seconds
cpu_target_utilization_percent (Union[int, float, None]) – The target CPU utilization percentage for CPU based scaling strategy when enabled. Default: - 50
deployment_controller (Union[DeploymentController, Dict[str, Any], None]) – Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types Default: - Rolling update (ECS)
disable_cpu_based_scaling (Optional[bool]) – Flag to disable CPU based auto scaling strategy on the service. Default: - false
enable_ecs_managed_tags (Optional[bool]) – Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources Default: false
enable_execute_command (Optional[bool]) – Whether ECS Exec should be enabled. Default: - false
enable_logging (Optional[bool]) – Flag to indicate whether to enable logging. Default: true
environment (Optional[Mapping[str, str]]) – The environment variables to pass to the container. The variable QUEUE_NAME with value queue.queueName will always be passed. Default: ‘QUEUE_NAME: queue.queueName’
family (Optional[str]) – The name of a family that the task definition is registered to. A family groups multiple versions of a task definition. Default: - Automatically generated name.
image (Optional[ContainerImage]) – The image used to start a container. For QueueProcessingFargateService, either image or taskDefinition must be specified, but not both. For QueueProcessingEc2Service, image is required. Default: - the image of the task definition is used for Fargate, required otherwise
log_driver (Optional[LogDriver]) – The log driver to use. Default: - AwsLogDriver if enableLogging is true
max_healthy_percent (Union[int, float, None]) – 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. Default: - default from underlying service.
max_receive_count (Union[int, float, None]) – 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. Default: 3
max_scaling_capacity (Union[int, float, None]) – Maximum capacity to scale to. Default: 2
min_healthy_percent (Union[int, float, None]) – 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. Default: - default from underlying service.
min_scaling_capacity (Union[int, float, None]) – Minimum capacity to scale to. Default: 1
propagate_tags (Optional[PropagatedTagSource]) – 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. Default: - none
queue (Optional[IQueue]) – 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 Default: ‘SQSQueue with CloudFormation-generated name’
retention_period (Optional[Duration]) – The number of seconds that Dead Letter Queue retains a message. If the queue construct is specified, retentionPeriod should be omitted. Default: Duration.days(14)
scaling_steps (Optional[Sequence[Union[ScalingInterval, Dict[str, Any]]]]) – 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 Default: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }]
secrets (Optional[Mapping[str, Secret]]) – The secret to expose to the container as an environment variable. Default: - No secret environment variables.
service_name (Optional[str]) – The name of the service. Default: - CloudFormation-generated name.
visibility_timeout (Optional[Duration]) – 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. Default: Duration.seconds(30)
vpc (Optional[IVpc]) – 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. Default: - uses the VPC defined in the cluster or creates a new VPC.
cpu (Union[int, float, None]) – 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 8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments 16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments This default is set in the underlying FargateTaskDefinition construct. Default: 256
ephemeral_storage_gib (Union[int, float, None]) – The amount (in GiB) of ephemeral storage to be allocated to the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB. Only supported in Fargate platform version 1.4.0 or later. Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.
memory_limit_mib (Union[int, float, None]) – 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) Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU) Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU) This default is set in the underlying FargateTaskDefinition construct. Default: 512
platform_version (Optional[FargatePlatformVersion]) – 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. Default: Latest
runtime_platform (Union[RuntimePlatform, Dict[str, Any], None]) – The runtime platform of the task definition. Default: - If the property is undefined, operatingSystemFamily is LINUX and cpuArchitecture is X86_64
task_definition (Optional[FargateTaskDefinition]) – The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. [disable-awslint:ref-via-interface] Default: - none
assign_public_ip (Optional[bool]) – Specifies whether the task’s elastic network interface receives a public IP address. If true, each task will receive a public IP address. Default: false
container_name (Optional[str]) – Optional name for the container added. This name is not used when taskDefinition is provided. Default: - QueueProcessingContainer
health_check (Union[HealthCheck, Dict[str, Any], None]) – The health check command and associated configuration parameters for the container. Default: - Health check configuration from container.
security_groups (Optional[Sequence[ISecurityGroup]]) – The security groups to associate with the service. If you do not specify a security group, a new security group is created. Default: - A new security group is created.
task_subnets (Union[SubnetSelection, Dict[str, Any], None]) – The subnets to associate with the service. Default: - Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.

ExampleMetadata:

infused

Example:

# cluster: ecs.Cluster

cluster.enable_fargate_capacity_providers()

queue_processing_fargate_service = ecs_patterns.QueueProcessingFargateService(self, "Service",
    cluster=cluster,
    memory_limit_mi_b=512,
    image=ecs.ContainerImage.from_registry("test"),
    capacity_provider_strategies=[ecs.CapacityProviderStrategy(
        capacity_provider="FARGATE_SPOT",
        weight=2
    ), ecs.CapacityProviderStrategy(
        capacity_provider="FARGATE",
        weight=1
    )
    ]
)

Attributes

assign_public_ip

Specifies whether the task’s elastic network interface receives a public IP address.

If true, each task will receive a public IP address.

Default:: false

capacity_provider_strategies

A list of Capacity Provider strategies used to place a service.

Default:

undefined

circuit_breaker

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

Default:

disabled

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.

Default:

create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

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.

Default:

CMD value built into container image.

container_name

Optional name for the container added.

This name is not used when taskDefinition is provided.

Default:

QueueProcessingContainer

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.

Default:: 300 seconds
See:: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html

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

8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments

16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments

This default is set in the underlying FargateTaskDefinition construct.

Default:: 256

cpu_target_utilization_percent

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

Default:

50

deployment_controller

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default:

Rolling update (ECS)

disable_cpu_based_scaling

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

Default:

false

enable_ecs_managed_tags

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

Default:: false

enable_execute_command

Whether ECS Exec should be enabled.

Default:

false

enable_logging

Flag to indicate whether to enable logging.

Default:: true

environment

The environment variables to pass to the container.

The variable QUEUE_NAME with value queue.queueName will always be passed.

Default:: ‘QUEUE_NAME: queue.queueName’

ephemeral_storage_gib

The amount (in GiB) of ephemeral storage to be allocated to the task.

The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

Only supported in Fargate platform version 1.4.0 or later.

Default:: Undefined, in which case, the task will receive 20GiB ephemeral storage.

family

The name of a family that the task definition is registered to.

A family groups multiple versions of a task definition.

Default:

Automatically generated name.

health_check

The health check command and associated configuration parameters for the container.

Default:

Health check configuration from container.

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.

Default:

the image of the task definition is used for Fargate, required otherwise

log_driver

The log driver to use.

Default:

AwsLogDriver if enableLogging is true

max_healthy_percent

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.

Default:

default from underlying service.

max_receive_count

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.

Default:: 3

max_scaling_capacity

Maximum capacity to scale to.

Default:: 2

memory_limit_mib

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)

Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Default:: 512

min_healthy_percent

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.

Default:

default from underlying service.

min_scaling_capacity

Minimum capacity to scale to.

Default:: 1

platform_version

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.

Default:: Latest

propagate_tags

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.

Default:

none

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

Default:: ‘SQSQueue with CloudFormation-generated name’

retention_period

The number of seconds that Dead Letter Queue retains a message.

If the queue construct is specified, retentionPeriod should be omitted.

Default:: Duration.days(14)

runtime_platform

The runtime platform of the task definition.

Default:

If the property is undefined, operatingSystemFamily is LINUX and cpuArchitecture is X86_64

scaling_steps

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

Default:: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }]

secrets

The secret to expose to the container as an environment variable.

Default:

No secret environment variables.

security_groups

The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

Default:

A new security group is created.

service_name

The name of the service.

Default:

CloudFormation-generated name.

task_definition

The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.

[disable-awslint:ref-via-interface]

Default:

none

task_subnets

The subnets to associate with the service.

Default:

Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.

visibility_timeout

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.

Default:: Duration.seconds(30)

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.

Default:

uses the VPC defined in the cluster or creates a new VPC.