QueueProcessingServiceBaseProps Struct
The properties for the base QueueProcessingEc2Service or QueueProcessingFargateService service.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_ecs_patterns as ecs_patterns } from 'aws-cdk-lib';
import { aws_sqs as sqs } from 'aws-cdk-lib';
declare const cluster: ecs.Cluster;
declare const containerImage: ecs.ContainerImage;
declare const logDriver: ecs.LogDriver;
declare const queue: sqs.Queue;
declare const secret: ecs.Secret;
declare const vpc: ec2.Vpc;
const queueProcessingServiceBaseProps: ecs_patterns.QueueProcessingServiceBaseProps = {
capacityProviderStrategies: [{
capacityProvider: 'capacityProvider',
// the properties below are optional
base: 123,
weight: 123,
}],
circuitBreaker: {
enable: false,
rollback: false,
},
cluster: cluster,
command: ['command'],
cooldown: cdk.Duration.minutes(30),
cpuTargetUtilizationPercent: 123,
deploymentController: {
type: ecs.DeploymentControllerType.ECS,
},
disableCpuBasedScaling: false,
enableECSManagedTags: false,
enableExecuteCommand: false,
enableLogging: false,
environment: {
environmentKey: 'environment',
},
family: 'family',
image: containerImage,
logDriver: logDriver,
maxHealthyPercent: 123,
maxReceiveCount: 123,
maxScalingCapacity: 123,
minHealthyPercent: 123,
minScalingCapacity: 123,
propagateTags: ecs.PropagatedTagSource.SERVICE,
queue: queue,
retentionPeriod: cdk.Duration.minutes(30),
scalingSteps: [{
change: 123,
// the properties below are optional
lower: 123,
upper: 123,
}],
secrets: {
secretsKey: secret,
},
serviceName: 'serviceName',
visibilityTimeout: cdk.Duration.minutes(30),
vpc: vpc,
};
Properties
capacityProviderStrategiesoptionalCapacityProviderStrategy[]capacity_provider_strategiesoptionaltyping.List[CapacityProviderStrategy]capacityProviderStrategiesoptionalList<CapacityProviderStrategy>CapacityProviderStrategiesoptionalCapacityProviderStrategy[]CapacityProviderStrategiesoptional*[]CapacityProviderStrategy= undefined#circuitBreakeroptionalDeploymentCircuitBreakercircuit_breakeroptionalDeploymentCircuitBreakercircuitBreakeroptionalDeploymentCircuitBreakerCircuitBreakeroptionalDeploymentCircuitBreakerCircuitBreakeroptionalDeploymentCircuitBreaker= disabled#If this property is defined, circuit breaker will be implicitly enabled.
clusteroptionalIClusterclusteroptionalIClusterclusteroptionalIClusterClusteroptionalIClusterClusteroptionalICluster#Default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
commandoptionalstring[]commandoptionaltyping.List[str]commandoptionalList<String>Commandoptionalstring[]Commandoptional*[]*string#Default: CMD value built into container image.
If you provide a shell command as a single string, you have to quote command-line arguments.
cooldownoptionalDurationcooldownoptionalDurationcooldownoptionalDurationCooldownoptionalDurationCooldownoptionalDuration#Default: 300 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.
cpuTargetUtilizationPercentoptionalnumbercpu_target_utilization_percentoptionalint | floatcpuTargetUtilizationPercentoptionalNumberCpuTargetUtilizationPercentoptionaldoubleCpuTargetUtilizationPercentoptional*float64= 50#deploymentControlleroptionalDeploymentControllerdeployment_controlleroptionalDeploymentControllerdeploymentControlleroptionalDeploymentControllerDeploymentControlleroptionalDeploymentControllerDeploymentControlleroptionalDeploymentController#Default: Rolling update (ECS)
For more information, see Amazon ECS Deployment Types
disableCpuBasedScalingoptionalbooleandisable_cpu_based_scalingoptionalbooldisableCpuBasedScalingoptionalBooleanDisableCpuBasedScalingoptionalboolDisableCpuBasedScalingoptional*bool= false#enableECSManagedTagsoptionalbooleanenable_ecs_managed_tagsoptionalboolenableECSManagedTagsoptionalBooleanEnableECSManagedTagsoptionalboolEnableECSManagedTagsoptional*bool= false#For more information, see Tagging Your Amazon ECS Resources
enableExecuteCommandoptionalbooleanenable_execute_commandoptionalboolenableExecuteCommandoptionalBooleanEnableExecuteCommandoptionalboolEnableExecuteCommandoptional*bool= false#enableLoggingoptionalbooleanenable_loggingoptionalboolenableLoggingoptionalBooleanEnableLoggingoptionalboolEnableLoggingoptional*bool= true#environmentoptional{ [key: string]: string }environmentoptionaltyping.Mapping[str, str]environmentoptionalMap<String, String>EnvironmentoptionalIDictionary<string, string>Environmentoptional*map[string]*string#Default: 'QUEUE_NAME: queue.queueName'
The variable QUEUE_NAME with value queue.queueName will always be passed.
Default: Automatically generated name.
A family groups multiple versions of a task definition.
imageoptionalContainerImageimageoptionalContainerImageimageoptionalContainerImageImageoptionalContainerImageImageoptionalContainerImage#Default: the image of the task definition is used for Fargate, required otherwise
For QueueProcessingFargateService, either image or taskDefinition must be specified, but not both. For QueueProcessingEc2Service, image is required.
logDriveroptionalLogDriverlog_driveroptionalLogDriverlogDriveroptionalLogDriverLogDriveroptionalLogDriverLogDriveroptionalLogDriver#Default: AwsLogDriver if enableLogging is true
maxHealthyPercentoptionalnumbermax_healthy_percentoptionalint | floatmaxHealthyPercentoptionalNumberMaxHealthyPercentoptionaldoubleMaxHealthyPercentoptional*float64#Default: default from underlying service.
maxReceiveCountoptionalnumbermax_receive_countoptionalint | floatmaxReceiveCountoptionalNumberMaxReceiveCountoptionaldoubleMaxReceiveCountoptional*float64= 3#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.
maxScalingCapacityoptionalnumbermax_scaling_capacityoptionalint | floatmaxScalingCapacityoptionalNumberMaxScalingCapacityoptionaldoubleMaxScalingCapacityoptional*float64= 2#minHealthyPercentoptionalnumbermin_healthy_percentoptionalint | floatminHealthyPercentoptionalNumberMinHealthyPercentoptionaldoubleMinHealthyPercentoptional*float64#Default: default from underlying service.
minScalingCapacityoptionalnumbermin_scaling_capacityoptionalint | floatminScalingCapacityoptionalNumberMinScalingCapacityoptionaldoubleMinScalingCapacityoptional*float64= 1#propagateTagsoptionalPropagatedTagSourcepropagate_tagsoptionalPropagatedTagSourcepropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSource= none#Tags can only be propagated to the tasks within the service during service creation.
Default: 'SQSQueue with CloudFormation-generated name'
If specified and this is a FIFO queue, the queue name must end in the string '.fifo'. See CreateQueue
retentionPeriodoptionalDurationretention_periodoptionalDurationretentionPeriodoptionalDurationRetentionPeriodoptionalDurationRetentionPeriodoptionalDuration= Duration.days(14)#If the queue construct is specified, retentionPeriod should be omitted.
scalingStepsoptionalScalingInterval[]scaling_stepsoptionaltyping.List[ScalingInterval]scalingStepsoptionalList<ScalingInterval>ScalingStepsoptionalScalingInterval[]ScalingStepsoptional*[]ScalingInterval#Default: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }]
Maps a range of metric values to a particular scaling behavior. See Simple and Step Scaling Policies for Amazon EC2 Auto Scaling
secretsoptional{ [key: string]: Secret }secretsoptionaltyping.Mapping[str, Secret]secretsoptionalMap<String, Secret>SecretsoptionalIDictionary<string, Secret>Secretsoptional*map[string]Secret#Default: No secret environment variables.
serviceNameoptionalstringservice_nameoptionalstrserviceNameoptionalStringServiceNameoptionalstringServiceNameoptional*string#Default: CloudFormation-generated name.
visibilityTimeoutoptionalDurationvisibility_timeoutoptionalDurationvisibilityTimeoutoptionalDurationVisibilityTimeoutoptionalDurationVisibilityTimeoutoptionalDuration= Duration.seconds(30)#notes
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: uses the VPC defined in the cluster or creates a new VPC.
If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.