QueueProcessingServiceBase L3 construct
The base class for QueueProcessingEc2Service and QueueProcessingFargateService services.
Initializer
new QueueProcessingServiceBase(scope: Construct, id: string, props: QueueProcessingServiceBaseProps)
QueueProcessingServiceBase(scope: Construct, id: str, props: QueueProcessingServiceBaseProps)
new QueueProcessingServiceBase(Construct scope, String id, QueueProcessingServiceBaseProps props)
new QueueProcessingServiceBase(Construct scope, string id, QueueProcessingServiceBaseProps props)
NewQueueProcessingServiceBase(Scope Construct, Id *string, Props QueueProcessingServiceBaseProps)
Construct Props
capacityProviderStrategiesCapacityProviderStrategy[]capacity_provider_strategiestyping.List[CapacityProviderStrategy]capacityProviderStrategiesList<CapacityProviderStrategy>CapacityProviderStrategiesCapacityProviderStrategy[]CapacityProviderStrategies*[]CapacityProviderStrategy= undefined#circuitBreakerDeploymentCircuitBreakercircuit_breakerDeploymentCircuitBreakercircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreaker= disabled#If this property is defined, circuit breaker will be implicitly enabled.
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.
Default: CMD value built into container image.
If you provide a shell command as a single string, you have to quote command-line arguments.
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.
cpuTargetUtilizationPercentnumbercpu_target_utilization_percentint | floatcpuTargetUtilizationPercentNumberCpuTargetUtilizationPercentdoubleCpuTargetUtilizationPercent*float64= 50#deploymentControllerDeploymentControllerdeployment_controllerDeploymentControllerdeploymentControllerDeploymentControllerDeploymentControllerDeploymentControllerDeploymentControllerDeploymentController#Default: Rolling update (ECS)
For more information, see Amazon ECS Deployment Types
disableCpuBasedScalingbooleandisable_cpu_based_scalingbooldisableCpuBasedScalingBooleanDisableCpuBasedScalingboolDisableCpuBasedScaling*bool= false#enableECSManagedTagsbooleanenable_ecs_managed_tagsboolenableECSManagedTagsBooleanEnableECSManagedTagsboolEnableECSManagedTags*bool= false#For more information, see Tagging Your Amazon ECS Resources
enableExecuteCommandbooleanenable_execute_commandboolenableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommand*bool= false#enableLoggingbooleanenable_loggingboolenableLoggingBooleanEnableLoggingboolEnableLogging*bool= true#environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*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.
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.
Default: AwsLogDriver if enableLogging is true
maxHealthyPercentnumbermax_healthy_percentint | floatmaxHealthyPercentNumberMaxHealthyPercentdoubleMaxHealthyPercent*float64#Default: default from underlying service.
maxReceiveCountnumbermax_receive_countint | floatmaxReceiveCountNumberMaxReceiveCountdoubleMaxReceiveCount*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.
maxScalingCapacitynumbermax_scaling_capacityint | floatmaxScalingCapacityNumberMaxScalingCapacitydoubleMaxScalingCapacity*float64= 2#minHealthyPercentnumbermin_healthy_percentint | floatminHealthyPercentNumberMinHealthyPercentdoubleMinHealthyPercent*float64#Default: default from underlying service.
minScalingCapacitynumbermin_scaling_capacityint | floatminScalingCapacityNumberMinScalingCapacitydoubleMinScalingCapacity*float64= 1#propagateTagsPropagatedTagSourcepropagate_tagsPropagatedTagSourcepropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSource= 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
retentionPeriodDurationretention_periodDurationretentionPeriodDurationRetentionPeriodDurationRetentionPeriodDuration= Duration.days(14)#If the queue construct is specified, retentionPeriod should be omitted.
scalingStepsScalingInterval[]scaling_stepstyping.List[ScalingInterval]scalingStepsList<ScalingInterval>ScalingStepsScalingInterval[]ScalingSteps*[]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
secrets{ [key: string]: Secret }secretstyping.Mapping[str, Secret]secretsMap<String, Secret>SecretsIDictionary<string, Secret>Secrets*map[string]Secret#Default: No secret environment variables.
Default: CloudFormation-generated name.
visibilityTimeoutDurationvisibility_timeoutDurationvisibilityTimeoutDurationVisibilityTimeoutDurationVisibilityTimeoutDuration= 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.
Properties
deadLetterQueueIQueuedead_letter_queueIQueuedeadLetterQueueIQueueDeadLetterQueueIQueueDeadLetterQueueIQueue#environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*stringrequired#maxCapacitynumbermax_capacityint | floatmaxCapacityNumberMaxCapacitydoubleMaxCapacity*float64required#minCapacitynumbermin_capacityint | floatminCapacityNumberMinCapacitydoubleMinCapacity*float64required#scalingStepsScalingInterval[]scaling_stepstyping.List[ScalingInterval]scalingStepsList<ScalingInterval>ScalingStepsScalingInterval[]ScalingSteps*[]ScalingIntervalrequired#Methods
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining