Class QueueProcessingServiceBaseProps
The properties for the base QueueProcessingEc2Service or QueueProcessingFargateService service.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ECS.Patterns
Assembly: Amazon.CDK.AWS.ECS.Patterns.dll
Syntax (csharp)
public class QueueProcessingServiceBaseProps : Object, IQueueProcessingServiceBaseProps
Syntax (vb)
Public Class QueueProcessingServiceBaseProps
Inherits Object
Implements 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.AWS.EC2;
using Amazon.CDK.AWS.ECS;
using Amazon.CDK.AWS.ECS.Patterns;
using Amazon.CDK.AWS.SQS;
using Amazon.CDK;
Cluster cluster;
ContainerImage containerImage;
LogDriver logDriver;
Queue queue;
Secret secret;
Vpc vpc;
var queueProcessingServiceBaseProps = new QueueProcessingServiceBaseProps {
Image = containerImage,
// the properties below are optional
CapacityProviderStrategies = new [] { new CapacityProviderStrategy {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
CircuitBreaker = new DeploymentCircuitBreaker {
Rollback = false
},
Cluster = cluster,
Command = new [] { "command" },
DeploymentController = new DeploymentController {
Type = DeploymentControllerType.ECS
},
DesiredTaskCount = 123,
EnableECSManagedTags = false,
EnableLogging = false,
Environment = new Dictionary<string, string> {
{ "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 = 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
Constructors
QueueProcessingServiceBaseProps() |
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. |
DeploymentController | Specifies which deployment controller to use for the service. |
DesiredTaskCount | (deprecated) The desired number of instantiations of the task definition to keep running on the service. |
EnableECSManagedTags | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
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. |
Constructors
QueueProcessingServiceBaseProps()
public QueueProcessingServiceBaseProps()
Properties
CapacityProviderStrategies
A list of Capacity Provider strategies used to place a service.
public ICapacityProviderStrategy[] CapacityProviderStrategies { get; set; }
Property Value
Remarks
Default: - undefined
CircuitBreaker
Whether to enable the deployment circuit breaker.
public IDeploymentCircuitBreaker CircuitBreaker { get; set; }
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.
public ICluster Cluster { get; set; }
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.
public string[] Command { get; set; }
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.
DeploymentController
Specifies which deployment controller to use for the service.
public IDeploymentController DeploymentController { get; set; }
Property Value
Remarks
For more information, see Amazon ECS Deployment Types
Default: - Rolling update (ECS)
DesiredTaskCount
(deprecated) The desired number of instantiations of the task definition to keep running on the service.
public Nullable<double> DesiredTaskCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the minScalingCapacity is 1 for all new services and uses the existing services desired count when updating an existing service.
Stability: Deprecated
EnableECSManagedTags
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
public Nullable<bool> EnableECSManagedTags { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
For more information, see Tagging Your Amazon ECS Resources
Default: false
EnableLogging
Flag to indicate whether to enable logging.
public Nullable<bool> EnableLogging { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Environment
The environment variables to pass to the container.
public IDictionary<string, string> Environment { get; set; }
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.
public string Family { get; set; }
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.
public ContainerImage Image { get; set; }
Property Value
LogDriver
The log driver to use.
public LogDriver LogDriver { get; set; }
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.
public Nullable<double> MaxHealthyPercent { get; set; }
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.
public Nullable<double> MaxReceiveCount { get; set; }
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.
Default: 3
MaxScalingCapacity
Maximum capacity to scale to.
public Nullable<double> MaxScalingCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is (desiredTaskCount * 2); if true, the default is 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.
public Nullable<double> MinHealthyPercent { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - default from underlying service.
MinScalingCapacity
Minimum capacity to scale to.
public Nullable<double> MinScalingCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 1.
PropagateTags
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
public Nullable<PropagatedTagSource> PropagateTags { get; set; }
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.
public IQueue Queue { get; set; }
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.
public Duration RetentionPeriod { get; set; }
Property Value
Remarks
Default: Duration.days(14)
ScalingSteps
The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
public IScalingInterval[] ScalingSteps { get; set; }
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.
public IDictionary<string, Secret> Secrets { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, Secret>
Remarks
Default: - No secret environment variables.
ServiceName
The name of the service.
public string ServiceName { get; set; }
Property Value
System.String
Remarks
Default: - CloudFormation-generated name.
VisibilityTimeout
Timeout of processing a single message.
public Duration VisibilityTimeout { get; set; }
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).
Default: Duration.seconds(30)
Vpc
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
public IVpc Vpc { get; set; }
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.