esp_sdk 2.0.0 → 2.1.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/.travis.yml +1 -0
- data/CHANGELOG.md +6 -1
- data/Gemfile.lock +11 -1
- data/README.md +287 -28
- data/bin/esp +15 -0
- data/esp_sdk.gemspec +2 -0
- data/lib/esp/aws_clients.rb +60 -0
- data/lib/esp/commands/add_external_account.rb +57 -0
- data/lib/esp/commands/commands_tasks.rb +106 -0
- data/lib/esp/commands/console.rb +68 -0
- data/lib/esp/extensions/active_resource/formats/json_api_format.rb +12 -4
- data/lib/esp/extensions/active_resource/paginated_collection.rb +5 -5
- data/lib/esp/extensions/active_resource/validations.rb +1 -1
- data/lib/esp/external_account_creator.rb +77 -0
- data/lib/esp/resources/alert.rb +30 -34
- data/lib/esp/resources/cloud_trail_event.rb +5 -0
- data/lib/esp/resources/contact_request.rb +6 -5
- data/lib/esp/resources/custom_signature.rb +32 -56
- data/lib/esp/resources/dashboard.rb +8 -1
- data/lib/esp/resources/external_account.rb +27 -19
- data/lib/esp/resources/organization.rb +27 -3
- data/lib/esp/resources/region.rb +15 -3
- data/lib/esp/resources/report.rb +28 -24
- data/lib/esp/resources/resource.rb +26 -10
- data/lib/esp/resources/service.rb +5 -0
- data/lib/esp/resources/signature.rb +28 -12
- data/lib/esp/resources/stat.rb +21 -2
- data/lib/esp/resources/stat_custom_signature.rb +30 -4
- data/lib/esp/resources/stat_region.rb +29 -3
- data/lib/esp/resources/stat_service.rb +29 -3
- data/lib/esp/resources/stat_signature.rb +29 -3
- data/lib/esp/resources/sub_organization.rb +27 -3
- data/lib/esp/resources/suppression/region.rb +14 -32
- data/lib/esp/resources/suppression/signature.rb +14 -40
- data/lib/esp/resources/suppression/unique_identifier.rb +8 -6
- data/lib/esp/resources/suppression.rb +43 -5
- data/lib/esp/resources/tag.rb +5 -0
- data/lib/esp/resources/team.rb +33 -9
- data/lib/esp/resources/user.rb +29 -3
- data/lib/esp/version.rb +1 -1
- data/lib/esp.rb +25 -5
- data/test/esp/aws_clients_test.rb +101 -0
- data/test/esp/extensions/active_resource/formats/json_api_format_test.rb +26 -12
- data/test/esp/extensions/active_resource/paginated_collection_test.rb +93 -72
- data/test/esp/extensions/active_resource/validations_test.rb +2 -12
- data/test/esp/external_account_creator_test.rb +153 -0
- data/test/esp/resources/alert_test.rb +71 -33
- data/test/esp/resources/cloud_trail_event_test.rb +9 -1
- data/test/esp/resources/contact_request_test.rb +8 -0
- data/test/esp/resources/custom_signature_test.rb +8 -0
- data/test/esp/resources/dashboard_test.rb +8 -0
- data/test/esp/resources/external_account_test.rb +8 -0
- data/test/esp/resources/metadata_test.rb +1 -1
- data/test/esp/resources/organization_test.rb +8 -0
- data/test/esp/resources/region_test.rb +12 -4
- data/test/esp/resources/report_test.rb +13 -4
- data/test/esp/resources/resource_test.rb +208 -64
- data/test/esp/resources/service_test.rb +8 -0
- data/test/esp/resources/signature_test.rb +15 -9
- data/test/esp/resources/stat_custom_signature_test.rb +9 -1
- data/test/esp/resources/stat_region_test.rb +23 -1
- data/test/esp/resources/stat_service_test.rb +23 -1
- data/test/esp/resources/stat_signature_test.rb +23 -1
- data/test/esp/resources/stat_test.rb +52 -8
- data/test/esp/resources/sub_organization_test.rb +8 -0
- data/test/esp/resources/suppression/region_test.rb +10 -2
- data/test/esp/resources/suppression/signature_test.rb +10 -2
- data/test/esp/resources/suppression/unique_identifier_test.rb +10 -2
- data/test/esp/resources/suppression_test.rb +74 -14
- data/test/esp/resources/tag_test.rb +9 -1
- data/test/esp/resources/team_test.rb +8 -0
- data/test/esp/resources/user_test.rb +49 -19
- data/test/esp_test.rb +19 -1
- data/test/factories/alerts.rb +70 -0
- data/test/factories/organizations.rb +2 -2
- data/test/factories/regions.rb +1 -1
- data/test/factories/sub_organizations.rb +1 -1
- data/test/factories/suppressions.rb +109 -3
- data/test/factories/users.rb +65 -2
- data/test/test_helper.rb +9 -8
- metadata +41 -69
- data/bin/esp_console +0 -67
- data/rdoc/ActiveResource/Formats.html +0 -178
- data/rdoc/ActiveResource/PaginatedCollection.html +0 -912
- data/rdoc/ActiveResource.html +0 -182
- data/rdoc/ESP/Alert.html +0 -808
- data/rdoc/ESP/CloudTrailEvent.html +0 -377
- data/rdoc/ESP/ContactRequest.html +0 -368
- data/rdoc/ESP/CustomSignature.html +0 -748
- data/rdoc/ESP/Dashboard.html +0 -357
- data/rdoc/ESP/ExternalAccount.html +0 -567
- data/rdoc/ESP/Metadata.html +0 -411
- data/rdoc/ESP/Organization.html +0 -592
- data/rdoc/ESP/Region.html +0 -401
- data/rdoc/ESP/Report.html +0 -624
- data/rdoc/ESP/Service.html +0 -382
- data/rdoc/ESP/Signature.html +0 -557
- data/rdoc/ESP/Stat.html +0 -1780
- data/rdoc/ESP/StatCustomSignature.html +0 -1601
- data/rdoc/ESP/StatRegion.html +0 -1600
- data/rdoc/ESP/StatService.html +0 -1600
- data/rdoc/ESP/StatSignature.html +0 -1600
- data/rdoc/ESP/SubOrganization.html +0 -542
- data/rdoc/ESP/Suppression/Region.html +0 -456
- data/rdoc/ESP/Suppression/Signature.html +0 -472
- data/rdoc/ESP/Suppression/UniqueIdentifier.html +0 -419
- data/rdoc/ESP/Suppression.html +0 -651
- data/rdoc/ESP/Tag.html +0 -373
- data/rdoc/ESP/Team.html +0 -586
- data/rdoc/ESP/User.html +0 -485
- data/rdoc/ESP.html +0 -549
- data/rdoc/README_md.html +0 -503
- data/rdoc/created.rid +0 -31
- data/rdoc/images/add.png +0 -0
- data/rdoc/images/arrow_up.png +0 -0
- data/rdoc/images/brick.png +0 -0
- data/rdoc/images/brick_link.png +0 -0
- data/rdoc/images/bug.png +0 -0
- data/rdoc/images/bullet_black.png +0 -0
- data/rdoc/images/bullet_toggle_minus.png +0 -0
- data/rdoc/images/bullet_toggle_plus.png +0 -0
- data/rdoc/images/date.png +0 -0
- data/rdoc/images/delete.png +0 -0
- data/rdoc/images/find.png +0 -0
- data/rdoc/images/loadingAnimation.gif +0 -0
- data/rdoc/images/macFFBgHack.png +0 -0
- data/rdoc/images/package.png +0 -0
- data/rdoc/images/page_green.png +0 -0
- data/rdoc/images/page_white_text.png +0 -0
- data/rdoc/images/page_white_width.png +0 -0
- data/rdoc/images/plugin.png +0 -0
- data/rdoc/images/ruby.png +0 -0
- data/rdoc/images/tag_blue.png +0 -0
- data/rdoc/images/tag_green.png +0 -0
- data/rdoc/images/transparent.png +0 -0
- data/rdoc/images/wrench.png +0 -0
- data/rdoc/images/wrench_orange.png +0 -0
- data/rdoc/images/zoom.png +0 -0
- data/rdoc/index.html +0 -136
- data/rdoc/js/darkfish.js +0 -155
- data/rdoc/js/jquery.js +0 -4
- data/rdoc/js/navigation.js +0 -142
- data/rdoc/js/search.js +0 -94
- data/rdoc/js/search_index.js +0 -1
- data/rdoc/js/searcher.js +0 -228
- data/rdoc/rdoc.css +0 -595
- data/rdoc/table_of_contents.html +0 -942
|
@@ -1,456 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
-
|
|
7
|
-
<title>class ESP::Suppression::Region - ESPSDK</title>
|
|
8
|
-
|
|
9
|
-
<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
|
|
10
|
-
|
|
11
|
-
<script type="text/javascript">
|
|
12
|
-
var rdoc_rel_prefix = "../../";
|
|
13
|
-
</script>
|
|
14
|
-
|
|
15
|
-
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
16
|
-
<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
|
|
17
|
-
<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
|
|
18
|
-
<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
|
|
19
|
-
<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
|
|
20
|
-
<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<body id="top" class="class">
|
|
24
|
-
<nav id="metadata">
|
|
25
|
-
<nav id="home-section" class="section">
|
|
26
|
-
<h3 class="section-header">
|
|
27
|
-
<a href="../../index.html">Home</a>
|
|
28
|
-
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
29
|
-
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
30
|
-
</h3>
|
|
31
|
-
</nav>
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
-
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
-
<h3 class="section-header">
|
|
37
|
-
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
-
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
-
</h3>
|
|
40
|
-
</form>
|
|
41
|
-
|
|
42
|
-
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
-
</nav>
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
<div id="file-metadata">
|
|
49
|
-
<nav id="file-list-section" class="section">
|
|
50
|
-
<h3 class="section-header">Defined In</h3>
|
|
51
|
-
<ul>
|
|
52
|
-
<li>lib/esp/resources/suppression/region.rb
|
|
53
|
-
</ul>
|
|
54
|
-
</nav>
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
</div>
|
|
58
|
-
|
|
59
|
-
<div id="class-metadata">
|
|
60
|
-
|
|
61
|
-
<nav id="parent-class-section" class="section">
|
|
62
|
-
<h3 class="section-header">Parent</h3>
|
|
63
|
-
|
|
64
|
-
<p class="link">ESP::Resource
|
|
65
|
-
|
|
66
|
-
</nav>
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
<!-- Method Quickref -->
|
|
71
|
-
<nav id="method-list-section" class="section">
|
|
72
|
-
<h3 class="section-header">Methods</h3>
|
|
73
|
-
|
|
74
|
-
<ul class="link-list">
|
|
75
|
-
|
|
76
|
-
<li ><a href="#method-c-create">::create</a>
|
|
77
|
-
|
|
78
|
-
<li ><a href="#method-c-find">::find</a>
|
|
79
|
-
|
|
80
|
-
<li ><a href="#method-i-destroy">#destroy</a>
|
|
81
|
-
|
|
82
|
-
<li ><a href="#method-i-save">#save</a>
|
|
83
|
-
|
|
84
|
-
<li ><a href="#method-i-update">#update</a>
|
|
85
|
-
|
|
86
|
-
</ul>
|
|
87
|
-
</nav>
|
|
88
|
-
|
|
89
|
-
</div>
|
|
90
|
-
|
|
91
|
-
<div id="project-metadata">
|
|
92
|
-
<nav id="fileindex-section" class="section project-section">
|
|
93
|
-
<h3 class="section-header">Pages</h3>
|
|
94
|
-
|
|
95
|
-
<ul>
|
|
96
|
-
|
|
97
|
-
<li class="file"><a href="../../README_md.html">README</a>
|
|
98
|
-
|
|
99
|
-
</ul>
|
|
100
|
-
</nav>
|
|
101
|
-
|
|
102
|
-
<nav id="classindex-section" class="section project-section">
|
|
103
|
-
<h3 class="section-header">Class and Module Index</h3>
|
|
104
|
-
|
|
105
|
-
<ul class="link-list">
|
|
106
|
-
|
|
107
|
-
<li><a href="../../ActiveResource.html">ActiveResource</a>
|
|
108
|
-
|
|
109
|
-
<li><a href="../../ActiveResource/Formats.html">ActiveResource::Formats</a>
|
|
110
|
-
|
|
111
|
-
<li><a href="../../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
|
|
112
|
-
|
|
113
|
-
<li><a href="../../ESP.html">ESP</a>
|
|
114
|
-
|
|
115
|
-
<li><a href="../../ESP/Alert.html">ESP::Alert</a>
|
|
116
|
-
|
|
117
|
-
<li><a href="../../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
|
|
118
|
-
|
|
119
|
-
<li><a href="../../ESP/ContactRequest.html">ESP::ContactRequest</a>
|
|
120
|
-
|
|
121
|
-
<li><a href="../../ESP/CustomSignature.html">ESP::CustomSignature</a>
|
|
122
|
-
|
|
123
|
-
<li><a href="../../ESP/Dashboard.html">ESP::Dashboard</a>
|
|
124
|
-
|
|
125
|
-
<li><a href="../../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
|
|
126
|
-
|
|
127
|
-
<li><a href="../../ESP/Metadata.html">ESP::Metadata</a>
|
|
128
|
-
|
|
129
|
-
<li><a href="../../ESP/Organization.html">ESP::Organization</a>
|
|
130
|
-
|
|
131
|
-
<li><a href="../../ESP/Region.html">ESP::Region</a>
|
|
132
|
-
|
|
133
|
-
<li><a href="../../ESP/Report.html">ESP::Report</a>
|
|
134
|
-
|
|
135
|
-
<li><a href="../../ESP/Service.html">ESP::Service</a>
|
|
136
|
-
|
|
137
|
-
<li><a href="../../ESP/Signature.html">ESP::Signature</a>
|
|
138
|
-
|
|
139
|
-
<li><a href="../../ESP/Stat.html">ESP::Stat</a>
|
|
140
|
-
|
|
141
|
-
<li><a href="../../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
|
|
142
|
-
|
|
143
|
-
<li><a href="../../ESP/StatRegion.html">ESP::StatRegion</a>
|
|
144
|
-
|
|
145
|
-
<li><a href="../../ESP/StatService.html">ESP::StatService</a>
|
|
146
|
-
|
|
147
|
-
<li><a href="../../ESP/StatSignature.html">ESP::StatSignature</a>
|
|
148
|
-
|
|
149
|
-
<li><a href="../../ESP/SubOrganization.html">ESP::SubOrganization</a>
|
|
150
|
-
|
|
151
|
-
<li><a href="../../ESP/Suppression.html">ESP::Suppression</a>
|
|
152
|
-
|
|
153
|
-
<li><a href="../../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
|
|
154
|
-
|
|
155
|
-
<li><a href="../../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
|
|
156
|
-
|
|
157
|
-
<li><a href="../../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
|
|
158
|
-
|
|
159
|
-
<li><a href="../../ESP/Tag.html">ESP::Tag</a>
|
|
160
|
-
|
|
161
|
-
<li><a href="../../ESP/Team.html">ESP::Team</a>
|
|
162
|
-
|
|
163
|
-
<li><a href="../../ESP/User.html">ESP::User</a>
|
|
164
|
-
|
|
165
|
-
</ul>
|
|
166
|
-
</nav>
|
|
167
|
-
|
|
168
|
-
</div>
|
|
169
|
-
</nav>
|
|
170
|
-
|
|
171
|
-
<div id="documentation">
|
|
172
|
-
<h1 class="class">class ESP::Suppression::Region</h1>
|
|
173
|
-
|
|
174
|
-
<div id="description" class="description">
|
|
175
|
-
|
|
176
|
-
</div><!-- description -->
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
<!-- Methods -->
|
|
191
|
-
|
|
192
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
193
|
-
<h3 class="section-header">Public Class Methods</h3>
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
<div id="method-c-create" class="method-detail ">
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
<div class="method-heading">
|
|
200
|
-
<span class="method-callseq">
|
|
201
|
-
create(attributes={})
|
|
202
|
-
</span>
|
|
203
|
-
|
|
204
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
205
|
-
|
|
206
|
-
</div>
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
<div class="method-description">
|
|
211
|
-
|
|
212
|
-
<p>Create a suppression for a region.</p>
|
|
213
|
-
|
|
214
|
-
<p>If you pass an <code>alert_id</code>, include the <code>reason</code> and
|
|
215
|
-
all other params will be ignored, and the suppression will be created based
|
|
216
|
-
on that alert.</p>
|
|
217
|
-
|
|
218
|
-
<h4 id="method-c-create-label-Parameter">Parameter<span><a href="#method-c-create-label-Parameter">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
219
|
-
|
|
220
|
-
<p><code>attributes</code> | Required | A hash of region suppression
|
|
221
|
-
attributes</p>
|
|
222
|
-
|
|
223
|
-
<h5 id="method-c-create-label-Valid+Attributes+When+Not+Creating+for+Alert">Valid Attributes When Not Creating for <a href="../Alert.html">Alert</a><span><a href="#method-c-create-label-Valid+Attributes+When+Not+Creating+for+Alert">¶</a> <a href="#documentation">↑</a></span></h5>
|
|
224
|
-
|
|
225
|
-
<p><code>regions</code> | Required | An array of region names to suppress.</p>
|
|
226
|
-
|
|
227
|
-
<p><code>external_account_ids</code> | Required | An Array of the external
|
|
228
|
-
accounts identified by <code>external_account_id</code> to suppress the
|
|
229
|
-
signature or custom signature on.</p>
|
|
230
|
-
|
|
231
|
-
<p><code>resource</code> | Not Required | The resource string this suppression
|
|
232
|
-
will suppress alerts for.</p>
|
|
233
|
-
|
|
234
|
-
<p><code>reason</code> | Required | The reason for creating the suppression.</p>
|
|
235
|
-
|
|
236
|
-
<h4 id="method-c-create-label-Example">Example<span><a href="#method-c-create-label-Example">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
237
|
-
|
|
238
|
-
<pre>create(regions: ['us_east_1'], external_account_ids: [5], reason: 'My very good reason for creating this suppression')</pre>
|
|
239
|
-
|
|
240
|
-
<h5 id="method-c-create-label-Valid+Attributes+When+Creating+for+Alert">Valid Attributes When Creating for <a href="../Alert.html">Alert</a><span><a href="#method-c-create-label-Valid+Attributes+When+Creating+for+Alert">¶</a> <a href="#documentation">↑</a></span></h5>
|
|
241
|
-
|
|
242
|
-
<p><code>alert_id</code> | Required | The id for the alert you want to create
|
|
243
|
-
a suppression for.</p>
|
|
244
|
-
|
|
245
|
-
<p><code>reason</code> | Required | The reason for creating the suppression.</p>
|
|
246
|
-
|
|
247
|
-
<h4 id="method-c-create-label-Example">Example<span><a href="#method-c-create-label-Example">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
248
|
-
|
|
249
|
-
<pre>create(alert_id: 5, reason: 'My very good reason for creating this suppression')</pre>
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
<div class="method-source-code" id="create-source">
|
|
255
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/suppression/region.rb, line 69</span>
|
|
256
|
-
</pre>
|
|
257
|
-
</div><!-- create-source -->
|
|
258
|
-
|
|
259
|
-
</div>
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
</div><!-- create-method -->
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
<div id="method-c-find" class="method-detail ">
|
|
268
|
-
|
|
269
|
-
<div class="method-heading">
|
|
270
|
-
<span class="method-name">find</span><span
|
|
271
|
-
class="method-args">(*)</span>
|
|
272
|
-
|
|
273
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
274
|
-
|
|
275
|
-
</div>
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
<div class="method-description">
|
|
279
|
-
|
|
280
|
-
<p>Not Implemented. You cannot search for <a
|
|
281
|
-
href="Region.html">Suppression::Region</a>.</p>
|
|
282
|
-
|
|
283
|
-
<p>Regular ARELlike methods are disabled. Use the <a
|
|
284
|
-
href="../Suppression.html">ESP::Suppression</a> object to search
|
|
285
|
-
suppressions.</p>
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
<div class="method-source-code" id="find-source">
|
|
291
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/suppression/region.rb, line 9</span>
|
|
292
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">find</span>(<span class="ruby-operator">*</span>)
|
|
293
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>, <span class="ruby-string">'Regular ARELlike methods are disabled. Use the ESP::Suppression object to search suppressions'</span>
|
|
294
|
-
<span class="ruby-keyword">end</span></pre>
|
|
295
|
-
</div><!-- find-source -->
|
|
296
|
-
|
|
297
|
-
</div>
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
</div><!-- find-method -->
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
</section><!-- public-class-method-details -->
|
|
306
|
-
|
|
307
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
308
|
-
<h3 class="section-header">Public Instance Methods</h3>
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
<div id="method-i-destroy" class="method-detail ">
|
|
312
|
-
|
|
313
|
-
<div class="method-heading">
|
|
314
|
-
<span class="method-name">destroy</span><span
|
|
315
|
-
class="method-args">()</span>
|
|
316
|
-
|
|
317
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
318
|
-
|
|
319
|
-
</div>
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
<div class="method-description">
|
|
323
|
-
|
|
324
|
-
<p>Not Implemented. You cannot destroy a <a
|
|
325
|
-
href="Region.html">Suppression::Region</a>.</p>
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
<div class="method-source-code" id="destroy-source">
|
|
331
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/suppression/region.rb, line 19</span>
|
|
332
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
|
|
333
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
|
|
334
|
-
<span class="ruby-keyword">end</span></pre>
|
|
335
|
-
</div><!-- destroy-source -->
|
|
336
|
-
|
|
337
|
-
</div>
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
</div><!-- destroy-method -->
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
<div id="method-i-save" class="method-detail ">
|
|
346
|
-
|
|
347
|
-
<div class="method-heading">
|
|
348
|
-
<span class="method-name">save</span><span
|
|
349
|
-
class="method-args">()</span>
|
|
350
|
-
|
|
351
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
352
|
-
|
|
353
|
-
</div>
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
<div class="method-description">
|
|
357
|
-
|
|
358
|
-
<p>Create a suppression for a region.</p>
|
|
359
|
-
|
|
360
|
-
<p>If you set an <code>alert_id</code>, set the <code>reason</code> and all
|
|
361
|
-
other params will be ignored, and the suppression will be created based on
|
|
362
|
-
that alert.</p>
|
|
363
|
-
|
|
364
|
-
<h5 id="method-i-save-label-Valid+Attributes+When+Not+Creating+for+Alert">Valid Attributes When Not Creating for <a href="../Alert.html">Alert</a><span><a href="#method-i-save-label-Valid+Attributes+When+Not+Creating+for+Alert">¶</a> <a href="#documentation">↑</a></span></h5>
|
|
365
|
-
|
|
366
|
-
<p><code>regions</code> | Required | An array of region names to suppress.</p>
|
|
367
|
-
|
|
368
|
-
<p><code>external_account_ids</code> | Required | An Array of the external
|
|
369
|
-
accounts identified by <code>external_account_id</code> to suppress the
|
|
370
|
-
signature or custom signature on.</p>
|
|
371
|
-
|
|
372
|
-
<p><code>resource</code> | Not Required | The resource string this suppression
|
|
373
|
-
will suppress alerts for.</p>
|
|
374
|
-
|
|
375
|
-
<p><code>reason</code> | Required | The reason for creating the suppression.</p>
|
|
376
|
-
|
|
377
|
-
<h4 id="method-i-save-label-Example">Example<span><a href="#method-i-save-label-Example">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
378
|
-
|
|
379
|
-
<pre>suppression = new(regions: ['us_east_1'], external_account_ids: [5], reason: 'My very good reason for creating this suppression')
|
|
380
|
-
suppression.save</pre>
|
|
381
|
-
|
|
382
|
-
<h5 id="method-i-save-label-Valid+Attributes+When+Creating+for+Alert">Valid Attributes When Creating for <a href="../Alert.html">Alert</a><span><a href="#method-i-save-label-Valid+Attributes+When+Creating+for+Alert">¶</a> <a href="#documentation">↑</a></span></h5>
|
|
383
|
-
|
|
384
|
-
<p><code>alert_id</code> | Required | The id for the alert you want to create
|
|
385
|
-
a suppression for.</p>
|
|
386
|
-
|
|
387
|
-
<p><code>reason</code> | Required | The reason for creating the suppression.</p>
|
|
388
|
-
|
|
389
|
-
<h4 id="method-i-save-label-Example">Example<span><a href="#method-i-save-label-Example">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
390
|
-
|
|
391
|
-
<pre>suppression = new(alert_id: 5, reason: 'My very good reason for creating this suppression')
|
|
392
|
-
suppression.save</pre>
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
<div class="method-source-code" id="save-source">
|
|
398
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/suppression/region.rb, line 97</span>
|
|
399
|
-
</pre>
|
|
400
|
-
</div><!-- save-source -->
|
|
401
|
-
|
|
402
|
-
</div>
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
</div><!-- save-method -->
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
<div id="method-i-update" class="method-detail ">
|
|
411
|
-
|
|
412
|
-
<div class="method-heading">
|
|
413
|
-
<span class="method-name">update</span><span
|
|
414
|
-
class="method-args">()</span>
|
|
415
|
-
|
|
416
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
417
|
-
|
|
418
|
-
</div>
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
<div class="method-description">
|
|
422
|
-
|
|
423
|
-
<p>Not Implemented. You cannot update a <a
|
|
424
|
-
href="Region.html">Suppression::Region</a>.</p>
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
<div class="method-source-code" id="update-source">
|
|
430
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/suppression/region.rb, line 14</span>
|
|
431
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span>
|
|
432
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
|
|
433
|
-
<span class="ruby-keyword">end</span></pre>
|
|
434
|
-
</div><!-- update-source -->
|
|
435
|
-
|
|
436
|
-
</div>
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
</div><!-- update-method -->
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
</section><!-- public-instance-method-details -->
|
|
445
|
-
|
|
446
|
-
</section><!-- 5Buntitled-5D -->
|
|
447
|
-
|
|
448
|
-
</div><!-- documentation -->
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
<footer id="validator-badges">
|
|
452
|
-
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
453
|
-
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
|
|
454
|
-
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
455
|
-
</footer>
|
|
456
|
-
|