Class QueueProcessingServiceBaseProps.Jsii$Proxy
- All Implemented Interfaces:
QueueProcessingServiceBaseProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
QueueProcessingServiceBaseProps
QueueProcessingServiceBaseProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.patterns.QueueProcessingServiceBaseProps
QueueProcessingServiceBaseProps.Builder, QueueProcessingServiceBaseProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theQueueProcessingServiceBaseProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final List<CapacityProviderStrategy>
A list of Capacity Provider strategies used to place a service.final DeploymentCircuitBreaker
Whether to enable the deployment circuit breaker.final ICluster
The name of the cluster that hosts the service.The command that is passed to the container.final Duration
Grace period after scaling activity in seconds.final Number
The target CPU utilization percentage for CPU based scaling strategy when enabled.final DeploymentController
Specifies which deployment controller to use for the service.final Boolean
Flag to disable CPU based auto scaling strategy on the service.final Boolean
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.final Boolean
Whether ECS Exec should be enabled.final Boolean
Flag to indicate whether to enable logging.The environment variables to pass to the container.final String
The name of a family that the task definition is registered to.final ContainerImage
getImage()
The image used to start a container.final LogDriver
The log driver to use.final Number
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.final Number
The maximum number of times that a message can be received by consumers.final Number
Maximum capacity to scale to.final Number
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.final Number
Minimum capacity to scale to.final PropagatedTagSource
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.final IQueue
getQueue()
A queue for which to process items from.final Duration
The number of seconds that Dead Letter Queue retains a message.final List<ScalingInterval>
The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.The secret to expose to the container as an environment variable.final String
The name of the service.final Duration
Timeout of processing a single message.final IVpc
getVpc()
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theQueueProcessingServiceBaseProps.Builder
.
-
-
Method Details
-
getCapacityProviderStrategies
Description copied from interface:QueueProcessingServiceBaseProps
A list of Capacity Provider strategies used to place a service.Default: - undefined
- Specified by:
getCapacityProviderStrategies
in interfaceQueueProcessingServiceBaseProps
-
getCircuitBreaker
Description copied from interface:QueueProcessingServiceBaseProps
Whether to enable the deployment circuit breaker.If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
- Specified by:
getCircuitBreaker
in interfaceQueueProcessingServiceBaseProps
-
getCluster
Description copied from interface:QueueProcessingServiceBaseProps
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.
- Specified by:
getCluster
in interfaceQueueProcessingServiceBaseProps
-
getCommand
Description copied from interface:QueueProcessingServiceBaseProps
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.
- Specified by:
getCommand
in interfaceQueueProcessingServiceBaseProps
-
getCooldown
Description copied from interface:QueueProcessingServiceBaseProps
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
- Specified by:
getCooldown
in interfaceQueueProcessingServiceBaseProps
- See Also:
-
getCpuTargetUtilizationPercent
Description copied from interface:QueueProcessingServiceBaseProps
The target CPU utilization percentage for CPU based scaling strategy when enabled.Default: - 50
- Specified by:
getCpuTargetUtilizationPercent
in interfaceQueueProcessingServiceBaseProps
-
getDeploymentController
Description copied from interface:QueueProcessingServiceBaseProps
Specifies which deployment controller to use for the service.For more information, see Amazon ECS Deployment Types
Default: - Rolling update (ECS)
- Specified by:
getDeploymentController
in interfaceQueueProcessingServiceBaseProps
-
getDisableCpuBasedScaling
Description copied from interface:QueueProcessingServiceBaseProps
Flag to disable CPU based auto scaling strategy on the service.Default: - false
- Specified by:
getDisableCpuBasedScaling
in interfaceQueueProcessingServiceBaseProps
-
getEnableECSManagedTags
Description copied from interface:QueueProcessingServiceBaseProps
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
- Specified by:
getEnableECSManagedTags
in interfaceQueueProcessingServiceBaseProps
-
getEnableExecuteCommand
Description copied from interface:QueueProcessingServiceBaseProps
Whether ECS Exec should be enabled.Default: - false
- Specified by:
getEnableExecuteCommand
in interfaceQueueProcessingServiceBaseProps
-
getEnableLogging
Description copied from interface:QueueProcessingServiceBaseProps
Flag to indicate whether to enable logging.Default: true
- Specified by:
getEnableLogging
in interfaceQueueProcessingServiceBaseProps
-
getEnvironment
Description copied from interface:QueueProcessingServiceBaseProps
The environment variables to pass to the container.The variable
QUEUE_NAME
with valuequeue.queueName
will always be passed.Default: 'QUEUE_NAME: queue.queueName'
- Specified by:
getEnvironment
in interfaceQueueProcessingServiceBaseProps
-
getFamily
Description copied from interface:QueueProcessingServiceBaseProps
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.
- Specified by:
getFamily
in interfaceQueueProcessingServiceBaseProps
-
getImage
Description copied from interface:QueueProcessingServiceBaseProps
The image used to start a container.For
QueueProcessingFargateService
, eitherimage
ortaskDefinition
must be specified, but not both. ForQueueProcessingEc2Service
,image
is required.Default: - the image of the task definition is used for Fargate, required otherwise
- Specified by:
getImage
in interfaceQueueProcessingServiceBaseProps
-
getLogDriver
Description copied from interface:QueueProcessingServiceBaseProps
The log driver to use.Default: - AwsLogDriver if enableLogging is true
- Specified by:
getLogDriver
in interfaceQueueProcessingServiceBaseProps
-
getMaxHealthyPercent
Description copied from interface:QueueProcessingServiceBaseProps
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.
- Specified by:
getMaxHealthyPercent
in interfaceQueueProcessingServiceBaseProps
-
getMaxReceiveCount
Description copied from interface:QueueProcessingServiceBaseProps
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
- Specified by:
getMaxReceiveCount
in interfaceQueueProcessingServiceBaseProps
-
getMaxScalingCapacity
Description copied from interface:QueueProcessingServiceBaseProps
Maximum capacity to scale to.Default: 2
- Specified by:
getMaxScalingCapacity
in interfaceQueueProcessingServiceBaseProps
-
getMinHealthyPercent
Description copied from interface:QueueProcessingServiceBaseProps
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.
- Specified by:
getMinHealthyPercent
in interfaceQueueProcessingServiceBaseProps
-
getMinScalingCapacity
Description copied from interface:QueueProcessingServiceBaseProps
Minimum capacity to scale to.Default: 1
- Specified by:
getMinScalingCapacity
in interfaceQueueProcessingServiceBaseProps
-
getPropagateTags
Description copied from interface:QueueProcessingServiceBaseProps
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
- Specified by:
getPropagateTags
in interfaceQueueProcessingServiceBaseProps
-
getQueue
Description copied from interface:QueueProcessingServiceBaseProps
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'
- Specified by:
getQueue
in interfaceQueueProcessingServiceBaseProps
-
getRetentionPeriod
Description copied from interface:QueueProcessingServiceBaseProps
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)
- Specified by:
getRetentionPeriod
in interfaceQueueProcessingServiceBaseProps
-
getScalingSteps
Description copied from interface:QueueProcessingServiceBaseProps
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 }]
- Specified by:
getScalingSteps
in interfaceQueueProcessingServiceBaseProps
-
getSecrets
Description copied from interface:QueueProcessingServiceBaseProps
The secret to expose to the container as an environment variable.Default: - No secret environment variables.
- Specified by:
getSecrets
in interfaceQueueProcessingServiceBaseProps
-
getServiceName
Description copied from interface:QueueProcessingServiceBaseProps
The name of the service.Default: - CloudFormation-generated name.
- Specified by:
getServiceName
in interfaceQueueProcessingServiceBaseProps
-
getVisibilityTimeout
Description copied from interface:QueueProcessingServiceBaseProps
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)
- Specified by:
getVisibilityTimeout
in interfaceQueueProcessingServiceBaseProps
-
getVpc
Description copied from interface:QueueProcessingServiceBaseProps
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.
- Specified by:
getVpc
in interfaceQueueProcessingServiceBaseProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-