stackup 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +12 -12
- data/README.md +38 -15
- data/bin/stackup +76 -34
- data/doc/Stackup/ErrorMappingProxy.html +378 -0
- data/doc/Stackup/InvalidStateError.html +142 -0
- data/doc/Stackup/NoSuchStack.html +142 -0
- data/doc/Stackup/NoUpdateRequired.html +134 -0
- data/doc/Stackup/Service.html +399 -0
- data/doc/Stackup/ServiceError.html +138 -0
- data/doc/Stackup/Stack.html +1269 -0
- data/doc/Stackup/StackUpdateError.html +142 -0
- data/doc/Stackup/StackWatcher.html +455 -0
- data/doc/Stackup.html +202 -0
- data/doc/_index.html +199 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +143 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +143 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +195 -0
- data/doc/top-level-namespace.html +194 -0
- data/lib/stackup/error_mapping_proxy.rb +37 -0
- data/lib/stackup/errors.rb +9 -6
- data/lib/stackup/service.rb +39 -0
- data/lib/stackup/stack.rb +52 -59
- data/lib/stackup/stack_watcher.rb +16 -10
- data/lib/stackup.rb +26 -0
- data/spec/spec_helper.rb +15 -1
- data/spec/stackup/stack_spec.rb +114 -48
- data/spec/stackup/stack_watcher_spec.rb +20 -15
- data/stackup.gemspec +1 -1
- data/woollyams/template.json +44 -0
- metadata +29 -6
- data/pkg/stackup-0.0.1.gem +0 -0
- data/pkg/stackup-0.0.8.gem +0 -0
- data/pkg/stackup-0.0.9.gem +0 -0
- data/woollyams/sample-template.json +0 -79
|
@@ -0,0 +1,1269 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Stackup::Stack
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '../';
|
|
20
|
+
framesUrl = "../frames.html#!Stackup/Stack.html";
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="../_index.html">Index (S)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../Stackup.html" title="Stackup (module)">Stackup</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Stack</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: Stackup::Stack
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Object</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Stackup::Stack</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
|
97
|
+
<dd class="r2 last">lib/stackup/stack.rb</dd>
|
|
98
|
+
|
|
99
|
+
</dl>
|
|
100
|
+
<div class="clear"></div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>An abstraction of a CloudFormation stack.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
<h2>Constant Summary</h2>
|
|
115
|
+
|
|
116
|
+
<dl class="constants">
|
|
117
|
+
|
|
118
|
+
<dt id="ALMOST_DEAD_STATUSES-constant" class="">ALMOST_DEAD_STATUSES =
|
|
119
|
+
|
|
120
|
+
</dt>
|
|
121
|
+
<dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>CREATE_FAILED</span><span class='words_sep'> </span><span class='tstring_content'>ROLLBACK_COMPLETE</span><span class='words_sep'>)</span></pre></dd>
|
|
122
|
+
|
|
123
|
+
</dl>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
130
|
+
<ul class="summary">
|
|
131
|
+
|
|
132
|
+
<li class="public ">
|
|
133
|
+
<span class="summary_signature">
|
|
134
|
+
|
|
135
|
+
<a href="#cf_client-instance_method" title="#cf_client (instance method)">- (Object) <strong>cf_client</strong> </a>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
</span>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<span class="note title readonly">readonly</span>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<span class="summary_desc"><div class='inline'>
|
|
155
|
+
<p>Returns the value of attribute cf_client.</p>
|
|
156
|
+
</div></span>
|
|
157
|
+
|
|
158
|
+
</li>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<li class="public ">
|
|
162
|
+
<span class="summary_signature">
|
|
163
|
+
|
|
164
|
+
<a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</span>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<span class="note title readonly">readonly</span>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<span class="summary_desc"><div class='inline'>
|
|
184
|
+
<p>Returns the value of attribute name.</p>
|
|
185
|
+
</div></span>
|
|
186
|
+
|
|
187
|
+
</li>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<li class="public ">
|
|
191
|
+
<span class="summary_signature">
|
|
192
|
+
|
|
193
|
+
<a href="#watcher-instance_method" title="#watcher (instance method)">- (Object) <strong>watcher</strong> </a>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
</span>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<span class="note title readonly">readonly</span>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span class="summary_desc"><div class='inline'>
|
|
213
|
+
<p>Returns the value of attribute watcher.</p>
|
|
214
|
+
</div></span>
|
|
215
|
+
|
|
216
|
+
</li>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
</ul>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<h2>
|
|
226
|
+
Instance Method Summary
|
|
227
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
228
|
+
</h2>
|
|
229
|
+
|
|
230
|
+
<ul class="summary">
|
|
231
|
+
|
|
232
|
+
<li class="public ">
|
|
233
|
+
<span class="summary_signature">
|
|
234
|
+
|
|
235
|
+
<a href="#cancel_update-instance_method" title="#cancel_update (instance method)">- (Symbol) <strong>cancel_update</strong> </a>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</span>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class="summary_desc"><div class='inline'>
|
|
250
|
+
<p>Cancel update in-progress.</p>
|
|
251
|
+
</div></span>
|
|
252
|
+
|
|
253
|
+
</li>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<li class="public ">
|
|
257
|
+
<span class="summary_signature">
|
|
258
|
+
|
|
259
|
+
<a href="#create_or_update-instance_method" title="#create_or_update (instance method)">- (Symbol) <strong>create_or_update</strong>(options) </a>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
(also: #up)
|
|
264
|
+
|
|
265
|
+
</span>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<span class="summary_desc"><div class='inline'>
|
|
276
|
+
<p>Create or update the stack.</p>
|
|
277
|
+
</div></span>
|
|
278
|
+
|
|
279
|
+
</li>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<li class="public ">
|
|
283
|
+
<span class="summary_signature">
|
|
284
|
+
|
|
285
|
+
<a href="#delete-instance_method" title="#delete (instance method)">- (Symbol) <strong>delete</strong> </a>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
(also: #down)
|
|
290
|
+
|
|
291
|
+
</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<span class="summary_desc"><div class='inline'>
|
|
302
|
+
<p>Delete the stack.</p>
|
|
303
|
+
</div></span>
|
|
304
|
+
|
|
305
|
+
</li>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<li class="public ">
|
|
309
|
+
<span class="summary_signature">
|
|
310
|
+
|
|
311
|
+
<a href="#exists%3F-instance_method" title="#exists? (instance method)">- (boolean) <strong>exists?</strong> </a>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
</span>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<span class="summary_desc"><div class='inline'>
|
|
326
|
+
<p>True iff the stack exists.</p>
|
|
327
|
+
</div></span>
|
|
328
|
+
|
|
329
|
+
</li>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<li class="public ">
|
|
333
|
+
<span class="summary_signature">
|
|
334
|
+
|
|
335
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Stack) <strong>initialize</strong>(name, client = {}, options = {}) </a>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
</span>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="note title constructor">constructor</span>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span class="summary_desc"><div class='inline'>
|
|
352
|
+
<p>A new instance of Stack.</p>
|
|
353
|
+
</div></span>
|
|
354
|
+
|
|
355
|
+
</li>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<li class="public ">
|
|
359
|
+
<span class="summary_signature">
|
|
360
|
+
|
|
361
|
+
<a href="#on_event-instance_method" title="#on_event (instance method)">- (Object) <strong>on_event</strong>(event_handler = nil, &block) </a>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
</span>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<span class="summary_desc"><div class='inline'>
|
|
376
|
+
<p>Register a handler for reporting of stack events.</p>
|
|
377
|
+
</div></span>
|
|
378
|
+
|
|
379
|
+
</li>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<li class="public ">
|
|
383
|
+
<span class="summary_signature">
|
|
384
|
+
|
|
385
|
+
<a href="#outputs-instance_method" title="#outputs (instance method)">- (Hash<String, String>) <strong>outputs</strong> </a>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</span>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<span class="summary_desc"><div class='inline'>
|
|
400
|
+
<p>Get stack outputs.</p>
|
|
401
|
+
</div></span>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<li class="public ">
|
|
407
|
+
<span class="summary_signature">
|
|
408
|
+
|
|
409
|
+
<a href="#status-instance_method" title="#status (instance method)">- (String) <strong>status</strong> </a>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<span class="summary_desc"><div class='inline'>
|
|
424
|
+
<p>The current stack status.</p>
|
|
425
|
+
</div></span>
|
|
426
|
+
|
|
427
|
+
</li>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</ul>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<div id="constructor_details" class="method_details_list">
|
|
434
|
+
<h2>Constructor Details</h2>
|
|
435
|
+
|
|
436
|
+
<div class="method_details first">
|
|
437
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
438
|
+
|
|
439
|
+
- (<tt><span class='object_link'><a href="" title="Stackup::Stack (class)">Stack</a></span></tt>) <strong>initialize</strong>(name, client = {}, options = {})
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
</h3><div class="docstring">
|
|
446
|
+
<div class="discussion">
|
|
447
|
+
|
|
448
|
+
<p>Returns a new instance of Stack</p>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</div>
|
|
452
|
+
</div>
|
|
453
|
+
<div class="tags">
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</div><table class="source_code">
|
|
457
|
+
<tr>
|
|
458
|
+
<td>
|
|
459
|
+
<pre class="lines">
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
12
|
|
463
|
+
13
|
|
464
|
+
14
|
|
465
|
+
15
|
|
466
|
+
16
|
|
467
|
+
17
|
|
468
|
+
18
|
|
469
|
+
19</pre>
|
|
470
|
+
</td>
|
|
471
|
+
<td>
|
|
472
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 12</span>
|
|
473
|
+
|
|
474
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
475
|
+
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Aws</span><span class='op'>::</span><span class='const'>CloudFormation</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
476
|
+
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
|
|
477
|
+
<span class='ivar'>@cf_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
478
|
+
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
479
|
+
<span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
480
|
+
<span class='kw'>end</span>
|
|
481
|
+
<span class='kw'>end</span></pre>
|
|
482
|
+
</td>
|
|
483
|
+
</tr>
|
|
484
|
+
</table>
|
|
485
|
+
</div>
|
|
486
|
+
|
|
487
|
+
</div>
|
|
488
|
+
|
|
489
|
+
<div id="instance_attr_details" class="attr_details">
|
|
490
|
+
<h2>Instance Attribute Details</h2>
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
<span id=""></span>
|
|
494
|
+
<div class="method_details first">
|
|
495
|
+
<h3 class="signature first" id="cf_client-instance_method">
|
|
496
|
+
|
|
497
|
+
- (<tt>Object</tt>) <strong>cf_client</strong> <span class="extras">(readonly)</span>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
</h3><div class="docstring">
|
|
504
|
+
<div class="discussion">
|
|
505
|
+
|
|
506
|
+
<p>Returns the value of attribute cf_client</p>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</div>
|
|
510
|
+
</div>
|
|
511
|
+
<div class="tags">
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
</div><table class="source_code">
|
|
515
|
+
<tr>
|
|
516
|
+
<td>
|
|
517
|
+
<pre class="lines">
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
21
|
|
521
|
+
22
|
|
522
|
+
23</pre>
|
|
523
|
+
</td>
|
|
524
|
+
<td>
|
|
525
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 21</span>
|
|
526
|
+
|
|
527
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_cf_client'>cf_client</span>
|
|
528
|
+
<span class='ivar'>@cf_client</span>
|
|
529
|
+
<span class='kw'>end</span></pre>
|
|
530
|
+
</td>
|
|
531
|
+
</tr>
|
|
532
|
+
</table>
|
|
533
|
+
</div>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
<span id=""></span>
|
|
537
|
+
<div class="method_details ">
|
|
538
|
+
<h3 class="signature " id="name-instance_method">
|
|
539
|
+
|
|
540
|
+
- (<tt>Object</tt>) <strong>name</strong> <span class="extras">(readonly)</span>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
</h3><div class="docstring">
|
|
547
|
+
<div class="discussion">
|
|
548
|
+
|
|
549
|
+
<p>Returns the value of attribute name</p>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</div>
|
|
553
|
+
</div>
|
|
554
|
+
<div class="tags">
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
</div><table class="source_code">
|
|
558
|
+
<tr>
|
|
559
|
+
<td>
|
|
560
|
+
<pre class="lines">
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
21
|
|
564
|
+
22
|
|
565
|
+
23</pre>
|
|
566
|
+
</td>
|
|
567
|
+
<td>
|
|
568
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 21</span>
|
|
569
|
+
|
|
570
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
|
571
|
+
<span class='ivar'>@name</span>
|
|
572
|
+
<span class='kw'>end</span></pre>
|
|
573
|
+
</td>
|
|
574
|
+
</tr>
|
|
575
|
+
</table>
|
|
576
|
+
</div>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span id=""></span>
|
|
580
|
+
<div class="method_details ">
|
|
581
|
+
<h3 class="signature " id="watcher-instance_method">
|
|
582
|
+
|
|
583
|
+
- (<tt>Object</tt>) <strong>watcher</strong> <span class="extras">(readonly)</span>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</h3><div class="docstring">
|
|
590
|
+
<div class="discussion">
|
|
591
|
+
|
|
592
|
+
<p>Returns the value of attribute watcher</p>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
</div>
|
|
596
|
+
</div>
|
|
597
|
+
<div class="tags">
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div><table class="source_code">
|
|
601
|
+
<tr>
|
|
602
|
+
<td>
|
|
603
|
+
<pre class="lines">
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
21
|
|
607
|
+
22
|
|
608
|
+
23</pre>
|
|
609
|
+
</td>
|
|
610
|
+
<td>
|
|
611
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 21</span>
|
|
612
|
+
|
|
613
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_watcher'>watcher</span>
|
|
614
|
+
<span class='ivar'>@watcher</span>
|
|
615
|
+
<span class='kw'>end</span></pre>
|
|
616
|
+
</td>
|
|
617
|
+
</tr>
|
|
618
|
+
</table>
|
|
619
|
+
</div>
|
|
620
|
+
|
|
621
|
+
</div>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
<div id="instance_method_details" class="method_details_list">
|
|
625
|
+
<h2>Instance Method Details</h2>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
<div class="method_details first">
|
|
629
|
+
<h3 class="signature first" id="cancel_update-instance_method">
|
|
630
|
+
|
|
631
|
+
- (<tt>Symbol</tt>) <strong>cancel_update</strong>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
</h3><div class="docstring">
|
|
638
|
+
<div class="discussion">
|
|
639
|
+
|
|
640
|
+
<p>Cancel update in-progress.</p>
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
</div>
|
|
644
|
+
</div>
|
|
645
|
+
<div class="tags">
|
|
646
|
+
|
|
647
|
+
<p class="tag_title">Returns:</p>
|
|
648
|
+
<ul class="return">
|
|
649
|
+
|
|
650
|
+
<li>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
—
|
|
658
|
+
<div class='inline'>
|
|
659
|
+
<p>`:update_cancelled` if successful</p>
|
|
660
|
+
</div>
|
|
661
|
+
|
|
662
|
+
</li>
|
|
663
|
+
|
|
664
|
+
</ul>
|
|
665
|
+
<p class="tag_title">Raises:</p>
|
|
666
|
+
<ul class="raise">
|
|
667
|
+
|
|
668
|
+
<li>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
<span class='type'>(<tt><span class='object_link'><a href="StackUpdateError.html" title="Stackup::StackUpdateError (class)">Stackup::StackUpdateError</a></span></tt>)</span>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
—
|
|
676
|
+
<div class='inline'>
|
|
677
|
+
<p>if operation fails</p>
|
|
678
|
+
</div>
|
|
679
|
+
|
|
680
|
+
</li>
|
|
681
|
+
|
|
682
|
+
</ul>
|
|
683
|
+
|
|
684
|
+
</div><table class="source_code">
|
|
685
|
+
<tr>
|
|
686
|
+
<td>
|
|
687
|
+
<pre class="lines">
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
99
|
|
691
|
+
100
|
|
692
|
+
101
|
|
693
|
+
102
|
|
694
|
+
103
|
|
695
|
+
104
|
|
696
|
+
105
|
|
697
|
+
106
|
|
698
|
+
107</pre>
|
|
699
|
+
</td>
|
|
700
|
+
<td>
|
|
701
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 99</span>
|
|
702
|
+
|
|
703
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_cancel_update'>cancel_update</span>
|
|
704
|
+
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_modify_stack'>modify_stack</span> <span class='kw'>do</span>
|
|
705
|
+
<span class='id identifier rubyid_cf_stack'>cf_stack</span><span class='period'>.</span><span class='id identifier rubyid_cancel_update'>cancel_update</span>
|
|
706
|
+
<span class='kw'>end</span>
|
|
707
|
+
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>StackUpdateError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>update cancel failed</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>_COMPLETE$</span><span class='regexp_end'>/</span></span>
|
|
708
|
+
<span class='symbol'>:update_cancelled</span>
|
|
709
|
+
<span class='kw'>rescue</span> <span class='const'>InvalidStateError</span>
|
|
710
|
+
<span class='kw'>nil</span>
|
|
711
|
+
<span class='kw'>end</span></pre>
|
|
712
|
+
</td>
|
|
713
|
+
</tr>
|
|
714
|
+
</table>
|
|
715
|
+
</div>
|
|
716
|
+
|
|
717
|
+
<div class="method_details ">
|
|
718
|
+
<h3 class="signature " id="create_or_update-instance_method">
|
|
719
|
+
|
|
720
|
+
- (<tt>Symbol</tt>) <strong>create_or_update</strong>(options)
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<span class="aliases">Also known as:
|
|
725
|
+
<span class="names"><span id='up-instance_method'>up</span></span>
|
|
726
|
+
</span>
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
</h3><div class="docstring">
|
|
731
|
+
<div class="discussion">
|
|
732
|
+
|
|
733
|
+
<p>Create or update the stack.</p>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</div>
|
|
737
|
+
</div>
|
|
738
|
+
<div class="tags">
|
|
739
|
+
<p class="tag_title">Parameters:</p>
|
|
740
|
+
<ul class="param">
|
|
741
|
+
|
|
742
|
+
<li>
|
|
743
|
+
|
|
744
|
+
<span class='name'>options</span>
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
—
|
|
752
|
+
<div class='inline'>
|
|
753
|
+
<p>create/update options accepts a superset of the options supported by
|
|
754
|
+
<tt>Aws::CloudFormation::Stack#update</tt> (see <a
|
|
755
|
+
href="http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Stack.html#update-instance_method">docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Stack.html#update-instance_method</a>)</p>
|
|
756
|
+
</div>
|
|
757
|
+
|
|
758
|
+
</li>
|
|
759
|
+
|
|
760
|
+
</ul>
|
|
761
|
+
|
|
762
|
+
<p class="tag_title">Returns:</p>
|
|
763
|
+
<ul class="return">
|
|
764
|
+
|
|
765
|
+
<li>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
—
|
|
773
|
+
<div class='inline'>
|
|
774
|
+
<p>`:created` or `:updated` if successful</p>
|
|
775
|
+
</div>
|
|
776
|
+
|
|
777
|
+
</li>
|
|
778
|
+
|
|
779
|
+
</ul>
|
|
780
|
+
<p class="tag_title">Raises:</p>
|
|
781
|
+
<ul class="raise">
|
|
782
|
+
|
|
783
|
+
<li>
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
<span class='type'>(<tt><span class='object_link'><a href="StackUpdateError.html" title="Stackup::StackUpdateError (class)">Stackup::StackUpdateError</a></span></tt>)</span>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
—
|
|
791
|
+
<div class='inline'>
|
|
792
|
+
<p>if operation fails</p>
|
|
793
|
+
</div>
|
|
794
|
+
|
|
795
|
+
</li>
|
|
796
|
+
|
|
797
|
+
</ul>
|
|
798
|
+
|
|
799
|
+
</div><table class="source_code">
|
|
800
|
+
<tr>
|
|
801
|
+
<td>
|
|
802
|
+
<pre class="lines">
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
57
|
|
806
|
+
58
|
|
807
|
+
59
|
|
808
|
+
60
|
|
809
|
+
61
|
|
810
|
+
62
|
|
811
|
+
63
|
|
812
|
+
64</pre>
|
|
813
|
+
</td>
|
|
814
|
+
<td>
|
|
815
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 57</span>
|
|
816
|
+
|
|
817
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_or_update'>create_or_update</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
818
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
|
819
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:capabilities</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CAPABILITY_IAM</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
820
|
+
<span class='id identifier rubyid_delete'>delete</span> <span class='kw'>if</span> <span class='const'>ALMOST_DEAD_STATUSES</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
|
|
821
|
+
<span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
822
|
+
<span class='kw'>rescue</span> <span class='const'>NoSuchStack</span>
|
|
823
|
+
<span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
824
|
+
<span class='kw'>end</span></pre>
|
|
825
|
+
</td>
|
|
826
|
+
</tr>
|
|
827
|
+
</table>
|
|
828
|
+
</div>
|
|
829
|
+
|
|
830
|
+
<div class="method_details ">
|
|
831
|
+
<h3 class="signature " id="delete-instance_method">
|
|
832
|
+
|
|
833
|
+
- (<tt>Symbol</tt>) <strong>delete</strong>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
<span class="aliases">Also known as:
|
|
838
|
+
<span class="names"><span id='down-instance_method'>down</span></span>
|
|
839
|
+
</span>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
</h3><div class="docstring">
|
|
844
|
+
<div class="discussion">
|
|
845
|
+
|
|
846
|
+
<p>Delete the stack.</p>
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
</div>
|
|
850
|
+
</div>
|
|
851
|
+
<div class="tags">
|
|
852
|
+
<p class="tag_title">Parameters:</p>
|
|
853
|
+
<ul class="param">
|
|
854
|
+
|
|
855
|
+
<li>
|
|
856
|
+
|
|
857
|
+
<span class='name'>template</span>
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
—
|
|
865
|
+
<div class='inline'>
|
|
866
|
+
<p>template JSON</p>
|
|
867
|
+
</div>
|
|
868
|
+
|
|
869
|
+
</li>
|
|
870
|
+
|
|
871
|
+
<li>
|
|
872
|
+
|
|
873
|
+
<span class='name'>parameters</span>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<span class='type'>(<tt>Array<Hash></tt>)</span>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
—
|
|
881
|
+
<div class='inline'>
|
|
882
|
+
<p>template parameters</p>
|
|
883
|
+
</div>
|
|
884
|
+
|
|
885
|
+
</li>
|
|
886
|
+
|
|
887
|
+
</ul>
|
|
888
|
+
|
|
889
|
+
<p class="tag_title">Returns:</p>
|
|
890
|
+
<ul class="return">
|
|
891
|
+
|
|
892
|
+
<li>
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
—
|
|
900
|
+
<div class='inline'>
|
|
901
|
+
<p>`:deleted` if successful</p>
|
|
902
|
+
</div>
|
|
903
|
+
|
|
904
|
+
</li>
|
|
905
|
+
|
|
906
|
+
</ul>
|
|
907
|
+
<p class="tag_title">Raises:</p>
|
|
908
|
+
<ul class="raise">
|
|
909
|
+
|
|
910
|
+
<li>
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
<span class='type'>(<tt><span class='object_link'><a href="StackUpdateError.html" title="Stackup::StackUpdateError (class)">Stackup::StackUpdateError</a></span></tt>)</span>
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
—
|
|
918
|
+
<div class='inline'>
|
|
919
|
+
<p>if operation fails</p>
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</li>
|
|
923
|
+
|
|
924
|
+
</ul>
|
|
925
|
+
|
|
926
|
+
</div><table class="source_code">
|
|
927
|
+
<tr>
|
|
928
|
+
<td>
|
|
929
|
+
<pre class="lines">
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
77
|
|
933
|
+
78
|
|
934
|
+
79
|
|
935
|
+
80
|
|
936
|
+
81
|
|
937
|
+
82
|
|
938
|
+
83
|
|
939
|
+
84
|
|
940
|
+
85
|
|
941
|
+
86
|
|
942
|
+
87
|
|
943
|
+
88
|
|
944
|
+
89
|
|
945
|
+
90</pre>
|
|
946
|
+
</td>
|
|
947
|
+
<td>
|
|
948
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 77</span>
|
|
949
|
+
|
|
950
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
|
|
951
|
+
<span class='kw'>begin</span>
|
|
952
|
+
<span class='ivar'>@stack_id</span> <span class='op'>=</span> <span class='id identifier rubyid_cf_stack'>cf_stack</span><span class='period'>.</span><span class='id identifier rubyid_stack_id'>stack_id</span>
|
|
953
|
+
<span class='kw'>rescue</span> <span class='const'>NoSuchStack</span>
|
|
954
|
+
<span class='kw'>return</span> <span class='kw'>nil</span>
|
|
955
|
+
<span class='kw'>end</span>
|
|
956
|
+
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_modify_stack'>modify_stack</span> <span class='kw'>do</span>
|
|
957
|
+
<span class='id identifier rubyid_cf_stack'>cf_stack</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span>
|
|
958
|
+
<span class='kw'>end</span>
|
|
959
|
+
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>StackUpdateError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>stack delete failed</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DELETE_COMPLETE</span><span class='tstring_end'>"</span></span>
|
|
960
|
+
<span class='symbol'>:deleted</span>
|
|
961
|
+
<span class='kw'>ensure</span>
|
|
962
|
+
<span class='ivar'>@stack_id</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
963
|
+
<span class='kw'>end</span></pre>
|
|
964
|
+
</td>
|
|
965
|
+
</tr>
|
|
966
|
+
</table>
|
|
967
|
+
</div>
|
|
968
|
+
|
|
969
|
+
<div class="method_details ">
|
|
970
|
+
<h3 class="signature " id="exists?-instance_method">
|
|
971
|
+
|
|
972
|
+
- (<tt>boolean</tt>) <strong>exists?</strong>
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
</h3><div class="docstring">
|
|
979
|
+
<div class="discussion">
|
|
980
|
+
|
|
981
|
+
<p>Returns true iff the stack exists</p>
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
</div>
|
|
985
|
+
</div>
|
|
986
|
+
<div class="tags">
|
|
987
|
+
|
|
988
|
+
<p class="tag_title">Returns:</p>
|
|
989
|
+
<ul class="return">
|
|
990
|
+
|
|
991
|
+
<li>
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
—
|
|
999
|
+
<div class='inline'>
|
|
1000
|
+
<p>true iff the stack exists</p>
|
|
1001
|
+
</div>
|
|
1002
|
+
|
|
1003
|
+
</li>
|
|
1004
|
+
|
|
1005
|
+
</ul>
|
|
1006
|
+
|
|
1007
|
+
</div><table class="source_code">
|
|
1008
|
+
<tr>
|
|
1009
|
+
<td>
|
|
1010
|
+
<pre class="lines">
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
41
|
|
1014
|
+
42
|
|
1015
|
+
43
|
|
1016
|
+
44
|
|
1017
|
+
45
|
|
1018
|
+
46</pre>
|
|
1019
|
+
</td>
|
|
1020
|
+
<td>
|
|
1021
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 41</span>
|
|
1022
|
+
|
|
1023
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_exists?'>exists?</span>
|
|
1024
|
+
<span class='id identifier rubyid_status'>status</span>
|
|
1025
|
+
<span class='kw'>true</span>
|
|
1026
|
+
<span class='kw'>rescue</span> <span class='const'>NoSuchStack</span>
|
|
1027
|
+
<span class='kw'>false</span>
|
|
1028
|
+
<span class='kw'>end</span></pre>
|
|
1029
|
+
</td>
|
|
1030
|
+
</tr>
|
|
1031
|
+
</table>
|
|
1032
|
+
</div>
|
|
1033
|
+
|
|
1034
|
+
<div class="method_details ">
|
|
1035
|
+
<h3 class="signature " id="on_event-instance_method">
|
|
1036
|
+
|
|
1037
|
+
- (<tt>Object</tt>) <strong>on_event</strong>(event_handler = nil, &block)
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
</h3><div class="docstring">
|
|
1044
|
+
<div class="discussion">
|
|
1045
|
+
|
|
1046
|
+
<p>Register a handler for reporting of stack events</p>
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
</div>
|
|
1050
|
+
</div>
|
|
1051
|
+
<div class="tags">
|
|
1052
|
+
<p class="tag_title">Parameters:</p>
|
|
1053
|
+
<ul class="param">
|
|
1054
|
+
|
|
1055
|
+
<li>
|
|
1056
|
+
|
|
1057
|
+
<span class='name'>event_handler</span>
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
<span class='type'>(<tt>Proc</tt>)</span>
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
</li>
|
|
1067
|
+
|
|
1068
|
+
</ul>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
</div><table class="source_code">
|
|
1072
|
+
<tr>
|
|
1073
|
+
<td>
|
|
1074
|
+
<pre class="lines">
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
26
|
|
1078
|
+
27
|
|
1079
|
+
28
|
|
1080
|
+
29
|
|
1081
|
+
30</pre>
|
|
1082
|
+
</td>
|
|
1083
|
+
<td>
|
|
1084
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 26</span>
|
|
1085
|
+
|
|
1086
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_event'>on_event</span><span class='lparen'>(</span><span class='id identifier rubyid_event_handler'>event_handler</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1087
|
+
<span class='id identifier rubyid_event_handler'>event_handler</span> <span class='op'>||=</span> <span class='id identifier rubyid_block'>block</span>
|
|
1088
|
+
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>no event_handler provided</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_event_handler'>event_handler</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1089
|
+
<span class='ivar'>@event_handler</span> <span class='op'>=</span> <span class='id identifier rubyid_event_handler'>event_handler</span>
|
|
1090
|
+
<span class='kw'>end</span></pre>
|
|
1091
|
+
</td>
|
|
1092
|
+
</tr>
|
|
1093
|
+
</table>
|
|
1094
|
+
</div>
|
|
1095
|
+
|
|
1096
|
+
<div class="method_details ">
|
|
1097
|
+
<h3 class="signature " id="outputs-instance_method">
|
|
1098
|
+
|
|
1099
|
+
- (<tt>Hash<String, String></tt>) <strong>outputs</strong>
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
</h3><div class="docstring">
|
|
1106
|
+
<div class="discussion">
|
|
1107
|
+
|
|
1108
|
+
<p>Get stack outputs.</p>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
</div>
|
|
1112
|
+
</div>
|
|
1113
|
+
<div class="tags">
|
|
1114
|
+
|
|
1115
|
+
<p class="tag_title">Returns:</p>
|
|
1116
|
+
<ul class="return">
|
|
1117
|
+
|
|
1118
|
+
<li>
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
<span class='type'>(<tt>Hash<String, String></tt>)</span>
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
—
|
|
1126
|
+
<div class='inline'>
|
|
1127
|
+
<p>mapping of logical resource-name to physical resource-name</p>
|
|
1128
|
+
</div>
|
|
1129
|
+
|
|
1130
|
+
</li>
|
|
1131
|
+
|
|
1132
|
+
</ul>
|
|
1133
|
+
<p class="tag_title">Raises:</p>
|
|
1134
|
+
<ul class="raise">
|
|
1135
|
+
|
|
1136
|
+
<li>
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
<span class='type'>(<tt><span class='object_link'><a href="NoSuchStack.html" title="Stackup::NoSuchStack (class)">Stackup::NoSuchStack</a></span></tt>)</span>
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
—
|
|
1144
|
+
<div class='inline'>
|
|
1145
|
+
<p>if the stack doesn't exist</p>
|
|
1146
|
+
</div>
|
|
1147
|
+
|
|
1148
|
+
</li>
|
|
1149
|
+
|
|
1150
|
+
</ul>
|
|
1151
|
+
|
|
1152
|
+
</div><table class="source_code">
|
|
1153
|
+
<tr>
|
|
1154
|
+
<td>
|
|
1155
|
+
<pre class="lines">
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
115
|
|
1159
|
+
116
|
|
1160
|
+
117
|
|
1161
|
+
118
|
|
1162
|
+
119
|
|
1163
|
+
120
|
|
1164
|
+
121</pre>
|
|
1165
|
+
</td>
|
|
1166
|
+
<td>
|
|
1167
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 115</span>
|
|
1168
|
+
|
|
1169
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_outputs'>outputs</span>
|
|
1170
|
+
<span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_h'>h</span><span class='op'>|</span>
|
|
1171
|
+
<span class='id identifier rubyid_cf_stack'>cf_stack</span><span class='period'>.</span><span class='id identifier rubyid_outputs'>outputs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_output'>output</span><span class='op'>|</span>
|
|
1172
|
+
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span><span class='id identifier rubyid_output'>output</span><span class='period'>.</span><span class='id identifier rubyid_output_key'>output_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_output'>output</span><span class='period'>.</span><span class='id identifier rubyid_output_value'>output_value</span>
|
|
1173
|
+
<span class='kw'>end</span>
|
|
1174
|
+
<span class='kw'>end</span>
|
|
1175
|
+
<span class='kw'>end</span></pre>
|
|
1176
|
+
</td>
|
|
1177
|
+
</tr>
|
|
1178
|
+
</table>
|
|
1179
|
+
</div>
|
|
1180
|
+
|
|
1181
|
+
<div class="method_details ">
|
|
1182
|
+
<h3 class="signature " id="status-instance_method">
|
|
1183
|
+
|
|
1184
|
+
- (<tt>String</tt>) <strong>status</strong>
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
</h3><div class="docstring">
|
|
1191
|
+
<div class="discussion">
|
|
1192
|
+
|
|
1193
|
+
<p>Returns the current stack status</p>
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
</div>
|
|
1197
|
+
</div>
|
|
1198
|
+
<div class="tags">
|
|
1199
|
+
|
|
1200
|
+
<p class="tag_title">Returns:</p>
|
|
1201
|
+
<ul class="return">
|
|
1202
|
+
|
|
1203
|
+
<li>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
—
|
|
1211
|
+
<div class='inline'>
|
|
1212
|
+
<p>the current stack status</p>
|
|
1213
|
+
</div>
|
|
1214
|
+
|
|
1215
|
+
</li>
|
|
1216
|
+
|
|
1217
|
+
</ul>
|
|
1218
|
+
<p class="tag_title">Raises:</p>
|
|
1219
|
+
<ul class="raise">
|
|
1220
|
+
|
|
1221
|
+
<li>
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
<span class='type'>(<tt><span class='object_link'><a href="NoSuchStack.html" title="Stackup::NoSuchStack (class)">Stackup::NoSuchStack</a></span></tt>)</span>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
—
|
|
1229
|
+
<div class='inline'>
|
|
1230
|
+
<p>if the stack doesn't exist</p>
|
|
1231
|
+
</div>
|
|
1232
|
+
|
|
1233
|
+
</li>
|
|
1234
|
+
|
|
1235
|
+
</ul>
|
|
1236
|
+
|
|
1237
|
+
</div><table class="source_code">
|
|
1238
|
+
<tr>
|
|
1239
|
+
<td>
|
|
1240
|
+
<pre class="lines">
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
35
|
|
1244
|
+
36
|
|
1245
|
+
37</pre>
|
|
1246
|
+
</td>
|
|
1247
|
+
<td>
|
|
1248
|
+
<pre class="code"><span class="info file"># File 'lib/stackup/stack.rb', line 35</span>
|
|
1249
|
+
|
|
1250
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
|
|
1251
|
+
<span class='id identifier rubyid_cf_stack'>cf_stack</span><span class='period'>.</span><span class='id identifier rubyid_stack_status'>stack_status</span>
|
|
1252
|
+
<span class='kw'>end</span></pre>
|
|
1253
|
+
</td>
|
|
1254
|
+
</tr>
|
|
1255
|
+
</table>
|
|
1256
|
+
</div>
|
|
1257
|
+
|
|
1258
|
+
</div>
|
|
1259
|
+
|
|
1260
|
+
</div>
|
|
1261
|
+
|
|
1262
|
+
<div id="footer">
|
|
1263
|
+
Generated on Fri Oct 9 11:23:11 2015 by
|
|
1264
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1265
|
+
0.8.7.6 (ruby-2.2.2).
|
|
1266
|
+
</div>
|
|
1267
|
+
|
|
1268
|
+
</body>
|
|
1269
|
+
</html>
|