QueueProcessingServiceBaseProps

class aws_cdk.aws_ecs_patterns.QueueProcessingServiceBaseProps(*, image, capacity_provider_strategies=None, circuit_breaker=None, cluster=None, command=None, deployment_controller=None, enable_ecs_managed_tags=None, enable_execute_command=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)

Bases: object

The properties for the base QueueProcessingEc2Service or QueueProcessingFargateService service.

Parameters
  • image (ContainerImage) – The image used to start a container.

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

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

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

  • 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: - 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. 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.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_ecs as ecs
from aws_cdk import aws_ecs_patterns as ecs_patterns
from aws_cdk import aws_sqs as sqs

# cluster: ecs.Cluster
# container_image: ecs.ContainerImage
# log_driver: ecs.LogDriver
# queue: sqs.Queue
# secret: ecs.Secret
# vpc: ec2.Vpc

queue_processing_service_base_props = ecs_patterns.QueueProcessingServiceBaseProps(
    image=container_image,

    # the properties below are optional
    capacity_provider_strategies=[ecs.CapacityProviderStrategy(
        capacity_provider="capacityProvider",

        # the properties below are optional
        base=123,
        weight=123
    )],
    circuit_breaker=ecs.DeploymentCircuitBreaker(
        rollback=False
    ),
    cluster=cluster,
    command=["command"],
    deployment_controller=ecs.DeploymentController(
        type=ecs.DeploymentControllerType.ECS
    ),
    enable_eCSManaged_tags=False,
    enable_execute_command=False,
    enable_logging=False,
    environment={
        "environment_key": "environment"
    },
    family="family",
    log_driver=log_driver,
    max_healthy_percent=123,
    max_receive_count=123,
    max_scaling_capacity=123,
    min_healthy_percent=123,
    min_scaling_capacity=123,
    propagate_tags=ecs.PropagatedTagSource.SERVICE,
    queue=queue,
    retention_period=cdk.Duration.minutes(30),
    scaling_steps=[cdk.aws_applicationautoscaling.ScalingInterval(
        change=123,

        # the properties below are optional
        lower=123,
        upper=123
    )],
    secrets={
        "secrets_key": secret
    },
    service_name="serviceName",
    visibility_timeout=cdk.Duration.minutes(30),
    vpc=vpc
)

Attributes

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.

deployment_controller

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default
  • Rolling update (ECS)

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’

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.

image

The image used to start a container.

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
  • 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

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
  • If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 1.

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)

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.

service_name

The name of the service.

Default
  • CloudFormation-generated name.

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.