# IQueue

Represents an SQS queue.

Extends: IQueue
Extends: IResource, IQueueRef
Implemented by: Queue, QueueBase

- Source: [`aws-sqs/lib/queue-base.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-sqs/lib/queue-base.ts#L15)
- Type last changed: v2.267.0 · 27 Aug 2026

## Properties

- `encryptionMasterKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — If this queue is server-side encrypted, this is the KMS encryption key.

- `encryptionType`: [QueueEncryption](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueEncryption.html) — Whether the contents of the queue are encrypted, and by what type of key.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `fifo`: boolean (required) — Whether this queue is an Amazon SQS FIFO queue.

  If false, this is a standard queue.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `queueArn`: string (required) — The ARN of this queue.

- `queueName`: string (required) — The name of this queue.

- `queueRef`: [QueueReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_sqs.QueueReference.html) (required) — A reference to a Queue resource.

- `queueUrl`: string (required) — The URL of this queue.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult` — Adds a statement to the IAM resource policy associated with this queue.

  If this queue was created in this stack (`new Queue`), a queue policy
  will be automatically created upon the first call to `addToPolicy`. If
  the queue is imported (`Queue.import`), then this is a no-op.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `grant(grantee: IGrantable, ...queueActions: string[]): Grant` — Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.

  **Parameters**

  - `grantee` — Principal to grant right to.
  - `queueActions` — The actions to grant.

- `grantConsumeMessages(grantee: IGrantable): Grant` — Grant permissions to consume messages from a queue.

  This will grant the following permissions:

    - sqs:ChangeMessageVisibility
    - sqs:DeleteMessage
    - sqs:ReceiveMessage
    - sqs:GetQueueAttributes
    - sqs:GetQueueUrl

  **Parameters**

  - `grantee` — Principal to grant consume rights to.

- `grantPurge(grantee: IGrantable): Grant` — Grant an IAM principal permissions to purge all messages from the queue.

  This will grant the following permissions:

   - sqs:PurgeQueue
   - sqs:GetQueueAttributes
   - sqs:GetQueueUrl

  **Parameters**

  - `grantee` — Principal to grant send rights to.

- `grantSendMessages(grantee: IGrantable): Grant` — Grant access to send messages to a queue to the given identity.

  This will grant the following permissions:

   - sqs:SendMessage
   - sqs:GetQueueAttributes
   - sqs:GetQueueUrl

  **Parameters**

  - `grantee` — Principal to grant send rights to.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this Queue.

- `metricApproximateAgeOfOldestMessage(props?: MetricOptions): Metric` — The approximate age of the oldest non-deleted message in the queue.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesDelayed(props?: MetricOptions): Metric` — The number of messages in the queue that are delayed and not available for reading immediately.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesNotVisible(props?: MetricOptions): Metric` — The number of messages that are in flight.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesOutstanding(props?: MetricOptions): MathExpression` — The number of messages waiting to be picked up plus the number in flight.

  `ApproximateNumberOfMessagesVisible + ApproximateNumberOfMessagesNotVisible`, as a metric math
  expression. Prefer this over `metricApproximateNumberOfMessagesVisible` when scaling consumers
  in: receiving a message lowers `Visible`, so a policy watching only `Visible` cannot tell a
  consumer that just picked up work from one that finished it.

  `statistic`, `unit` and dimensions apply to both underlying metrics, `label`, `color` and
  `period` to the expression.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesVisible(props?: MetricOptions): Metric` — The number of messages available for retrieval from the queue.

  Maximum over 5 minutes

- `metricNumberOfEmptyReceives(props?: MetricOptions): Metric` — The number of ReceiveMessage API calls that did not return a message.

  Sum over 5 minutes

- `metricNumberOfMessagesDeleted(props?: MetricOptions): Metric` — The number of messages deleted from the queue.

  Sum over 5 minutes

- `metricNumberOfMessagesReceived(props?: MetricOptions): Metric` — The number of messages returned by calls to the ReceiveMessage action.

  Sum over 5 minutes

- `metricNumberOfMessagesSent(props?: MetricOptions): Metric` — The number of messages added to a queue.

  Sum over 5 minutes

- `metricSentMessageSize(props?: MetricOptions): Metric` — The size of messages added to a queue.

  Average over 5 minutes

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining