QueueProcessingFargateServiceProps¶

class aws_cdk.aws_ecs_patterns.QueueProcessingFargateServiceProps(*, image, capacity_provider_strategies=None, circuit_breaker=None, cluster=None, command=None, deployment_controller=None, desired_task_count=None, enable_ecs_managed_tags=None, enable_logging=None, environment=None, family=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, assign_public_ip=None, container_name=None, cpu=None, health_check=None, memory_limit_mib=None, platform_version=None, security_groups=None, task_subnets=None)¶

Bases: aws_cdk.aws_ecs_patterns.QueueProcessingServiceBaseProps

The properties for the QueueProcessingFargateService service.

Parameters

image (ContainerImage) – The image used to start a container.
capacity_provider_strategies (Optional[Sequence[CapacityProviderStrategy]]) – A list of Capacity Provider strategies used to place a service. Default: - undefined
circuit_breaker (Optional[DeploymentCircuitBreaker]) – 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.
deployment_controller (Optional[DeploymentController]) – Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types Default: - Rolling update (ECS)
desired_task_count (Union[int, float, None]) – (deprecated) The desired number of instantiations of the task definition to keep running on the service. 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.
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_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.
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. Default: 3
max_scaling_capacity (Union[int, float, None]) – Maximum capacity to scale to. Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is (desiredTaskCount * 2); if true, the default is 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: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 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. Default: Duration.days(14)
scaling_steps (Optional[Sequence[ScalingInterval]]) – 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). 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.
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. Default: - QueueProcessingContainer
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 This default is set in the underlying FargateTaskDefinition construct. Default: 256
health_check (Optional[HealthCheck]) – The health check command and associated configuration parameters for the container. Default: - Health check configuration from container.
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: 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. 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
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 (Optional[SubnetSelection]) – 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
Return type: Optional[bool]

capacity_provider_strategies¶

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

Default

undefined

Return type

Optional[List[CapacityProviderStrategy]]

circuit_breaker¶

Whether to enable the deployment circuit breaker.

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

Default

disabled

Return type

Optional[DeploymentCircuitBreaker]

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.

Return type

Optional[ICluster]

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.

Return type

Optional[List[str]]

container_name¶

Optional name for the container added.

Default

QueueProcessingContainer

Return type

Optional[str]

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.

Default: 256
Return type: Union[int, float, None]

deployment_controller¶

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default

Rolling update (ECS)

Return type

Optional[DeploymentController]

desired_task_count¶

(deprecated) The desired number of instantiations of the task definition to keep running on the service.

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.

Deprecated

Use minScalingCapacity or a literal object instead.

Stability

deprecated

Return type

Union[int, float, None]

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
Return type: Optional[bool]

enable_logging¶

Flag to indicate whether to enable logging.

Default: true
Return type: Optional[bool]

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’
Return type: Optional[Mapping[str, str]]

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.

Return type

Optional[str]

health_check¶

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

Default

Health check configuration from container.

Return type

Optional[HealthCheck]

image¶

The image used to start a container.

Return type: ContainerImage

log_driver¶

The log driver to use.

Default

AwsLogDriver if enableLogging is true

Return type

Optional[LogDriver]

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.

Return type

Union[int, float, None]

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.

Default: 3
Return type: Union[int, float, None]

max_scaling_capacity¶

Maximum capacity to scale to.

Default

If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is (desiredTaskCount * 2); if true, the default is 2.

Return type

Union[int, float, None]

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:

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.

Default: 512
Return type: Union[int, float, None]

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.

Return type

Union[int, float, None]

min_scaling_capacity¶

Minimum capacity to scale to.

Default

If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 1.

Return type

Union[int, float, None]

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
Return type: Optional[FargatePlatformVersion]

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

Return type

Optional[PropagatedTagSource]

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’
Return type: Optional[IQueue]

retention_period¶

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

Default: Duration.days(14)
Return type: Optional[Duration]

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 }]
Return type: Optional[List[ScalingInterval]]

secrets¶

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

Default

No secret environment variables.

Return type

Optional[Mapping[str, Secret]]

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.

Return type

Optional[List[ISecurityGroup]]

service_name¶

The name of the service.

Default

CloudFormation-generated name.

Return type

Optional[str]

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.

Return type

Optional[SubnetSelection]

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).

Default: Duration.seconds(30)
Return type: Optional[Duration]

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.

Return type

Optional[IVpc]