QueueProcessingServiceBaseProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.826Z")
 @Stability(value=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()
         .image(containerImage)
         // the properties below are optional
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("capacityProvider")
                 // the properties below are optional
                 .base(123)
                 .weight(123)
                 .build()))
         .circuitBreaker(DeploymentCircuitBreaker.builder()
                 .rollback(false)
                 .build())
         .cluster(cluster)
         .command(List.of("command"))
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.ECS)
                 .build())
         .enableECSManagedTags(false)
         .enableExecuteCommand(false)
         .enableLogging(false)
         .environment(Map.of(
                 "environmentKey", "environment"))
         .family("family")
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`QueueProcessingServiceBaseProps.Builder` A builder for `QueueProcessingServiceBaseProps`
`static class`	`QueueProcessingServiceBaseProps.Jsii$Proxy` An implementation for `QueueProcessingServiceBaseProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static QueueProcessingServiceBaseProps.Builder`	`builder()`
`default List<CapacityProviderStrategy>`	`getCapacityProviderStrategies()` A list of Capacity Provider strategies used to place a service.
`default DeploymentCircuitBreaker`	`getCircuitBreaker()` Whether to enable the deployment circuit breaker.
`default ICluster`	`getCluster()` The name of the cluster that hosts the service.
`default List<String>`	`getCommand()` The command that is passed to the container.
`default DeploymentController`	`getDeploymentController()` Specifies which deployment controller to use for the service.
`default Boolean`	`getEnableECSManagedTags()` Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`default Boolean`	`getEnableExecuteCommand()` Whether ECS Exec should be enabled.
`default Boolean`	`getEnableLogging()` Flag to indicate whether to enable logging.
`default Map<String,String>`	`getEnvironment()` The environment variables to pass to the container.
`default String`	`getFamily()` The name of a family that the task definition is registered to.
`ContainerImage`	`getImage()` The image used to start a container.
`default LogDriver`	`getLogDriver()` The log driver to use.
`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 Number`	`getMaxReceiveCount()` The maximum number of times that a message can be received by consumers.
`default Number`	`getMaxScalingCapacity()` Maximum capacity to scale to.
`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 Number`	`getMinScalingCapacity()` Minimum capacity to scale to.
`default PropagatedTagSource`	`getPropagateTags()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`default IQueue`	`getQueue()` A queue for which to process items from.
`default Duration`	`getRetentionPeriod()` The number of seconds that Dead Letter Queue retains a message.
`default List<ScalingInterval>`	`getScalingSteps()` The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
`default Map<String,Secret>`	`getSecrets()` The secret to expose to the container as an environment variable.
`default String`	`getServiceName()` The name of the service.
`default Duration`	`getVisibilityTimeout()` Timeout of processing a single message.
`default IVpc`	`getVpc()` The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getImage
```
@Stability(value=Stable)
 @NotNull
ContainerImage getImage()
```
    The image used to start a container.
  - getCapacityProviderStrategies
```
@Stability(value=Stable)
 @Nullable
default List<CapacityProviderStrategy> getCapacityProviderStrategies()
```
    A list of Capacity Provider strategies used to place a service.
    Default: - undefined
  - getCircuitBreaker
```
@Stability(value=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(value=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(value=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.
  - getDeploymentController
```
@Stability(value=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)
  - getEnableECSManagedTags
```
@Stability(value=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(value=Stable)
 @Nullable
default Boolean getEnableExecuteCommand()
```
    Whether ECS Exec should be enabled.
    Default: - false
  - getEnableLogging
```
@Stability(value=Stable)
 @Nullable
default Boolean getEnableLogging()
```
    Flag to indicate whether to enable logging.
    Default: true
  - getEnvironment
```
@Stability(value=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(value=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.
  - getLogDriver
```
@Stability(value=Stable)
 @Nullable
default LogDriver getLogDriver()
```
    The log driver to use.
    Default: - AwsLogDriver if enableLogging is true
  - getMaxHealthyPercent
```
@Stability(value=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(value=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(value=Stable)
 @Nullable
default Number getMaxScalingCapacity()
```
    Maximum capacity to scale to.
    Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is (desiredTaskCount * 2); if true, the default is 2.
  - getMinHealthyPercent
```
@Stability(value=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(value=Stable)
 @Nullable
default Number getMinScalingCapacity()
```
    Minimum capacity to scale to.
    Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 1.
  - getPropagateTags
```
@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
default String getServiceName()
```
    The name of the service.
    Default: - CloudFormation-generated name.
  - getVisibilityTimeout
```
@Stability(value=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(value=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(value=Stable)
static QueueProcessingServiceBaseProps.Builder builder()
```
    Returns:
    
    a QueueProcessingServiceBaseProps.Builder of QueueProcessingServiceBaseProps

Interface QueueProcessingServiceBaseProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getImage

getCapacityProviderStrategies

getCircuitBreaker

getCluster

getCommand

getDeploymentController

getEnableECSManagedTags

getEnableExecuteCommand

getEnableLogging

getEnvironment

getFamily

getLogDriver

getMaxHealthyPercent

getMaxReceiveCount

getMaxScalingCapacity

getMinHealthyPercent

getMinScalingCapacity

getPropagateTags

getQueue

getRetentionPeriod

getScalingSteps

getSecrets

getServiceName

getVisibilityTimeout

getVpc

builder