IQueue

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IQueue.Jsii$Default

All Known Implementing Classes:

IQueue.Jsii$Proxy, Queue, QueueBase
```
@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.290Z")
public interface IQueue
extends IResource
```
Represents an SQS queue.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IQueue.Jsii$Default` Internal default implementation for `IQueue`.
`static class`	`IQueue.Jsii$Proxy` A proxy class which represents a concrete javascript instance of this type.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`AddToResourcePolicyResult`	`addToResourcePolicy(PolicyStatement statement)` Adds a statement to the IAM resource policy associated with this queue.
`default IKey`	`getEncryptionMasterKey()` If this queue is server-side encrypted, this is the KMS encryption key.
`java.lang.Boolean`	`getFifo()` Whether this queue is an Amazon SQS FIFO queue.
`java.lang.String`	`getQueueArn()` The ARN of this queue.
`java.lang.String`	`getQueueName()` The name of this queue.
`java.lang.String`	`getQueueUrl()` The URL of this queue.
`Grant`	`grant(IGrantable grantee, java.lang.String... queueActions)` Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.
`Grant`	`grantConsumeMessages(IGrantable grantee)` Grant permissions to consume messages from a queue.
`Grant`	`grantPurge(IGrantable grantee)` Grant an IAM principal permissions to purge all messages from the queue.
`Grant`	`grantSendMessages(IGrantable grantee)` Grant access to send messages to a queue to the given identity.
`Metric`	`metric(java.lang.String metricName)` Return the given named metric for this Queue.
`Metric`	`metric(java.lang.String metricName, MetricOptions props)` Return the given named metric for this Queue.
`Metric`	`metricApproximateAgeOfOldestMessage()` The approximate age of the oldest non-deleted message in the queue.
`Metric`	`metricApproximateAgeOfOldestMessage(MetricOptions props)` The approximate age of the oldest non-deleted message in the queue.
`Metric`	`metricApproximateNumberOfMessagesDelayed()` The number of messages in the queue that are delayed and not available for reading immediately.
`Metric`	`metricApproximateNumberOfMessagesDelayed(MetricOptions props)` The number of messages in the queue that are delayed and not available for reading immediately.
`Metric`	`metricApproximateNumberOfMessagesNotVisible()` The number of messages that are in flight.
`Metric`	`metricApproximateNumberOfMessagesNotVisible(MetricOptions props)` The number of messages that are in flight.
`Metric`	`metricApproximateNumberOfMessagesVisible()` The number of messages available for retrieval from the queue.
`Metric`	`metricApproximateNumberOfMessagesVisible(MetricOptions props)` The number of messages available for retrieval from the queue.
`Metric`	`metricNumberOfEmptyReceives()` The number of ReceiveMessage API calls that did not return a message.
`Metric`	`metricNumberOfEmptyReceives(MetricOptions props)` The number of ReceiveMessage API calls that did not return a message.
`Metric`	`metricNumberOfMessagesDeleted()` The number of messages deleted from the queue.
`Metric`	`metricNumberOfMessagesDeleted(MetricOptions props)` The number of messages deleted from the queue.
`Metric`	`metricNumberOfMessagesReceived()` The number of messages returned by calls to the ReceiveMessage action.
`Metric`	`metricNumberOfMessagesReceived(MetricOptions props)` The number of messages returned by calls to the ReceiveMessage action.
`Metric`	`metricNumberOfMessagesSent()` The number of messages added to a queue.
`Metric`	`metricNumberOfMessagesSent(MetricOptions props)` The number of messages added to a queue.
`Metric`	`metricSentMessageSize()` The size of messages added to a queue.
`Metric`	`metricSentMessageSize(MetricOptions props)` The size of messages added to a queue.

Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode

- Method Detail
  - getFifo
```
java.lang.Boolean getFifo()
```
    Whether this queue is an Amazon SQS FIFO queue.
    If false, this is a standard queue.
  - getQueueArn
```
java.lang.String getQueueArn()
```
    The ARN of this queue.
  - getQueueName
```
java.lang.String getQueueName()
```
    The name of this queue.
  - getQueueUrl
```
java.lang.String getQueueUrl()
```
    The URL of this queue.
  - getEncryptionMasterKey
```
default IKey getEncryptionMasterKey()
```
    If this queue is server-side encrypted, this is the KMS encryption key.
  - addToResourcePolicy
```
AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)
```
    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.
    
    Parameters:
    
    statement - This parameter is required.
  - grant
```
Grant grant(IGrantable grantee,
            java.lang.String... queueActions)
```
    Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.
    
    Parameters:
    
    grantee - Principal to grant right to. This parameter is required.
    
    queueActions - The actions to grant. This parameter is required.
  - grantConsumeMessages
```
Grant grantConsumeMessages(IGrantable grantee)
```
    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. This parameter is required.
  - grantPurge
```
Grant grantPurge(IGrantable grantee)
```
    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. This parameter is required.
  - grantSendMessages
```
Grant grantSendMessages(IGrantable grantee)
```
    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. This parameter is required.
  - metric
```
Metric metric(java.lang.String metricName,
              MetricOptions props)
