QueueProcessingEc2Service L3 construct
Class to create a queue processing EC2 service.
Example
declare const cluster: ecs.Cluster;
const queueProcessingEc2Service = new ecsPatterns.QueueProcessingEc2Service(this, 'Service', {
cluster,
memoryLimitMiB: 1024,
image: ecs.ContainerImage.fromRegistry('test'),
command: ["-c", "4", "amazon.com"],
enableLogging: false,
desiredTaskCount: 2,
environment: {
TEST_ENVIRONMENT_VARIABLE1: "test environment variable 1 value",
TEST_ENVIRONMENT_VARIABLE2: "test environment variable 2 value",
},
maxScalingCapacity: 5,
containerName: 'test',
minHealthyPercent: 100,
});
# 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",
min_healthy_percent=100
)
Cluster cluster;
QueueProcessingEc2Service queueProcessingEc2Service = QueueProcessingEc2Service.Builder.create(this, "Service")
.cluster(cluster)
.memoryLimitMiB(1024)
.image(ContainerImage.fromRegistry("test"))
.command(List.of("-c", "4", "amazon.com"))
.enableLogging(false)
.desiredTaskCount(2)
.environment(Map.of(
"TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
"TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
.maxScalingCapacity(5)
.containerName("test")
.minHealthyPercent(100)
.build();
// Install: dotnet add package Amazon.CDK.Lib
Cluster cluster;
var queueProcessingEc2Service = new QueueProcessingEc2Service(this, "Service", new QueueProcessingEc2ServiceProps {
Cluster = cluster,
MemoryLimitMiB = 1024,
Image = ContainerImage.FromRegistry("test"),
Command = new [] { "-c", "4", "amazon.com" },
EnableLogging = false,
DesiredTaskCount = 2,
Environment = new Dictionary<string, string> {
{ "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value" },
{ "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value" }
},
MaxScalingCapacity = 5,
ContainerName = "test",
MinHealthyPercent = 100
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var cluster Cluster
queueProcessingEc2Service := ecsPatterns.NewQueueProcessingEc2Service(this, jsii.String("Service"), &QueueProcessingEc2ServiceProps{
Cluster: Cluster,
MemoryLimitMiB: jsii.Number(1024),
Image: ecs.ContainerImage_FromRegistry(jsii.String("test")),
Command: []*string{
jsii.String("-c"),
jsii.String("4"),
jsii.String("amazon.com"),
},
EnableLogging: jsii.Boolean(false),
DesiredTaskCount: jsii.Number(2),
Environment: map[string]*string{
"TEST_ENVIRONMENT_VARIABLE1": jsii.String("test environment variable 1 value"),
"TEST_ENVIRONMENT_VARIABLE2": jsii.String("test environment variable 2 value"),
},
MaxScalingCapacity: jsii.Number(5),
ContainerName: jsii.String("test"),
MinHealthyPercent: jsii.Number(100),
})
Initializer
new QueueProcessingEc2Service(scope: Construct, id: string, props?: QueueProcessingEc2ServiceProps)
QueueProcessingEc2Service(scope: Construct, id: str, props: typing.Optional[QueueProcessingEc2ServiceProps] = None)
new QueueProcessingEc2Service(Construct scope, String id, QueueProcessingEc2ServiceProps props)
new QueueProcessingEc2Service(Construct scope, string id, QueueProcessingEc2ServiceProps? props = null)
NewQueueProcessingEc2Service(Scope Construct, Id *string, Props QueueProcessingEc2ServiceProps)
Construct Props
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.
containerNameoptionalstringcontainer_nameoptionalstrcontainerNameoptionalStringContainerNameoptionalstringContainerNameoptional*string= QueueProcessingContainer#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.
notes
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.
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.
gpuCountoptionalnumbergpu_countoptionalint | floatgpuCountoptionalNumberGpuCountoptionaldoubleGpuCountoptional*float64#Default: No GPUs assigned.
Set this if you want to use gpu based instances.
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#memoryLimitMiBoptionalnumbermemory_limit_mi_boptionalint | floatmemoryLimitMiBoptionalNumberMemoryLimitMiBoptionaldoubleMemoryLimitMiBoptional*float64#Default: No memory limit.
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.
memoryReservationMiBoptionalnumbermemory_reservation_mi_boptionalint | floatmemoryReservationMiBoptionalNumberMemoryReservationMiBoptionaldoubleMemoryReservationMiBoptional*float64#Default: No memory reserved.
notes
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.
minHealthyPercentoptionalnumbermin_healthy_percentoptionalint | floatminHealthyPercentoptionalNumberMinHealthyPercentoptionaldoubleMinHealthyPercentoptional*float64#Default: default from underlying service.
minScalingCapacityoptionalnumbermin_scaling_capacityoptionalint | floatminScalingCapacityoptionalNumberMinScalingCapacityoptionaldoubleMinScalingCapacityoptional*float64= 1#placementConstraintsoptionalPlacementConstraint[]placement_constraintsoptionaltyping.List[PlacementConstraint]placementConstraintsoptionalList<PlacementConstraint>PlacementConstraintsoptionalPlacementConstraint[]PlacementConstraintsoptional*[]PlacementConstraint#Default: No constraints.
For more information, see Amazon ECS Task Placement Constraints.
placementStrategiesoptionalPlacementStrategy[]placement_strategiesoptionaltyping.List[PlacementStrategy]placementStrategiesoptionalList<PlacementStrategy>PlacementStrategiesoptionalPlacementStrategy[]PlacementStrategiesoptional*[]PlacementStrategy#Default: No strategies.
For more information, see Amazon ECS Task Placement Strategies.
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.
Properties
deadLetterQueuemay be undefinedIQueuedead_letter_queuemay be undefinedIQueuedeadLetterQueuemay be undefinedIQueueDeadLetterQueuemay be undefinedIQueueDeadLetterQueuemay be undefinedIQueue#environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*stringrequired#logDrivermay be undefinedLogDriverlog_drivermay be undefinedLogDriverlogDrivermay be undefinedLogDriverLogDrivermay be undefinedLogDriverLogDrivermay be undefinedLogDriver#maxCapacitynumbermax_capacityint | floatmaxCapacityNumberMaxCapacitydoubleMaxCapacity*float64required#minCapacitynumbermin_capacityint | floatminCapacityNumberMinCapacitydoubleMinCapacity*float64required#scalingStepsScalingInterval[]scaling_stepstyping.List[ScalingInterval]scalingStepsList<ScalingInterval>ScalingStepsScalingInterval[]ScalingSteps*[]ScalingIntervalrequired#secretsmay be undefined{ [key: string]: Secret }secretsmay be undefinedtyping.Mapping[str, Secret]secretsmay be undefinedMap<String, Secret>Secretsmay be undefinedIDictionary<string, Secret>Secretsmay be undefined*map[string]Secret#taskDefinitionEc2TaskDefinitiontask_definitionEc2TaskDefinitiontaskDefinitionEc2TaskDefinitionTaskDefinitionEc2TaskDefinitionTaskDefinitionEc2TaskDefinitionrequired#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