Interface IQueue.Jsii$Default
- All Superinterfaces:
IConstruct
,software.constructs.IConstruct
,IConstruct.Jsii$Default
,software.constructs.IConstruct.Jsii$Default
,IDependable
,IDependable.Jsii$Default
,IQueue
,IResource
,IResource.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IQueue.Jsii$Proxy
- Enclosing interface:
- IQueue
IQueue
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sqs.IQueue
IQueue.Jsii$Default, IQueue.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddToResourcePolicyResult
addToResourcePolicy
(PolicyStatement statement) Adds a statement to the IAM resource policy associated with this queue.default void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default IKey
If this queue is server-side encrypted, this is the KMS encryption key.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default Boolean
getFifo()
Whether this queue is an Amazon SQS FIFO queue.default ConstructNode
getNode()
The construct tree node for this construct.default String
The ARN of this queue.default String
The name of this queue.default String
The URL of this queue.default Stack
getStack()
The stack in which this resource is defined.default Grant
grant
(IGrantable grantee, @NotNull String... queueActions) Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.default Grant
grantConsumeMessages
(IGrantable grantee) Grant permissions to consume messages from a queue.default Grant
grantPurge
(IGrantable grantee) Grant an IAM principal permissions to purge all messages from the queue.default Grant
grantSendMessages
(IGrantable grantee) Grant access to send messages to a queue to the given identity.default Metric
metric
(String metricName, MetricOptions props) Return the given named metric for this Queue.default Metric
The approximate age of the oldest non-deleted message in the queue.default Metric
The number of messages in the queue that are delayed and not available for reading immediately.default Metric
The number of messages that are in flight.default Metric
The number of messages available for retrieval from the queue.default Metric
The number of ReceiveMessage API calls that did not return a message.default Metric
The number of messages deleted from the queue.default Metric
The number of messages returned by calls to the ReceiveMessage action.default Metric
The number of messages added to a queue.default Metric
The size of messages added to a queue.Methods inherited from interface software.amazon.awscdk.services.sqs.IQueue
metric, metricApproximateAgeOfOldestMessage, metricApproximateNumberOfMessagesDelayed, metricApproximateNumberOfMessagesNotVisible, metricApproximateNumberOfMessagesVisible, metricNumberOfEmptyReceives, metricNumberOfMessagesDeleted, metricNumberOfMessagesReceived, metricNumberOfMessagesSent, metricSentMessageSize
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
The construct tree node for this construct.- Specified by:
getNode
in interfaceIConstruct
- Specified by:
getNode
in interfaceIConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
The 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.
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getFifo
Whether this queue is an Amazon SQS FIFO queue.If false, this is a standard queue.
-
getQueueArn
The ARN of this queue.- Specified by:
getQueueArn
in interfaceIQueue
-
getQueueName
The name of this queue.- Specified by:
getQueueName
in interfaceIQueue
-
getQueueUrl
The URL of this queue.- Specified by:
getQueueUrl
in interfaceIQueue
-
getEncryptionMasterKey
If this queue is server-side encrypted, this is the KMS encryption key.- Specified by:
getEncryptionMasterKey
in interfaceIQueue
-
applyRemovalPolicy
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
).- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addToResourcePolicy
@Stability(Stable) @NotNull default AddToResourcePolicyResult addToResourcePolicy(@NotNull 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 toaddToPolicy
. If the queue is imported (Queue.import
), then this is a no-op.- Specified by:
addToResourcePolicy
in interfaceIQueue
- Parameters:
statement
- This parameter is required.
-
grant
@Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... queueActions) Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource. -
grantConsumeMessages
Grant permissions to consume messages from a queue.This will grant the following permissions:
- sqs:ChangeMessageVisibility
- sqs:DeleteMessage
- sqs:ReceiveMessage
- sqs:GetQueueAttributes
- sqs:GetQueueUrl
- Specified by:
grantConsumeMessages
in interfaceIQueue
- Parameters:
grantee
- Principal to grant consume rights to. This parameter is required.
-
grantPurge
Grant an IAM principal permissions to purge all messages from the queue.This will grant the following permissions:
- sqs:PurgeQueue
- sqs:GetQueueAttributes
- sqs:GetQueueUrl
- Specified by:
grantPurge
in interfaceIQueue
- Parameters:
grantee
- Principal to grant send rights to. This parameter is required.
-
grantSendMessages
Grant access to send messages to a queue to the given identity.This will grant the following permissions:
- sqs:SendMessage
- sqs:GetQueueAttributes
- sqs:GetQueueUrl
- Specified by:
grantSendMessages
in interfaceIQueue
- Parameters:
grantee
- Principal to grant send rights to. This parameter is required.
-
metric
@Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this Queue. -
metricApproximateAgeOfOldestMessage
@Stability(Stable) @NotNull default Metric metricApproximateAgeOfOldestMessage(@Nullable MetricOptions props) The approximate age of the oldest non-deleted message in the queue.Maximum over 5 minutes
- Specified by:
metricApproximateAgeOfOldestMessage
in interfaceIQueue
- Parameters:
props
-
-
metricApproximateNumberOfMessagesDelayed
@Stability(Stable) @NotNull default Metric metricApproximateNumberOfMessagesDelayed(@Nullable MetricOptions props) The number of messages in the queue that are delayed and not available for reading immediately.Maximum over 5 minutes
- Specified by:
metricApproximateNumberOfMessagesDelayed
in interfaceIQueue
- Parameters:
props
-
-
metricApproximateNumberOfMessagesNotVisible
@Stability(Stable) @NotNull default Metric metricApproximateNumberOfMessagesNotVisible(@Nullable MetricOptions props) The number of messages that are in flight.Maximum over 5 minutes
- Specified by:
metricApproximateNumberOfMessagesNotVisible
in interfaceIQueue
- Parameters:
props
-
-
metricApproximateNumberOfMessagesVisible
@Stability(Stable) @NotNull default Metric metricApproximateNumberOfMessagesVisible(@Nullable MetricOptions props) The number of messages available for retrieval from the queue.Maximum over 5 minutes
- Specified by:
metricApproximateNumberOfMessagesVisible
in interfaceIQueue
- Parameters:
props
-
-
metricNumberOfEmptyReceives
@Stability(Stable) @NotNull default Metric metricNumberOfEmptyReceives(@Nullable MetricOptions props) The number of ReceiveMessage API calls that did not return a message.Sum over 5 minutes
- Specified by:
metricNumberOfEmptyReceives
in interfaceIQueue
- Parameters:
props
-
-
metricNumberOfMessagesDeleted
@Stability(Stable) @NotNull default Metric metricNumberOfMessagesDeleted(@Nullable MetricOptions props) The number of messages deleted from the queue.Sum over 5 minutes
- Specified by:
metricNumberOfMessagesDeleted
in interfaceIQueue
- Parameters:
props
-
-
metricNumberOfMessagesReceived
@Stability(Stable) @NotNull default Metric metricNumberOfMessagesReceived(@Nullable MetricOptions props) The number of messages returned by calls to the ReceiveMessage action.Sum over 5 minutes
- Specified by:
metricNumberOfMessagesReceived
in interfaceIQueue
- Parameters:
props
-
-
metricNumberOfMessagesSent
@Stability(Stable) @NotNull default Metric metricNumberOfMessagesSent(@Nullable MetricOptions props) The number of messages added to a queue.Sum over 5 minutes
- Specified by:
metricNumberOfMessagesSent
in interfaceIQueue
- Parameters:
props
-
-
metricSentMessageSize
The size of messages added to a queue.Average over 5 minutes
- Specified by:
metricSentMessageSize
in interfaceIQueue
- Parameters:
props
-
-