UNPKG

4.69 kBTypeScriptView Raw
1import * as cloudwatch from '@aws-cdk/aws-cloudwatch';
2declare module "./queue-base" {
3 interface IQueue {
4 /**
5 * Return the given named metric for this Queue
6 */
7 metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
8 /**
9 * The approximate age of the oldest non-deleted message in the queue.
10 *
11 * Maximum over 5 minutes
12 */
13 metricApproximateAgeOfOldestMessage(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
14 /**
15 * The number of messages in the queue that are delayed and not available for reading immediately.
16 *
17 * Maximum over 5 minutes
18 */
19 metricApproximateNumberOfMessagesDelayed(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
20 /**
21 * The number of messages that are in flight.
22 *
23 * Maximum over 5 minutes
24 */
25 metricApproximateNumberOfMessagesNotVisible(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
26 /**
27 * The number of messages available for retrieval from the queue.
28 *
29 * Maximum over 5 minutes
30 */
31 metricApproximateNumberOfMessagesVisible(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
32 /**
33 * The number of ReceiveMessage API calls that did not return a message.
34 *
35 * Sum over 5 minutes
36 */
37 metricNumberOfEmptyReceives(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
38 /**
39 * The number of messages deleted from the queue.
40 *
41 * Sum over 5 minutes
42 */
43 metricNumberOfMessagesDeleted(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
44 /**
45 * The number of messages returned by calls to the ReceiveMessage action.
46 *
47 * Sum over 5 minutes
48 */
49 metricNumberOfMessagesReceived(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
50 /**
51 * The number of messages added to a queue.
52 *
53 * Sum over 5 minutes
54 */
55 metricNumberOfMessagesSent(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
56 /**
57 * The size of messages added to a queue.
58 *
59 * Average over 5 minutes
60 */
61 metricSentMessageSize(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
62 }
63 interface QueueBase {
64 /**
65 * Return the given named metric for this Queue
66 */
67 metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
68 /**
69 * The approximate age of the oldest non-deleted message in the queue.
70 *
71 * Maximum over 5 minutes
72 */
73 metricApproximateAgeOfOldestMessage(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
74 /**
75 * The number of messages in the queue that are delayed and not available for reading immediately.
76 *
77 * Maximum over 5 minutes
78 */
79 metricApproximateNumberOfMessagesDelayed(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
80 /**
81 * The number of messages that are in flight.
82 *
83 * Maximum over 5 minutes
84 */
85 metricApproximateNumberOfMessagesNotVisible(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
86 /**
87 * The number of messages available for retrieval from the queue.
88 *
89 * Maximum over 5 minutes
90 */
91 metricApproximateNumberOfMessagesVisible(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
92 /**
93 * The number of ReceiveMessage API calls that did not return a message.
94 *
95 * Sum over 5 minutes
96 */
97 metricNumberOfEmptyReceives(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
98 /**
99 * The number of messages deleted from the queue.
100 *
101 * Sum over 5 minutes
102 */
103 metricNumberOfMessagesDeleted(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
104 /**
105 * The number of messages returned by calls to the ReceiveMessage action.
106 *
107 * Sum over 5 minutes
108 */
109 metricNumberOfMessagesReceived(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
110 /**
111 * The number of messages added to a queue.
112 *
113 * Sum over 5 minutes
114 */
115 metricNumberOfMessagesSent(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
116 /**
117 * The size of messages added to a queue.
118 *
119 * Average over 5 minutes
120 */
121 metricSentMessageSize(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
122 }
123}