Package software.amazon.awscdk.services.ecs.patterns

Interface QueueProcessingServiceBaseProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
QueueProcessingEc2ServiceProps, QueueProcessingFargateServiceProps
All Known Implementing Classes:
QueueProcessingEc2ServiceProps.Jsii$Proxy, QueueProcessingFargateServiceProps.Jsii$Proxy, QueueProcessingServiceBaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-15T10:24:58.985Z") @Stability(Stable) public interface QueueProcessingServiceBaseProps extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 import software.amazon.awscdk.services.sqs.*;
 Cluster cluster;
 ContainerImage containerImage;
 LogDriver logDriver;
 Queue queue;
 Secret secret;
 Vpc vpc;
 QueueProcessingServiceBaseProps queueProcessingServiceBaseProps = QueueProcessingServiceBaseProps.builder()
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("capacityProvider")
                 // the properties below are optional
                 .base(123)
                 .weight(123)
                 .build()))
         .circuitBreaker(DeploymentCircuitBreaker.builder()
                 .enable(false)
                 .rollback(false)
                 .build())
         .cluster(cluster)
         .command(List.of("command"))
         .cooldown(Duration.minutes(30))
         .cpuTargetUtilizationPercent(123)
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.ECS)
                 .build())
         .disableCpuBasedScaling(false)
         .enableECSManagedTags(false)
         .enableExecuteCommand(false)
         .enableLogging(false)
         .environment(Map.of(
                 "environmentKey", "environment"))
         .family("family")
         .image(containerImage)
         .logDriver(logDriver)
         .maxHealthyPercent(123)
         .maxReceiveCount(123)
         .maxScalingCapacity(123)
         .minHealthyPercent(123)
         .minScalingCapacity(123)
         .propagateTags(PropagatedTagSource.SERVICE)
         .queue(queue)
         .retentionPeriod(Duration.minutes(30))
         .scalingSteps(List.of(ScalingInterval.builder()
                 .change(123)
                 // the properties below are optional
                 .lower(123)
                 .upper(123)
                 .build()))
         .secrets(Map.of(
                 "secretsKey", secret))
         .serviceName("serviceName")
         .visibilityTimeout(Duration.minutes(30))
         .vpc(vpc)
         .build();

  • Method Details

    • getCapacityProviderStrategies

      @Stability(Stable) @Nullable default List<CapacityProviderStrategy> getCapacityProviderStrategies()
      A list of Capacity Provider strategies used to place a service.

      Default: - undefined

    • getCircuitBreaker

      @Stability(Stable) @Nullable default DeploymentCircuitBreaker getCircuitBreaker()
      Whether to enable the deployment circuit breaker.

      If this property is defined, circuit breaker will be implicitly enabled.

      Default: - disabled

    • getCluster

      @Stability(Stable) @Nullable default ICluster getCluster()
      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.

    • getCommand

      @Stability(Stable) @Nullable default List<String> getCommand()
      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.

    • getCooldown

      @Stability(Stable) @Nullable default Duration getCooldown()
      Grace period after scaling activity in 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.

      Default: 300 seconds

      See Also:

    • getCpuTargetUtilizationPercent

      @Stability(Stable) @Nullable default Number getCpuTargetUtilizationPercent()
      The target CPU utilization percentage for CPU based scaling strategy when enabled.

      Default: - 50

    • getDeploymentController

      @Stability(Stable) @Nullable default DeploymentController getDeploymentController()
      Specifies which deployment controller to use for the service.

      For more information, see Amazon ECS Deployment Types

      Default: - Rolling update (ECS)

    • getDisableCpuBasedScaling

      @Stability(Stable) @Nullable default Boolean getDisableCpuBasedScaling()
      Flag to disable CPU based auto scaling strategy on the service.

      Default: - false

    • getEnableECSManagedTags

      @Stability(Stable) @Nullable default Boolean getEnableECSManagedTags()
      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

    • getEnableExecuteCommand

      @Stability(Stable) @Nullable default Boolean getEnableExecuteCommand()
      Whether ECS Exec should be enabled.

      Default: - false

    • getEnableLogging

      @Stability(Stable) @Nullable default Boolean getEnableLogging()
      Flag to indicate whether to enable logging.

      Default: true

    • getEnvironment

      @Stability(Stable) @Nullable default Map<String,String> getEnvironment()
      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'

    • getFamily

      @Stability(Stable) @Nullable default String getFamily()
      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.

    • getImage

      @Stability(Stable) @Nullable default ContainerImage getImage()
      The image used to start a container.

      For QueueProcessingFargateService, either image or taskDefinition must be specified, but not both. For QueueProcessingEc2Service, image is required.

      Default: - the image of the task definition is used for Fargate, required otherwise

    • getLogDriver

      @Stability(Stable) @Nullable default LogDriver getLogDriver()
      The log driver to use.

      Default: - AwsLogDriver if enableLogging is true

    • getMaxHealthyPercent

      @Stability(Stable) @Nullable default Number getMaxHealthyPercent()
      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.

    • getMaxReceiveCount

      @Stability(Stable) @Nullable default Number getMaxReceiveCount()
      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.

      If the queue construct is specified, maxReceiveCount should be omitted.

      Default: 3

    • getMaxScalingCapacity

      @Stability(Stable) @Nullable default Number getMaxScalingCapacity()
      Maximum capacity to scale to.

      Default: 2

    • getMinHealthyPercent

      @Stability(Stable) @Nullable default Number getMinHealthyPercent()
      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.

    • getMinScalingCapacity

      @Stability(Stable) @Nullable default Number getMinScalingCapacity()
      Minimum capacity to scale to.

      Default: 1

    • getPropagateTags

      @Stability(Stable) @Nullable default PropagatedTagSource getPropagateTags()
      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

    • getQueue

      @Stability(Stable) @Nullable default IQueue getQueue()
      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'

    • getRetentionPeriod

      @Stability(Stable) @Nullable default Duration getRetentionPeriod()
      The number of seconds that Dead Letter Queue retains a message.

      If the queue construct is specified, retentionPeriod should be omitted.

      Default: Duration.days(14)

    • getScalingSteps

      @Stability(Stable) @Nullable default List<ScalingInterval> getScalingSteps()
      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 }]

    • getSecrets

      @Stability(Stable) @Nullable default Map<String,Secret> getSecrets()
      The secret to expose to the container as an environment variable.

      Default: - No secret environment variables.

    • getServiceName

      @Stability(Stable) @Nullable default String getServiceName()
      The name of the service.

      Default: - CloudFormation-generated name.

    • getVisibilityTimeout

      @Stability(Stable) @Nullable default Duration getVisibilityTimeout()
      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).

      If the queue construct is specified, visibilityTimeout should be omitted.

      Default: Duration.seconds(30)

    • getVpc

      @Stability(Stable) @Nullable default IVpc getVpc()
      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.

    • builder

      @Stability(Stable) static QueueProcessingServiceBaseProps.Builder builder()
      Returns:
      a QueueProcessingServiceBaseProps.Builder of QueueProcessingServiceBaseProps