Protected ReadonlyautoControls automatic creation of policy objects.
Set by subclasses.
Optional ReadonlydeadIf this queue is configured with a dead-letter queue, this is the dead-letter queue settings.
Optional ReadonlyencryptionIf this queue is encrypted, this is the KMS key.
Optional ReadonlyencryptionWhether the contents of the queue are encrypted, and by what type of key.
ReadonlyenvThe environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
ReadonlyfifoWhether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.
ReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationReadonlyqueueThe ARN of this queue
ReadonlyqueueThe name of this queue
ReadonlyqueueThe URL of this queue
ReadonlystackThe stack in which this resource is defined.
Static ReadonlyPROPERTY_Uniquely identifies this class.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
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.
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).
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.
Principal to grant right to
The actions to grant
Grant permissions to consume messages from a queue
This will grant the following permissions:
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:
Principal to grant consume rights to
Grant an IAM principal permissions to purge all messages from the queue.
This will grant the following permissions:
Principal to grant send rights to
Grant access to send messages to a queue to the given identity.
This will grant the following permissions:
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:
Principal to grant send rights to
Return the given named metric for this Queue
Optionalprops: MetricOptionsThe approximate age of the oldest non-deleted message in the queue.
Maximum over 5 minutes
Optionalprops: MetricOptionsThe number of messages in the queue that are delayed and not available for reading immediately.
Maximum over 5 minutes
Optionalprops: MetricOptionsThe number of messages that are in flight.
Maximum over 5 minutes
Optionalprops: MetricOptionsThe number of messages available for retrieval from the queue.
Maximum over 5 minutes
Optionalprops: MetricOptionsThe number of ReceiveMessage API calls that did not return a message.
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages deleted from the queue.
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages returned by calls to the ReceiveMessage action.
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages added to a queue.
Sum over 5 minutes
Optionalprops: MetricOptionsThe size of messages added to a queue.
Average over 5 minutes
Optionalprops: MetricOptionsReturns a string representation of this construct.
StaticfromImport an existing SQS queue provided an ARN
The parent creating construct
The construct's name
queue ARN (i.e. arn:aws:sqs:us-east-2:444455556666:queue1)
StaticfromImport an existing queue
StaticisChecks 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.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
A construct for a complaince SQS queue which is suitable for use as a DeadLetterQueue. Specifically, we suppress the Nag which requires a Queue to have a DLQ.