@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:52.290Z") public interface IQueue extends IResource
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.
|
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.
|
applyRemovalPolicy, getEnv, getStack
getNode
java.lang.Boolean getFifo()
If false, this is a standard queue.
java.lang.String getQueueArn()
java.lang.String getQueueName()
java.lang.String getQueueUrl()
default IKey getEncryptionMasterKey()
AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)
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.
statement
- This parameter is required.Grant grant(IGrantable grantee, java.lang.String... queueActions)
grantee
- Principal to grant right to. This parameter is required.queueActions
- The actions to grant. This parameter is required.Grant grantConsumeMessages(IGrantable grantee)
This will grant the following permissions:
grantee
- Principal to grant consume rights to. This parameter is required.Grant grantPurge(IGrantable grantee)
This will grant the following permissions:
grantee
- Principal to grant send rights to. This parameter is required.Grant grantSendMessages(IGrantable grantee)
This will grant the following permissions:
grantee
- Principal to grant send rights to. This parameter is required.Metric metric(java.lang.String metricName, MetricOptions props)
metricName
- This parameter is required.props
- Metric metric(java.lang.String metricName)
metricName
- This parameter is required.Metric metricApproximateAgeOfOldestMessage(MetricOptions props)
Maximum over 5 minutes
props
- Metric metricApproximateAgeOfOldestMessage()
Maximum over 5 minutes
Metric metricApproximateNumberOfMessagesDelayed(MetricOptions props)
Maximum over 5 minutes
props
- Metric metricApproximateNumberOfMessagesDelayed()
Maximum over 5 minutes
Metric metricApproximateNumberOfMessagesNotVisible(MetricOptions props)
Maximum over 5 minutes
props
- Metric metricApproximateNumberOfMessagesNotVisible()
Maximum over 5 minutes
Metric metricApproximateNumberOfMessagesVisible(MetricOptions props)
Maximum over 5 minutes
props
- Metric metricApproximateNumberOfMessagesVisible()
Maximum over 5 minutes
Metric metricNumberOfEmptyReceives(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfEmptyReceives()
Sum over 5 minutes
Metric metricNumberOfMessagesDeleted(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfMessagesDeleted()
Sum over 5 minutes
Metric metricNumberOfMessagesReceived(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfMessagesReceived()
Sum over 5 minutes
Metric metricNumberOfMessagesSent(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfMessagesSent()
Sum over 5 minutes
Metric metricSentMessageSize(MetricOptions props)
Average over 5 minutes
props
- Metric metricSentMessageSize()
Average over 5 minutes