Skip to content

API.md

Latest commit

 

History

History
217 lines (129 loc) · 6.84 KB

API.md

File metadata and controls

217 lines (129 loc) · 6.84 KB

API Reference

Constructs

SqsWithDlq

Initializers 

import { SqsWithDlq } from '@serverless-guru/cdk-utils'

new SqsWithDlq(scope: Construct, id: string, props: SqsWithDlqProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props SqsWithDlqProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { SqsWithDlq } from '@serverless-guru/cdk-utils'

SqsWithDlq.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
deadLetterQueue aws-cdk-lib.aws_sqs.Queue The dead letter queue.
messageAgeAlarm aws-cdk-lib.aws_cloudwatch.Alarm Alarm indicating there are messages that will expire within 3 days in the DLQ.
messagesVisibleAlarm aws-cdk-lib.aws_cloudwatch.Alarm Alarm indicating there are messages in the DLQ.
queue aws-cdk-lib.aws_sqs.Queue The main queue.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

deadLetterQueueRequired 
public readonly deadLetterQueue: Queue;
  • Type: aws-cdk-lib.aws_sqs.Queue

The dead letter queue.

messageAgeAlarmRequired 
public readonly messageAgeAlarm: Alarm;
  • Type: aws-cdk-lib.aws_cloudwatch.Alarm

Alarm indicating there are messages that will expire within 3 days in the DLQ.

messagesVisibleAlarmRequired 
public readonly messagesVisibleAlarm: Alarm;
  • Type: aws-cdk-lib.aws_cloudwatch.Alarm

Alarm indicating there are messages in the DLQ.

queueRequired 
public readonly queue: Queue;
  • Type: aws-cdk-lib.aws_sqs.Queue

The main queue.

Structs

SqsWithDlqProps

Initializer 

import { SqsWithDlqProps } from '@serverless-guru/cdk-utils'

const sqsWithDlqProps: SqsWithDlqProps = { ... }

Properties

Name Type Description
alarmTopicArn string The SNS topic to send alarm notifications to.
fifo boolean Whether the queues should be FIFO queues.
messageRetentionPeriod aws-cdk-lib.Duration The number of days messages will be retained in the queues.
alarmTopicArnRequired 
public readonly alarmTopicArn: string;
  • Type: string

The SNS topic to send alarm notifications to.

fifoOptional 
public readonly fifo: boolean;
  • Type: boolean
  • Default: false

Whether the queues should be FIFO queues.

messageRetentionPeriodOptional 
public readonly messageRetentionPeriod: Duration;
  • Type: aws-cdk-lib.Duration
  • Default: Duration.days(14)

The number of days messages will be retained in the queues.