# QueueBase

Reference to a new or existing Amazon SQS queue.

Extends: Construct › Resource › QueueBase
Implements: IResource, IEncryptedResource, IQueue, IEnvironmentAware, IQueueRef, IConstruct, IDependable
Superclass of: Queue

- 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#L127)
- Type last changed: v2.267.0 · 27 Aug 2026

## Initializer

```ts
new QueueBase(scope: Construct, id: string, props?: ResourceProps)
```

## Construct Props

- `account`: string — The AWS account ID this resource belongs to.

  **Default:** the resource is in the same account as the stack it belongs to

- `environmentFromArn`: string — ARN to deduce region and account from.

  **Default:** take environment from `account`, `region` parameters, or use Stack environment.

  The ARN is parsed and the account and region are taken from the ARN.
  This should be used for imported resources.

  Cannot be supplied together with either `account` or `region`.

- `physicalName`: string — The value passed in by users to the physical name prop of the resource.

  **Default:** The physical name will be allocated by CloudFormation at deployment time

  - `undefined` implies that a physical name will be allocated by
    CloudFormation during deployment.
  - a concrete value implies a specific physical name
  - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
    by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

- `region`: string — The AWS region this resource belongs to.

  **Default:** the resource is in the same region as the stack it belongs to

## 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.

- `grants`: [QueueGrants](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueGrants.html) (required) — Collection of grant methods for a 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.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `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, ...actions: string[]): Grant` — Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — Principal to grant right to.
  - `actions` — 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

  If encryption is used, permission to use the key to decrypt the contents of the queue will also be granted to the same principal.

  This will grant the following KMS permissions:

    - kms:Decrypt

  The use of this method is discouraged. Please use `grants.consumeMessages()` instead.

  [disable-awslint:no-grants]

  **Parameters**

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

- `grantOnKey(grantee: IGrantable, ...actions: string[]): GrantOnKeyResult` — Gives permissions to a grantable entity to perform actions on the encryption key.

- `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

  The use of this method is discouraged. Please use `grants.purge()` instead.

  [disable-awslint:no-grants]

  **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

  If encryption is used, permission to use the key to encrypt/decrypt the contents of the queue will also be granted to the same principal.

  This will grant the following KMS permissions:

   - kms:Decrypt
   - kms:Encrypt
   - kms:ReEncrypt*
   - kms:GenerateDataKey*

  The use of this method is discouraged. Please use `grants.sendMessages()` instead.

  [disable-awslint:no-grants]

  **Parameters**

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

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `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

- `toString(): string` — Returns a string representation of this construct.

- `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.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.