Class QueueProcessingFargateServiceProps
The properties for the QueueProcessingFargateService service.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ECS.Patterns
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class QueueProcessingFargateServiceProps : Object, IQueueProcessingFargateServiceProps, IQueueProcessingServiceBaseProps, IFargateServiceBaseProps
Syntax (vb)
Public Class QueueProcessingFargateServiceProps
Inherits Object
Implements IQueueProcessingFargateServiceProps, IQueueProcessingServiceBaseProps, IFargateServiceBaseProps
Remarks
ExampleMetadata: infused
Examples
Cluster cluster;
cluster.EnableFargateCapacityProviders();
var queueProcessingFargateService = new QueueProcessingFargateService(this, "Service", new QueueProcessingFargateServiceProps {
Cluster = cluster,
MemoryLimitMiB = 512,
Image = ContainerImage.FromRegistry("test"),
CapacityProviderStrategies = new [] { new CapacityProviderStrategy {
CapacityProvider = "FARGATE_SPOT",
Weight = 2
}, new CapacityProviderStrategy {
CapacityProvider = "FARGATE",
Weight = 1
} }
});
Synopsis
Constructors
QueueProcessingFargateServiceProps() |
Properties
AssignPublicIp | Specifies whether the task's elastic network interface receives a public IP address. |
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. |
ContainerName | Optional name for the container added. |
Cooldown | Grace period after scaling activity in seconds. |
Cpu | The number of cpu units used by the task. |
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. |
EphemeralStorageGiB | The amount (in GiB) of ephemeral storage to be allocated to the task. |
Family | The name of a family that the task definition is registered to. |
HealthCheck | The health check command and associated configuration parameters for the container. |
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. |
MemoryLimitMiB | The amount (in MiB) of memory used by the task. |
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. |
PlatformVersion | The platform version on which to run your service. |
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. |
RuntimePlatform | The runtime platform of the task definition. |
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. |
SecurityGroups | The security groups to associate with the service. |
ServiceName | The name of the service. |
TaskDefinition | The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. |
TaskSubnets | The subnets to associate with 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
QueueProcessingFargateServiceProps()
public QueueProcessingFargateServiceProps()
Properties
AssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address.
public Nullable<bool> AssignPublicIp { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If true, each task will receive a public IP address.
Default: false
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.
ContainerName
Optional name for the container added.
public string ContainerName { get; set; }
Property Value
System.String
Remarks
This name is not used when taskDefinition
is provided.
Default: - QueueProcessingContainer
Cooldown
Grace period after scaling activity in seconds.
public Duration Cooldown { get; set; }
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
Cpu
The number of cpu units used by the task.
public Nullable<double> Cpu { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments
16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments
This default is set in the underlying FargateTaskDefinition construct.
Default: 256
CpuTargetUtilizationPercent
The target CPU utilization percentage for CPU based scaling strategy when enabled.
public Nullable<double> CpuTargetUtilizationPercent { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 50
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)
DisableCpuBasedScaling
Flag to disable CPU based auto scaling strategy on the service.
public Nullable<bool> DisableCpuBasedScaling { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false
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
EnableExecuteCommand
Whether ECS Exec should be enabled.
public Nullable<bool> EnableExecuteCommand { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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'
EphemeralStorageGiB
The amount (in GiB) of ephemeral storage to be allocated to the task.
public Nullable<double> EphemeralStorageGiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The minimum supported value is 21
GiB and the maximum supported value is 200
GiB.
Only supported in Fargate platform version 1.4.0 or later.
Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.
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.
HealthCheck
The health check command and associated configuration parameters for the container.
public IHealthCheck HealthCheck { get; set; }
Property Value
Remarks
Default: - Health check configuration from container.
Image
The image used to start a container.
public ContainerImage Image { get; set; }
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.
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.
If the queue construct is specified, maxReceiveCount should be omitted.
Default: 3
MaxScalingCapacity
Maximum capacity to scale to.
public Nullable<double> MaxScalingCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 2
MemoryLimitMiB
The amount (in MiB) of memory used by the task.
public Nullable<double> MemoryLimitMiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)
Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
This default is set in the underlying FargateTaskDefinition construct.
Default: 512
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: 1
PlatformVersion
The platform version on which to run your service.
public Nullable<FargatePlatformVersion> PlatformVersion { get; set; }
Property Value
System.Nullable<FargatePlatformVersion>
Remarks
If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Default: Latest
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
If the queue construct is specified, retentionPeriod should be omitted.
Default: Duration.days(14)
RuntimePlatform
The runtime platform of the task definition.
public IRuntimePlatform RuntimePlatform { get; set; }
Property Value
Remarks
Default: - If the property is undefined, operatingSystemFamily
is LINUX and cpuArchitecture
is X86_64
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.
SecurityGroups
The security groups to associate with the service.
public ISecurityGroup[] SecurityGroups { get; set; }
Property Value
Remarks
If you do not specify a security group, a new security group is created.
Default: - A new security group is created.
ServiceName
The name of the service.
public string ServiceName { get; set; }
Property Value
System.String
Remarks
Default: - CloudFormation-generated name.
TaskDefinition
The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
public FargateTaskDefinition TaskDefinition { get; set; }
Property Value
Remarks
[disable-awslint:ref-via-interface]
Default: - none
TaskSubnets
The subnets to associate with the service.
public ISubnetSelection TaskSubnets { get; set; }
Property Value
Remarks
Default: - Public subnets if assignPublicIp
is set, otherwise the first available one of Private, Isolated, Public, in that order.
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).
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.
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.