QueueProcessingServiceBaseProps¶
-
class
aws_cdk.aws_ecs_patterns.
QueueProcessingServiceBaseProps
(*, image, 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, propagate_tags=None, queue=None, retention_period=None, scaling_steps=None, secrets=None, service_name=None, vpc=None)¶ Bases:
object
The properties for the base QueueProcessingEc2Service or QueueProcessingFargateService service.
- Parameters
image (
ContainerImage
) – The image used to start a container.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
[List
[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
]) – The desired number of instantiations of the task definition to keep running on the service. Default: 1enable_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: falseenable_logging (
Optional
[bool
]) – Flag to indicate whether to enable logging. Default: trueenvironment (
Optional
[Mapping
[str
,str
]]) – The environment variables to pass to the container. The variableQUEUE_NAME
with valuequeue.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 truemax_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: 3max_scaling_capacity (
Union
[int
,float
,None
]) – Maximum capacity to scale to. Default: (desiredTaskCount * 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.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: - nonequeue (
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
[List
[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.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.
Attributes
-
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
]]
-
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
¶ The desired number of instantiations of the task definition to keep running on the service.
- Default
1
- Return type
Union
[int
,float
,None
]
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 valuequeue.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
]
-
image
¶ The image used to start a container.
- Return type
-
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
(desiredTaskCount * 2)
- 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
]
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
]]
-
service_name
¶ The name of the service.
- Default
CloudFormation-generated name.
- Return type
Optional
[str
]
-
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
]