```
    Return the given named metric for this Queue.
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
Metric metric(java.lang.String metricName)
```
    Return the given named metric for this Queue.
    
    Parameters:
    
    metricName - This parameter is required.
  - metricApproximateAgeOfOldestMessage
```
Metric metricApproximateAgeOfOldestMessage(MetricOptions props)
```
    The approximate age of the oldest non-deleted message in the queue.
    Maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricApproximateAgeOfOldestMessage
```
Metric metricApproximateAgeOfOldestMessage()
```
    The approximate age of the oldest non-deleted message in the queue.
    Maximum over 5 minutes
  - metricApproximateNumberOfMessagesDelayed
```
Metric metricApproximateNumberOfMessagesDelayed(MetricOptions props)
```
    The number of messages in the queue that are delayed and not available for reading immediately.
    Maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricApproximateNumberOfMessagesDelayed
```
Metric metricApproximateNumberOfMessagesDelayed()
```
    The number of messages in the queue that are delayed and not available for reading immediately.
    Maximum over 5 minutes
  - metricApproximateNumberOfMessagesNotVisible
```
Metric metricApproximateNumberOfMessagesNotVisible(MetricOptions props)
```
    The number of messages that are in flight.
    Maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricApproximateNumberOfMessagesNotVisible
```
Metric metricApproximateNumberOfMessagesNotVisible()
```
    The number of messages that are in flight.
    Maximum over 5 minutes
  - metricApproximateNumberOfMessagesVisible
```
Metric metricApproximateNumberOfMessagesVisible(MetricOptions props)
```
    The number of messages available for retrieval from the queue.
    Maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricApproximateNumberOfMessagesVisible
```
Metric metricApproximateNumberOfMessagesVisible()
```
    The number of messages available for retrieval from the queue.
    Maximum over 5 minutes
  - metricNumberOfEmptyReceives
```
Metric metricNumberOfEmptyReceives(MetricOptions props)
```
    The number of ReceiveMessage API calls that did not return a message.
    Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricNumberOfEmptyReceives
```
Metric metricNumberOfEmptyReceives()
```
    The number of ReceiveMessage API calls that did not return a message.
    Sum over 5 minutes
  - metricNumberOfMessagesDeleted
```
Metric metricNumberOfMessagesDeleted(MetricOptions props)
```
    The number of messages deleted from the queue.
    Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricNumberOfMessagesDeleted
```
Metric metricNumberOfMessagesDeleted()
```
    The number of messages deleted from the queue.
    Sum over 5 minutes
  - metricNumberOfMessagesReceived
```
Metric metricNumberOfMessagesReceived(MetricOptions props)
```
    The number of messages returned by calls to the ReceiveMessage action.
    Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricNumberOfMessagesReceived
```
Metric metricNumberOfMessagesReceived()
```
    The number of messages returned by calls to the ReceiveMessage action.
    Sum over 5 minutes
  - metricNumberOfMessagesSent
```
Metric metricNumberOfMessagesSent(MetricOptions props)
```
    The number of messages added to a queue.
    Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricNumberOfMessagesSent
```
Metric metricNumberOfMessagesSent()
```
    The number of messages added to a queue.
    Sum over 5 minutes
  - metricSentMessageSize
```
Metric metricSentMessageSize(MetricOptions props)
```
    The size of messages added to a queue.
    Average over 5 minutes
    
    Parameters:
    
    props -
  - metricSentMessageSize
```
Metric metricSentMessageSize()
```
    The size of messages added to a queue.
    Average over 5 minutes

Interface IQueue

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.awscdk.core.IResource

Methods inherited from interface software.amazon.awscdk.core.IConstruct

Method Detail

getFifo

getQueueArn

getQueueName

getQueueUrl

getEncryptionMasterKey

addToResourcePolicy

grant

grantConsumeMessages

grantPurge

grantSendMessages

metric

metric

metricApproximateAgeOfOldestMessage

metricApproximateAgeOfOldestMessage

metricApproximateNumberOfMessagesDelayed

metricApproximateNumberOfMessagesDelayed

metricApproximateNumberOfMessagesNotVisible

metricApproximateNumberOfMessagesNotVisible

metricApproximateNumberOfMessagesVisible

metricApproximateNumberOfMessagesVisible

metricNumberOfEmptyReceives

metricNumberOfEmptyReceives

metricNumberOfMessagesDeleted

metricNumberOfMessagesDeleted

metricNumberOfMessagesReceived

metricNumberOfMessagesReceived

metricNumberOfMessagesSent

metricNumberOfMessagesSent

metricSentMessageSize

metricSentMessageSize