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.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.887Z")
 @Stability(value=Experimental)
public interface QueueProcessingServiceBaseProps
extends software.amazon.jsii.JsiiSerializable

(experimental) The properties for the base QueueProcessingEc2Service or QueueProcessingFargateService service.

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

Modifier and Type	Method and Description
static QueueProcessingServiceBaseProps.Builder	builder()
default DeploymentCircuitBreaker	getCircuitBreaker() (experimental) Whether to enable the deployment circuit breaker.
default ICluster	getCluster() (experimental) The name of the cluster that hosts the service.
default List<String>	getCommand() (experimental) The command that is passed to the container.
default DeploymentController	getDeploymentController() (experimental) Specifies which deployment controller to use for the service.
default Boolean	getEnableECSManagedTags() (experimental) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
default Boolean	getEnableLogging() (experimental) Flag to indicate whether to enable logging.
default Map<String,String>	getEnvironment() (experimental) The environment variables to pass to the container.
default String	getFamily() (experimental) The name of a family that the task definition is registered to.
ContainerImage	getImage() (experimental) The image used to start a container.
default LogDriver	getLogDriver() (experimental) The log driver to use.
default Number	getMaxHealthyPercent() (experimental) 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() (experimental) The maximum number of times that a message can be received by consumers.
default Number	getMaxScalingCapacity() (experimental) Maximum capacity to scale to.
default Number	getMinHealthyPercent() (experimental) 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() (experimental) Minimum capacity to scale to.
default PropagatedTagSource	getPropagateTags() (experimental) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
default IQueue	getQueue() (experimental) A queue for which to process items from.
default Duration	getRetentionPeriod() (experimental) The number of seconds that Dead Letter Queue retains a message.
default List<ScalingInterval>	getScalingSteps() (experimental) The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
default Map<String,Secret>	getSecrets() (experimental) The secret to expose to the container as an environment variable.
default String	getServiceName() (experimental) The name of the service.
default IVpc	getVpc() (experimental) 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=Experimental)
 @NotNull
ContainerImage getImage()

(experimental) The image used to start a container.

getCircuitBreaker

@Stability(value=Experimental)
 @Nullable
default DeploymentCircuitBreaker getCircuitBreaker()

(experimental) Whether to enable the deployment circuit breaker.

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

Default: - disabled

getCluster

@Stability(value=Experimental)
 @Nullable
default ICluster getCluster()

(experimental) 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=Experimental)
 @Nullable
default List<String> getCommand()

(experimental) 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=Experimental)
 @Nullable
default DeploymentController getDeploymentController()

(experimental) Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default: - Rolling update (ECS)

getEnableECSManagedTags

@Stability(value=Experimental)
 @Nullable
default Boolean getEnableECSManagedTags()

(experimental) 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

getEnableLogging

@Stability(value=Experimental)
 @Nullable
default Boolean getEnableLogging()

(experimental) Flag to indicate whether to enable logging.

Default: true

getEnvironment

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getEnvironment()

(experimental) 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=Experimental)
 @Nullable
default String getFamily()

(experimental) 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=Experimental)
 @Nullable
default LogDriver getLogDriver()

(experimental) The log driver to use.

Default: - AwsLogDriver if enableLogging is true

getMaxHealthyPercent

@Stability(value=Experimental)
 @Nullable
default Number getMaxHealthyPercent()

(experimental) 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=Experimental)
 @Nullable
default Number getMaxReceiveCount()

(experimental) 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.

Default: 3

getMaxScalingCapacity

@Stability(value=Experimental)
 @Nullable
default Number getMaxScalingCapacity()

(experimental) 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=Experimental)
 @Nullable
default Number getMinHealthyPercent()

(experimental) 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=Experimental)
 @Nullable
default Number getMinScalingCapacity()

(experimental) 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=Experimental)
 @Nullable
default PropagatedTagSource getPropagateTags()

(experimental) 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=Experimental)
 @Nullable
default IQueue getQueue()

(experimental) 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=Experimental)
 @Nullable
default Duration getRetentionPeriod()

(experimental) The number of seconds that Dead Letter Queue retains a message.

Default: Duration.days(14)

getScalingSteps

@Stability(value=Experimental)
 @Nullable
default List<ScalingInterval> getScalingSteps()

(experimental) 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=Experimental)
 @Nullable
default Map<String,Secret> getSecrets()

(experimental) The secret to expose to the container as an environment variable.

Default: - No secret environment variables.

getServiceName

@Stability(value=Experimental)
 @Nullable
default String getServiceName()

(experimental) The name of the service.

Default: - CloudFormation-generated name.

getVpc

@Stability(value=Experimental)
 @Nullable
default IVpc getVpc()

(experimental) 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=Experimental)
static QueueProcessingServiceBaseProps.Builder builder()

Returns:

a QueueProcessingServiceBaseProps.Builder of QueueProcessingServiceBaseProps