Class SqsQueueProps
Customize the SQS Queue Event Target.
Inheritance
Namespace: Amazon.CDK.AWS.Events.Targets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SqsQueueProps : Object, ISqsQueueProps, ITargetBaseProps
Syntax (vb)
Public Class SqsQueueProps
Inherits Object
Implements ISqsQueueProps, ITargetBaseProps
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.Events;
using Amazon.CDK.AWS.Events.Targets;
using Amazon.CDK.AWS.SQS;
Queue queue;
RuleTargetInput ruleTargetInput;
var sqsQueueProps = new SqsQueueProps {
DeadLetterQueue = queue,
MaxEventAge = Duration.Minutes(30),
Message = ruleTargetInput,
MessageGroupId = "messageGroupId",
RetryAttempts = 123
};
Synopsis
Constructors
SqsQueueProps() |
Properties
DeadLetterQueue | The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. |
MaxEventAge | The maximum age of a request that Lambda sends to a function for processing. |
Message | The message to send to the queue. |
MessageGroupId | Message Group ID for messages sent to this queue. |
RetryAttempts | The maximum number of times to retry when the function returns an error. |
Constructors
SqsQueueProps()
public SqsQueueProps()
Properties
DeadLetterQueue
The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.
public IQueue DeadLetterQueue { get; set; }
Property Value
Remarks
The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.
Default: - no dead-letter queue
MaxEventAge
The maximum age of a request that Lambda sends to a function for processing.
public Duration MaxEventAge { get; set; }
Property Value
Remarks
Minimum value of 60. Maximum value of 86400.
Default: Duration.hours(24)
Message
The message to send to the queue.
public RuleTargetInput Message { get; set; }
Property Value
Remarks
Must be a valid JSON text passed to the target queue.
Default: the entire EventBridge event
MessageGroupId
Message Group ID for messages sent to this queue.
public string MessageGroupId { get; set; }
Property Value
System.String
Remarks
Required for FIFO queues, leave empty for regular queues.
Default: - no message group ID (regular queue)
RetryAttempts
The maximum number of times to retry when the function returns an error.
public Nullable<double> RetryAttempts { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Minimum value of 0. Maximum value of 185.
Default: 185