Interface IQueueProcessingServiceBaseProps
The properties for the base QueueProcessingEc2Service or QueueProcessingFargateService service.
Namespace: Amazon.CDK.AWS.ECS.Patterns
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IQueueProcessingServiceBaseProps
Syntax (vb)
Public Interface IQueueProcessingServiceBaseProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.ECS;
using Amazon.CDK.AWS.ECS.Patterns;
using Amazon.CDK.AWS.SQS;
Cluster cluster;
ContainerImage containerImage;
LogDriver logDriver;
Queue queue;
Secret secret;
Vpc vpc;
var queueProcessingServiceBaseProps = new QueueProcessingServiceBaseProps {
CapacityProviderStrategies = new [] { new CapacityProviderStrategy {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
CircuitBreaker = new DeploymentCircuitBreaker {
Enable = false,
Rollback = false
},
Cluster = cluster,
Command = new [] { "command" },
Cooldown = Duration.Minutes(30),
CpuTargetUtilizationPercent = 123,
DeploymentController = new DeploymentController {
Type = DeploymentControllerType.ECS
},
DisableCpuBasedScaling = false,
EnableECSManagedTags = false,
EnableExecuteCommand = false,
EnableLogging = false,
Environment = new Dictionary<string, string> {
{ "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 = new [] { new ScalingInterval {
Change = 123,
// the properties below are optional
Lower = 123,
Upper = 123
} },
Secrets = new Dictionary<string, Secret> {
{ "secretsKey", secret }
},
ServiceName = "serviceName",
VisibilityTimeout = Duration.Minutes(30),
Vpc = vpc
};
Synopsis
Properties
CapacityProviderStrategies | A list of Capacity Provider strategies used to place a service. |
CircuitBreaker | Whether to enable the deployment circuit breaker. |
Cluster | The name of the cluster that hosts the service. |
Command | The command that is passed to the container. |
Cooldown | Grace period after scaling activity in seconds. |
CpuTargetUtilizationPercent | The target CPU utilization percentage for CPU based scaling strategy when enabled. |
DeploymentController | Specifies which deployment controller to use for the service. |
DisableCpuBasedScaling | Flag to disable CPU based auto scaling strategy on the service. |
EnableECSManagedTags | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
EnableExecuteCommand | Whether ECS Exec should be enabled. |
EnableLogging | Flag to indicate whether to enable logging. |
Environment | The environment variables to pass to the container. |
Family | The name of a family that the task definition is registered to. |
Image | The image used to start a container. |
LogDriver | The log driver to use. |
MaxHealthyPercent | 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. |
MaxReceiveCount | The maximum number of times that a message can be received by consumers. |
MaxScalingCapacity | Maximum capacity to scale to. |
MinHealthyPercent | 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. |
MinScalingCapacity | Minimum capacity to scale to. |
PropagateTags | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
Queue | A queue for which to process items from. |
RetentionPeriod | The number of seconds that Dead Letter Queue retains a message. |
ScalingSteps | The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric. |
Secrets | The secret to expose to the container as an environment variable. |
ServiceName | The name of the service. |
VisibilityTimeout | Timeout of processing a single message. |
Vpc | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
Properties
CapacityProviderStrategies
A list of Capacity Provider strategies used to place a service.
virtual ICapacityProviderStrategy[] CapacityProviderStrategies { get; }
Property Value
Remarks
Default: - undefined
CircuitBreaker
Whether to enable the deployment circuit breaker.
virtual IDeploymentCircuitBreaker CircuitBreaker { get; }
Property Value
Remarks
If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
Cluster
The name of the cluster that hosts the service.
virtual ICluster Cluster { get; }
Property Value
Remarks
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.
Command
The command that is passed to the container.
virtual string[] Command { get; }
Property Value
System.String[]
Remarks
If you provide a shell command as a single string, you have to quote command-line arguments.
Default: - CMD value built into container image.
Cooldown
Grace period after scaling activity in seconds.
virtual Duration Cooldown { get; }
Property Value
Remarks
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
CpuTargetUtilizationPercent
The target CPU utilization percentage for CPU based scaling strategy when enabled.
virtual Nullable<double> CpuTargetUtilizationPercent { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 50
DeploymentController
Specifies which deployment controller to use for the service.
virtual IDeploymentController DeploymentController { get; }
Property Value
Remarks
For more information, see Amazon ECS Deployment Types
Default: - Rolling update (ECS)
DisableCpuBasedScaling
Flag to disable CPU based auto scaling strategy on the service.
virtual Nullable<bool> DisableCpuBasedScaling { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false
EnableECSManagedTags
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
virtual Nullable<bool> EnableECSManagedTags { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
For more information, see Tagging Your Amazon ECS Resources
Default: false
EnableExecuteCommand
Whether ECS Exec should be enabled.
virtual Nullable<bool> EnableExecuteCommand { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false
EnableLogging
Flag to indicate whether to enable logging.
virtual Nullable<bool> EnableLogging { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Environment
The environment variables to pass to the container.
virtual IDictionary<string, string> Environment { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
The variable QUEUE_NAME
with value queue.queueName
will
always be passed.
Default: 'QUEUE_NAME: queue.queueName'
Family
The name of a family that the task definition is registered to.
virtual string Family { get; }
Property Value
System.String
Remarks
A family groups multiple versions of a task definition.
Default: - Automatically generated name.
Image
The image used to start a container.
virtual ContainerImage Image { get; }
Property Value
Remarks
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
LogDriver
The log driver to use.
virtual LogDriver LogDriver { get; }
Property Value
Remarks
Default: - AwsLogDriver if enableLogging is true
MaxHealthyPercent
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.
virtual Nullable<double> MaxHealthyPercent { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - default from underlying service.
MaxReceiveCount
The maximum number of times that a message can be received by consumers.
virtual Nullable<double> MaxReceiveCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
MaxScalingCapacity
Maximum capacity to scale to.
virtual Nullable<double> MaxScalingCapacity { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 2
MinHealthyPercent
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.
virtual Nullable<double> MinHealthyPercent { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - default from underlying service.
MinScalingCapacity
Minimum capacity to scale to.
virtual Nullable<double> MinScalingCapacity { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
PropagateTags
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
virtual Nullable<PropagatedTagSource> PropagateTags { get; }
Property Value
System.Nullable<PropagatedTagSource>
Remarks
Tags can only be propagated to the tasks within the service during service creation.
Default: - none
Queue
A queue for which to process items from.
virtual IQueue Queue { get; }
Property Value
Remarks
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'
RetentionPeriod
The number of seconds that Dead Letter Queue retains a message.
virtual Duration RetentionPeriod { get; }
Property Value
Remarks
If the queue construct is specified, retentionPeriod should be omitted.
Default: Duration.days(14)
ScalingSteps
The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
virtual IScalingInterval[] ScalingSteps { get; }
Property Value
Remarks
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 }]
Secrets
The secret to expose to the container as an environment variable.
virtual IDictionary<string, Secret> Secrets { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, Secret>
Remarks
Default: - No secret environment variables.
ServiceName
The name of the service.
virtual string ServiceName { get; }
Property Value
System.String
Remarks
Default: - CloudFormation-generated name.
VisibilityTimeout
Timeout of processing a single message.
virtual Duration VisibilityTimeout { get; }
Property Value
Remarks
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)
Vpc
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
virtual IVpc Vpc { get; }
Property Value
Remarks
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.