humidifier-reservoir 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +3 -3
- data/README.md +94 -0
- data/docs/Humidifier.html +2 -2
- data/docs/Humidifier/Reservoir.html +3 -3
- data/docs/Humidifier/Reservoir/BaseMapper.html +61 -23
- data/docs/Humidifier/Reservoir/CLI.html +89 -23
- data/docs/Humidifier/Reservoir/Config.html +6 -6
- data/docs/Humidifier/Reservoir/Error.html +2 -2
- data/docs/Humidifier/Reservoir/Mapping.html +20 -12
- data/docs/Humidifier/Reservoir/Stack.html +272 -60
- data/docs/Humidifier/Reservoir/Stack/Export.html +322 -0
- data/docs/_index.html +9 -2
- data/docs/class_list.html +1 -1
- data/docs/file.LICENSE.html +2 -2
- data/docs/file.README.html +121 -2
- data/docs/index.html +121 -2
- data/docs/method_list.html +52 -4
- data/docs/top-level-namespace.html +2 -2
- data/humidifier-reservoir.gemspec +1 -3
- data/lib/humidifier/reservoir/base_mapper.rb +26 -3
- data/lib/humidifier/reservoir/cli.rb +21 -4
- data/lib/humidifier/reservoir/config.rb +2 -2
- data/lib/humidifier/reservoir/mapping.rb +23 -3
- data/lib/humidifier/reservoir/stack.rb +49 -8
- data/lib/humidifier/reservoir/version.rb +1 -1
- metadata +5 -4
|
@@ -0,0 +1,322 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Humidifier::Reservoir::Stack::Export
|
|
8
|
+
|
|
9
|
+
— Humidifier::Reservoir
|
|
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
|
+
pathId = "Humidifier::Reservoir::Stack::Export";
|
|
19
|
+
relpath = '../../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../../_index.html">Index (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../../Humidifier.html" title="Humidifier (module)">Humidifier</a></span></span> » <span class='title'><span class='object_link'><a href="../../Reservoir.html" title="Humidifier::Reservoir (module)">Reservoir</a></span></span> » <span class='title'><span class='object_link'><a href="../Stack.html" title="Humidifier::Reservoir::Stack (class)">Stack</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Export</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Humidifier::Reservoir::Stack::Export
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Struct</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Struct</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Humidifier::Reservoir::Stack::Export</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/humidifier/reservoir/stack.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>Represents an exported resource in a stack for use in cross-stack
|
|
108
|
+
references.</p>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
<div class="tags">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
121
|
+
<ul class="summary">
|
|
122
|
+
|
|
123
|
+
<li class="public ">
|
|
124
|
+
<span class="summary_signature">
|
|
125
|
+
|
|
126
|
+
<a href="#attribute-instance_method" title="#attribute (instance method)">#<strong>attribute</strong> ⇒ Object </a>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
</span>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<span class="summary_desc"><div class='inline'>
|
|
144
|
+
<p>Returns the value of attribute attribute.</p>
|
|
145
|
+
</div></span>
|
|
146
|
+
|
|
147
|
+
</li>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<li class="public ">
|
|
151
|
+
<span class="summary_signature">
|
|
152
|
+
|
|
153
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</span>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<span class="summary_desc"><div class='inline'>
|
|
171
|
+
<p>Returns the value of attribute name.</p>
|
|
172
|
+
</div></span>
|
|
173
|
+
|
|
174
|
+
</li>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</ul>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<div id="instance_attr_details" class="attr_details">
|
|
185
|
+
<h2>Instance Attribute Details</h2>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<span id="attribute=-instance_method"></span>
|
|
189
|
+
<div class="method_details first">
|
|
190
|
+
<h3 class="signature first" id="attribute-instance_method">
|
|
191
|
+
|
|
192
|
+
#<strong>attribute</strong> ⇒ <tt>Object</tt>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</h3><div class="docstring">
|
|
199
|
+
<div class="discussion">
|
|
200
|
+
|
|
201
|
+
<p>Returns the value of attribute attribute</p>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
<div class="tags">
|
|
207
|
+
|
|
208
|
+
<p class="tag_title">Returns:</p>
|
|
209
|
+
<ul class="return">
|
|
210
|
+
|
|
211
|
+
<li>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
—
|
|
219
|
+
<div class='inline'>
|
|
220
|
+
<p>the current value of attribute</p>
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
</li>
|
|
224
|
+
|
|
225
|
+
</ul>
|
|
226
|
+
|
|
227
|
+
</div><table class="source_code">
|
|
228
|
+
<tr>
|
|
229
|
+
<td>
|
|
230
|
+
<pre class="lines">
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
9
|
|
234
|
+
10
|
|
235
|
+
11</pre>
|
|
236
|
+
</td>
|
|
237
|
+
<td>
|
|
238
|
+
<pre class="code"><span class="info file"># File 'lib/humidifier/reservoir/stack.rb', line 9</span>
|
|
239
|
+
|
|
240
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_attribute'>attribute</span>
|
|
241
|
+
<span class='ivar'>@attribute</span>
|
|
242
|
+
<span class='kw'>end</span></pre>
|
|
243
|
+
</td>
|
|
244
|
+
</tr>
|
|
245
|
+
</table>
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span id="name=-instance_method"></span>
|
|
250
|
+
<div class="method_details ">
|
|
251
|
+
<h3 class="signature " id="name-instance_method">
|
|
252
|
+
|
|
253
|
+
#<strong>name</strong> ⇒ <tt>Object</tt>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
</h3><div class="docstring">
|
|
260
|
+
<div class="discussion">
|
|
261
|
+
|
|
262
|
+
<p>Returns the value of attribute name</p>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
</div>
|
|
266
|
+
</div>
|
|
267
|
+
<div class="tags">
|
|
268
|
+
|
|
269
|
+
<p class="tag_title">Returns:</p>
|
|
270
|
+
<ul class="return">
|
|
271
|
+
|
|
272
|
+
<li>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
—
|
|
280
|
+
<div class='inline'>
|
|
281
|
+
<p>the current value of name</p>
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
</li>
|
|
285
|
+
|
|
286
|
+
</ul>
|
|
287
|
+
|
|
288
|
+
</div><table class="source_code">
|
|
289
|
+
<tr>
|
|
290
|
+
<td>
|
|
291
|
+
<pre class="lines">
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
9
|
|
295
|
+
10
|
|
296
|
+
11</pre>
|
|
297
|
+
</td>
|
|
298
|
+
<td>
|
|
299
|
+
<pre class="code"><span class="info file"># File 'lib/humidifier/reservoir/stack.rb', line 9</span>
|
|
300
|
+
|
|
301
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
|
302
|
+
<span class='ivar'>@name</span>
|
|
303
|
+
<span class='kw'>end</span></pre>
|
|
304
|
+
</td>
|
|
305
|
+
</tr>
|
|
306
|
+
</table>
|
|
307
|
+
</div>
|
|
308
|
+
|
|
309
|
+
</div>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</div>
|
|
313
|
+
|
|
314
|
+
<div id="footer">
|
|
315
|
+
Generated on Wed Nov 8 13:26:15 2017 by
|
|
316
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
317
|
+
0.9.9 (ruby-2.4.2).
|
|
318
|
+
</div>
|
|
319
|
+
|
|
320
|
+
</div>
|
|
321
|
+
</body>
|
|
322
|
+
</html>
|
data/docs/_index.html
CHANGED
|
@@ -127,6 +127,13 @@
|
|
|
127
127
|
|
|
128
128
|
</li>
|
|
129
129
|
|
|
130
|
+
<li>
|
|
131
|
+
<span class='object_link'><a href="Humidifier/Reservoir/Stack/Export.html" title="Humidifier::Reservoir::Stack::Export (class)">Export</a></span>
|
|
132
|
+
|
|
133
|
+
<small>(Humidifier::Reservoir::Stack)</small>
|
|
134
|
+
|
|
135
|
+
</li>
|
|
136
|
+
|
|
130
137
|
</ul>
|
|
131
138
|
</ul>
|
|
132
139
|
|
|
@@ -197,9 +204,9 @@
|
|
|
197
204
|
</div>
|
|
198
205
|
|
|
199
206
|
<div id="footer">
|
|
200
|
-
Generated on
|
|
207
|
+
Generated on Wed Nov 8 13:26:15 2017 by
|
|
201
208
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
202
|
-
0.9.9 (ruby-2.4.
|
|
209
|
+
0.9.9 (ruby-2.4.2).
|
|
203
210
|
</div>
|
|
204
211
|
|
|
205
212
|
</div>
|
data/docs/class_list.html
CHANGED
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
|
|
44
44
|
<ul id="full_list" class="class">
|
|
45
45
|
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
|
|
46
|
-
<li id='object_Humidifier' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Humidifier.html" title="Humidifier (module)">Humidifier</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Humidifier::Reservoir' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Humidifier/Reservoir.html" title="Humidifier::Reservoir (module)">Reservoir</a></span><small class='search_info'>Humidifier</small></div><ul><li id='object_Humidifier::Reservoir::BaseMapper' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/BaseMapper.html" title="Humidifier::Reservoir::BaseMapper (class)">BaseMapper</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::CLI' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/CLI.html" title="Humidifier::Reservoir::CLI (class)">CLI</a></span> < Thor<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Config' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/Config.html" title="Humidifier::Reservoir::Config (class)">Config</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Error' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/Error.html" title="Humidifier::Reservoir::Error (class)">Error</a></span> < StandardError<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Mapping' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/Mapping.html" title="Humidifier::Reservoir::Mapping (class)">Mapping</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Stack' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/Stack.html" title="Humidifier::Reservoir::Stack (class)">Stack</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div></li></ul></li></ul></li>
|
|
46
|
+
<li id='object_Humidifier' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Humidifier.html" title="Humidifier (module)">Humidifier</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Humidifier::Reservoir' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Humidifier/Reservoir.html" title="Humidifier::Reservoir (module)">Reservoir</a></span><small class='search_info'>Humidifier</small></div><ul><li id='object_Humidifier::Reservoir::BaseMapper' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/BaseMapper.html" title="Humidifier::Reservoir::BaseMapper (class)">BaseMapper</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::CLI' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/CLI.html" title="Humidifier::Reservoir::CLI (class)">CLI</a></span> < Thor<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Config' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/Config.html" title="Humidifier::Reservoir::Config (class)">Config</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Error' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/Error.html" title="Humidifier::Reservoir::Error (class)">Error</a></span> < StandardError<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Mapping' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Humidifier/Reservoir/Mapping.html" title="Humidifier::Reservoir::Mapping (class)">Mapping</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div></li><li id='object_Humidifier::Reservoir::Stack' class='collapsed'><div class='item' style='padding-left:60px'><a class='toggle'></a> <span class='object_link'><a href="Humidifier/Reservoir/Stack.html" title="Humidifier::Reservoir::Stack (class)">Stack</a></span> < Object<small class='search_info'>Humidifier::Reservoir</small></div><ul><li id='object_Humidifier::Reservoir::Stack::Export' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="Humidifier/Reservoir/Stack/Export.html" title="Humidifier::Reservoir::Stack::Export (class)">Export</a></span> < Struct<small class='search_info'>Humidifier::Reservoir::Stack</small></div></li></ul></li></ul></li></ul></li>
|
|
47
47
|
|
|
48
48
|
</ul>
|
|
49
49
|
</div>
|
data/docs/file.LICENSE.html
CHANGED
|
@@ -83,9 +83,9 @@ DEALINGS IN THE SOFTWARE.</p>
|
|
|
83
83
|
</div></div>
|
|
84
84
|
|
|
85
85
|
<div id="footer">
|
|
86
|
-
Generated on
|
|
86
|
+
Generated on Wed Nov 8 13:26:15 2017 by
|
|
87
87
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
88
|
-
0.9.9 (ruby-2.4.
|
|
88
|
+
0.9.9 (ruby-2.4.2).
|
|
89
89
|
</div>
|
|
90
90
|
|
|
91
91
|
</div>
|
data/docs/file.README.html
CHANGED
|
@@ -215,6 +215,125 @@ if you're deploying from an instance. For more information, see the <a
|
|
|
215
215
|
href="http://docs.aws.amazon.com/sdkforruby/api/">AWS docs</a> under the
|
|
216
216
|
“Configuration” section.</p>
|
|
217
217
|
|
|
218
|
+
<h4 id="label--prefix">–prefix</h4>
|
|
219
|
+
|
|
220
|
+
<p>The <code>deploy</code> command also allows a <code>--prefix</code> command
|
|
221
|
+
line argument that will override the default prefix (if one is configured)
|
|
222
|
+
for the stack that is being deployed. This is especially useful when
|
|
223
|
+
you're deploying multiple copies of the same stack (for instance,
|
|
224
|
+
multiple autoscaling groups) that have different purposes or semantically
|
|
225
|
+
mean newer versions of resources.</p>
|
|
226
|
+
|
|
227
|
+
<h3 id="label-Shortcuts">Shortcuts</h3>
|
|
228
|
+
|
|
229
|
+
<p>A couple of convenient shortcuts are built into
|
|
230
|
+
<code>humidifier-reservoir</code> so that writing templates and mappers
|
|
231
|
+
both can be more concise.</p>
|
|
232
|
+
|
|
233
|
+
<h4 id="label-Automatic+id+properties">Automatic id properties</h4>
|
|
234
|
+
|
|
235
|
+
<p>There are a lot of properties in the AWS CloudFormation resource
|
|
236
|
+
specification that are simply pointers to other entities within the AWS
|
|
237
|
+
ecosystem. For example, an <code>AWS::EC2::VPCGatewayAttachment</code>
|
|
238
|
+
entity has a <code>VpcId</code> property that represents the ID of the
|
|
239
|
+
associated <code>AWS::EC2::VPC</code>.</p>
|
|
240
|
+
|
|
241
|
+
<p>Because this pattern is so common, <code>humidifier-reservoir</code>
|
|
242
|
+
detects all properties ending in <code>Id</code> and allows you to specify
|
|
243
|
+
them without the suffix. If you choose to use this format,
|
|
244
|
+
<code>humidifier-reservoir</code> will automatically turn that value into a
|
|
245
|
+
<a
|
|
246
|
+
href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html">CloudFormation
|
|
247
|
+
resource reference</a>.</p>
|
|
248
|
+
|
|
249
|
+
<h4 id="label-Anonymous+mappers">Anonymous mappers</h4>
|
|
250
|
+
|
|
251
|
+
<p>A lot of the time, mappers that you create will not be overly complicated,
|
|
252
|
+
especially if you're using the aforementioned automatic id properties.
|
|
253
|
+
Therefore, the <code>config.map</code> method takes a block, and allows you
|
|
254
|
+
to specify the mapper inline. This is recommended for mappers that
|
|
255
|
+
aren't too complicates as to warrant their own class (for instance, for
|
|
256
|
+
testing purposes). An example of this using the <code>UserMapper</code>
|
|
257
|
+
from above is below:</p>
|
|
258
|
+
|
|
259
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Humidifier.html" title="Humidifier (module)">Humidifier</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Humidifier/Reservoir.html" title="Humidifier::Reservoir (module)">Reservoir</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="Humidifier/Reservoir.html#configure-class_method" title="Humidifier::Reservoir.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
|
|
260
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='symbol'>:users</span><span class='comma'>,</span> <span class='label'>to:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>AWS::IAM::User</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
|
|
261
|
+
<span class='const'>GROUPS</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
262
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>eng</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>Engineering</span><span class='words_sep'> </span><span class='tstring_content'>Testing</span><span class='words_sep'> </span><span class='tstring_content'>Deployment</span><span class='words_sep'>]</span><span class='comma'>,</span>
|
|
263
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>admin</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>Management</span><span class='words_sep'> </span><span class='tstring_content'>Administration</span><span class='words_sep'>]</span>
|
|
264
|
+
<span class='rbrace'>}</span>
|
|
265
|
+
|
|
266
|
+
<span class='id identifier rubyid_defaults'>defaults</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_logical_name'>logical_name</span><span class='op'>|</span>
|
|
267
|
+
<span class='lbrace'>{</span> <span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reservoir/</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>user_name:</span> <span class='id identifier rubyid_logical_name'>logical_name</span> <span class='rbrace'>}</span>
|
|
268
|
+
<span class='kw'>end</span>
|
|
269
|
+
|
|
270
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:group</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_group'>group</span><span class='op'>|</span>
|
|
271
|
+
<span class='id identifier rubyid_groups'>groups</span> <span class='op'>=</span> <span class='const'>GROUPS</span><span class='lbracket'>[</span><span class='id identifier rubyid_group'>group</span><span class='rbracket'>]</span>
|
|
272
|
+
<span class='id identifier rubyid_groups'>groups</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='op'>?</span> <span class='lbrace'>{</span> <span class='label'>groups:</span> <span class='const'>GROUPS</span><span class='lbracket'>[</span><span class='id identifier rubyid_group'>group</span><span class='rbracket'>]</span> <span class='rbrace'>}</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
273
|
+
<span class='kw'>end</span>
|
|
274
|
+
<span class='kw'>end</span>
|
|
275
|
+
<span class='kw'>end</span>
|
|
276
|
+
</code></pre>
|
|
277
|
+
|
|
278
|
+
<h4 id="label-Cross-stack+references">Cross-stack references</h4>
|
|
279
|
+
|
|
280
|
+
<p>AWS allows cross-stack references through the <a
|
|
281
|
+
href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html">intrinsic
|
|
282
|
+
Fn::ImportValue function</a>. You can take advantage of this with
|
|
283
|
+
<code>humidifier-reservoir</code> by using the <code>export: true</code>
|
|
284
|
+
option on resources in your stacks. For instance, if in one stack you have
|
|
285
|
+
a subnet that you need to reference in another, you could
|
|
286
|
+
(<code>stacks/vpc/subnets.yml</code>):</p>
|
|
287
|
+
|
|
288
|
+
<pre class="code ruby"><code class="ruby">ProductionPrivateSubnet2a:
|
|
289
|
+
vpc: ProductionVPC
|
|
290
|
+
cidr_block: 10.0.0.0/19
|
|
291
|
+
availability_zone: us-west-2a
|
|
292
|
+
export: true
|
|
293
|
+
|
|
294
|
+
ProductionPrivateSubnet2b:
|
|
295
|
+
vpc: ProductionVPC
|
|
296
|
+
cidr_block: 10.0.64.0/19
|
|
297
|
+
availability_zone: us-west-2b
|
|
298
|
+
export: true
|
|
299
|
+
|
|
300
|
+
ProductionPrivateSubnet2c:
|
|
301
|
+
vpc: ProductionVPC
|
|
302
|
+
cidr_block: 10.0.128.0/19
|
|
303
|
+
availability_zone: us-west-2c
|
|
304
|
+
export: true</code></pre>
|
|
305
|
+
|
|
306
|
+
<p>And then in another stack, you could reference those values
|
|
307
|
+
(<code>stacks/rds/db_subnets_groups.yml</code>):</p>
|
|
308
|
+
|
|
309
|
+
<pre class="code ruby"><code class="ruby">ProductionDBSubnetGroup:
|
|
310
|
+
db_subnet_group_description: Production DB private subnet group
|
|
311
|
+
subnets:
|
|
312
|
+
- ProductionPrivateSubnet2a
|
|
313
|
+
- ProductionPrivateSubnet2b
|
|
314
|
+
- ProductionPrivateSubnet2c</code></pre>
|
|
315
|
+
|
|
316
|
+
<p>Within the configuration, you would specify to use the
|
|
317
|
+
<code>Fn::ImportValue</code> function like so:</p>
|
|
318
|
+
|
|
319
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Humidifier.html" title="Humidifier (module)">Humidifier</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Humidifier/Reservoir.html" title="Humidifier::Reservoir (module)">Reservoir</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="Humidifier/Reservoir.html#configure-class_method" title="Humidifier::Reservoir.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
|
|
320
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_stack_path'>stack_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>stacks</span><span class='tstring_end'>'</span></span>
|
|
321
|
+
|
|
322
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='symbol'>:subnets</span><span class='comma'>,</span> <span class='label'>to:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>EC2::Subnet</span><span class='tstring_end'>'</span></span>
|
|
323
|
+
|
|
324
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='symbol'>:db_subnet_groups</span><span class='comma'>,</span> <span class='label'>to:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>RDS::DBSubnetGroup</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
|
|
325
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:subnets</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_subnet_names'>subnet_names</span><span class='op'>|</span>
|
|
326
|
+
<span class='id identifier rubyid_subnet_ids'>subnet_ids</span> <span class='op'>=</span>
|
|
327
|
+
<span class='id identifier rubyid_subnet_names'>subnet_names</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_subnet_name'>subnet_name</span><span class='op'>|</span>
|
|
328
|
+
<span class='const'><span class='object_link'><a href="Humidifier.html" title="Humidifier (module)">Humidifier</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fn'>fn</span><span class='period'>.</span><span class='id identifier rubyid_import_value'>import_value</span><span class='lparen'>(</span><span class='id identifier rubyid_subnet_name'>subnet_name</span><span class='rparen'>)</span>
|
|
329
|
+
<span class='kw'>end</span>
|
|
330
|
+
|
|
331
|
+
<span class='lbrace'>{</span> <span class='label'>subnet_ids:</span> <span class='id identifier rubyid_subnet_ids'>subnet_ids</span> <span class='rbrace'>}</span>
|
|
332
|
+
<span class='kw'>end</span>
|
|
333
|
+
<span class='kw'>end</span>
|
|
334
|
+
<span class='kw'>end</span>
|
|
335
|
+
</code></pre>
|
|
336
|
+
|
|
218
337
|
<h2 id="label-Development">Development</h2>
|
|
219
338
|
|
|
220
339
|
<p>After checking out the repo, run <code>bin/setup</code> to install
|
|
@@ -241,9 +360,9 @@ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
|
241
360
|
</div></div>
|
|
242
361
|
|
|
243
362
|
<div id="footer">
|
|
244
|
-
Generated on
|
|
363
|
+
Generated on Wed Nov 8 13:26:15 2017 by
|
|
245
364
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
246
|
-
0.9.9 (ruby-2.4.
|
|
365
|
+
0.9.9 (ruby-2.4.2).
|
|
247
366
|
</div>
|
|
248
367
|
|
|
249
368
|
</div>
|