QueueProcessingEc2Service

class aws_cdk.aws_ecs_patterns.QueueProcessingEc2Service(scope, id, *, container_name=None, cpu=None, gpu_count=None, memory_limit_mib=None, memory_reservation_mib=None, placement_constraints=None, placement_strategies=None, 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)

Bases: aws_cdk.aws_ecs_patterns.QueueProcessingServiceBase

Class to create a queue processing EC2 service.

ExampleMetadata

infused

Example:

# cluster: ecs.Cluster

queue_processing_ec2_service = ecs_patterns.QueueProcessingEc2Service(self, "Service",
    cluster=cluster,
    memory_limit_mi_b=1024,
    image=ecs.ContainerImage.from_registry("test"),
    command=["-c", "4", "amazon.com"],
    enable_logging=False,
    desired_task_count=2,
    environment={
        "TEST_ENVIRONMENT_VARIABLE1": "test environment variable 1 value",
        "TEST_ENVIRONMENT_VARIABLE2": "test environment variable 2 value"
    },
    max_scaling_capacity=5,
    container_name="test"
)

Constructs a new instance of the QueueProcessingEc2Service class.

Parameters

  • scope (Construct) –

  • id (str) –

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

  • gpu_count (Union[int, float, None]) – Gpu count for container in task definition. Set this if you want to use gpu based instances. Default: - No GPUs assigned.

  • memory_limit_mib (Union[int, float, None]) – The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated. At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. Default: - No memory limit.

  • memory_reservation_mib (Union[int, float, None]) – The soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first. At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. Default: - No memory reserved.

  • placement_constraints (Optional[Sequence[PlacementConstraint]]) – The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints. Default: - No constraints.

  • placement_strategies (Optional[Sequence[PlacementStrategy]]) – The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies. Default: - No strategies.

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

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

cluster

The cluster where your service will be deployed.

Return type

ICluster

dead_letter_queue

The dead letter queue for the primary SQS queue.

Return type

Optional[IQueue]

desired_count

(deprecated) The minimum number of tasks to run.

Deprecated

  • Use minCapacity instead.

Stability

deprecated

Return type

Union[int, float]

environment

Environment variables that will include the queue name.

Return type

Mapping[str, str]

log_driver

The AwsLogDriver to use for logging if logging is enabled.

Return type

Optional[LogDriver]

max_capacity

The maximum number of instances for autoscaling to scale up to.

Return type

Union[int, float]

min_capacity

The minimum number of instances for autoscaling to scale down to.

Return type

Union[int, float]

node

The construct tree node associated with this construct.

Return type

ConstructNode

scaling_steps

The scaling interval for autoscaling based off an SQS Queue size.

Return type

List[ScalingInterval]

secrets

The secret environment variables.

Return type

Optional[Mapping[str, Secret]]

service

The EC2 service in this construct.

Return type

Ec2Service

sqs_queue

The SQS queue that the service will process from.

Return type

IQueue

task_definition

The EC2 task definition in this construct.

Return type

Ec2TaskDefinition

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool