Class SqsManager

Provides operations on AWS Simple Queue Service.

A new instance of this class is injected into CommonConstruct constructor.
If a custom construct extends CommonConstruct, an instance is available within the context.

Example

import { CommonConstruct } from '@gradientedge/cdk-utils'

class CustomConstruct extends CommonConstruct {
  constructor(parent: Construct, id: string, props: common.CommonStackProps) {
    super(parent, id, props)
    this.props = props
    this.sqsManager.createQueue('MySqs', this, {...})
  }
}

See

[CDK Simple Queue Service Module]https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html

Index

Constructors

constructor

Methods

createDeadLetterQueueForLambda createQueue createRedriveQueueForLambda

Constructors

constructor

new SqsManager(): SqsManager
Returns SqsManager

Methods

createDeadLetterQueueForLambda

createDeadLetterQueueForLambda(
    id: string,
    scope: CommonConstruct,
    props: LambdaProps,
    deadLetterQueue: IQueue,
): Queue
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: LambdaProps
  the lambda properties
- deadLetterQueue: IQueue
Returns Queue
- Defined in packages/aws/src/services/simple-queue-service/main.ts:97

createQueue

createQueue(
    id: string,
    scope: CommonConstruct,
    props: QueueProps,
    deadLetterQueue?: IQueue,
): Queue
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: QueueProps
- OptionaldeadLetterQueue: IQueue
Returns Queue
- Defined in packages/aws/src/services/simple-queue-service/main.ts:36

createRedriveQueueForLambda

createRedriveQueueForLambda(
    id: string,
    scope: CommonConstruct,
    props: LambdaProps,
): Queue
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: LambdaProps
  the lambda properties
Returns Queue
- Defined in packages/aws/src/services/simple-queue-service/main.ts:83

Class SqsManager

Example

See

Index

Constructors

Methods

Constructors

constructor

Returns SqsManager

Methods

createDeadLetterQueueForLambda

Parameters

Returns Queue

createQueue

Parameters

Returns Queue

createRedriveQueueForLambda

Parameters

Returns Queue

Settings

On This Page