aws-sdk-docdb 1.27.0 → 1.32.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +173 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-docdb.rb +3 -3
- data/lib/aws-sdk-docdb/client.rb +901 -138
- data/lib/aws-sdk-docdb/client_api.rb +347 -3
- data/lib/aws-sdk-docdb/errors.rb +144 -1
- data/lib/aws-sdk-docdb/resource.rb +1 -1
- data/lib/aws-sdk-docdb/types.rb +1099 -179
- data/lib/aws-sdk-docdb/waiters.rb +1 -1
- metadata +11 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b3998afe129ee7241ced46d83b5ee5d5e52a62f45a6c45e9091bea8ed20e4637
|
4
|
+
data.tar.gz: a8281d1392b241e57e02b622cea935f4ae3ef3d1f40a95702226dcee09bfc0d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f6714135645702e748093ce234f2ddf2b842524405119ff6e28df28c9b47ed93bb2ea617f1b15787158ef630987eb10fdc64f9fe542197bb3ab131f9c6eb5c4f
|
7
|
+
data.tar.gz: '03388e21c16d5256e3dedc9d958d5347b5ca183ae52a2bc0ac1179ba4fb806bd3fdc630a9f4cc9502ae74c2c95ace382ea5738aad4f740686c97faffb9cbf483'
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,173 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.32.0 (2021-06-23)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - DocumentDB documentation-only edits
|
8
|
+
|
9
|
+
1.31.0 (2021-06-02)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This SDK release adds support for DocDB global clusters.
|
13
|
+
|
14
|
+
1.30.0 (2021-03-29)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release adds support for Event Subscriptions to DocumentDB.
|
18
|
+
|
19
|
+
1.29.0 (2021-03-10)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
24
|
+
1.28.0 (2021-02-02)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
28
|
+
|
29
|
+
1.27.0 (2020-12-04)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Support `pre_signed_url` generation for `CopyDBClusterSnapshot` and `CreateDBCluster`.
|
33
|
+
|
34
|
+
1.26.0 (2020-10-19)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Documentation updates for docdb
|
38
|
+
|
39
|
+
1.25.0 (2020-09-30)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
43
|
+
|
44
|
+
1.24.0 (2020-09-25)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Documentation updates for docdb
|
48
|
+
|
49
|
+
1.23.0 (2020-09-15)
|
50
|
+
------------------
|
51
|
+
|
52
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
53
|
+
|
54
|
+
1.22.0 (2020-09-14)
|
55
|
+
------------------
|
56
|
+
|
57
|
+
* Feature - Updated API documentation and added paginators for DescribeCertificates, DescribeDBClusterParameterGroups, DescribeDBClusterParameters, DescribeDBClusterSnapshots and DescribePendingMaintenanceActions
|
58
|
+
|
59
|
+
1.21.0 (2020-08-25)
|
60
|
+
------------------
|
61
|
+
|
62
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
63
|
+
|
64
|
+
1.20.0 (2020-07-02)
|
65
|
+
------------------
|
66
|
+
|
67
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
68
|
+
|
69
|
+
1.19.0 (2020-06-23)
|
70
|
+
------------------
|
71
|
+
|
72
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
73
|
+
|
74
|
+
1.18.1 (2020-06-11)
|
75
|
+
------------------
|
76
|
+
|
77
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
78
|
+
|
79
|
+
1.18.0 (2020-06-10)
|
80
|
+
------------------
|
81
|
+
|
82
|
+
* Issue - This version has been yanked. (#2327).
|
83
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
84
|
+
|
85
|
+
1.17.0 (2020-05-28)
|
86
|
+
------------------
|
87
|
+
|
88
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
89
|
+
|
90
|
+
1.16.0 (2020-05-07)
|
91
|
+
------------------
|
92
|
+
|
93
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
94
|
+
|
95
|
+
1.15.0 (2020-03-09)
|
96
|
+
------------------
|
97
|
+
|
98
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
99
|
+
|
100
|
+
1.14.0 (2020-02-24)
|
101
|
+
------------------
|
102
|
+
|
103
|
+
* Feature - Documentation updates for docdb
|
104
|
+
|
105
|
+
1.13.0 (2020-02-10)
|
106
|
+
------------------
|
107
|
+
|
108
|
+
* Feature - Added clarifying information that Amazon DocumentDB shares operational technology with Amazon RDS and Amazon Neptune.
|
109
|
+
|
110
|
+
1.12.0 (2019-10-23)
|
111
|
+
------------------
|
112
|
+
|
113
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
114
|
+
|
115
|
+
1.11.0 (2019-10-01)
|
116
|
+
------------------
|
117
|
+
|
118
|
+
* Feature - This release provides support for describe and modify CA certificates.
|
119
|
+
|
120
|
+
1.10.0 (2019-07-25)
|
121
|
+
------------------
|
122
|
+
|
123
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
124
|
+
|
125
|
+
1.9.0 (2019-07-01)
|
126
|
+
------------------
|
127
|
+
|
128
|
+
* Feature - This release provides support for cluster delete protection and the ability to stop and start clusters.
|
129
|
+
|
130
|
+
1.8.0 (2019-06-17)
|
131
|
+
------------------
|
132
|
+
|
133
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
134
|
+
|
135
|
+
1.7.0 (2019-05-21)
|
136
|
+
------------------
|
137
|
+
|
138
|
+
* Feature - API update.
|
139
|
+
|
140
|
+
1.6.0 (2019-05-15)
|
141
|
+
------------------
|
142
|
+
|
143
|
+
* Feature - API update.
|
144
|
+
|
145
|
+
1.5.0 (2019-05-14)
|
146
|
+
------------------
|
147
|
+
|
148
|
+
* Feature - API update.
|
149
|
+
|
150
|
+
1.4.0 (2019-03-22)
|
151
|
+
------------------
|
152
|
+
|
153
|
+
* Feature - API update.
|
154
|
+
|
155
|
+
1.3.0 (2019-03-21)
|
156
|
+
------------------
|
157
|
+
|
158
|
+
* Feature - API update.
|
159
|
+
|
160
|
+
1.2.0 (2019-03-18)
|
161
|
+
------------------
|
162
|
+
|
163
|
+
* Feature - API update.
|
164
|
+
|
165
|
+
1.1.0 (2019-03-14)
|
166
|
+
------------------
|
167
|
+
|
168
|
+
* Feature - API update.
|
169
|
+
|
170
|
+
1.0.0 (2019-01-09)
|
171
|
+
------------------
|
172
|
+
|
173
|
+
* Feature - Initial release of `aws-sdk-docdb`.
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.32.0
|
data/lib/aws-sdk-docdb.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -29,7 +29,7 @@ require_relative 'aws-sdk-docdb/customizations'
|
|
29
29
|
# structure.
|
30
30
|
#
|
31
31
|
# doc_db = Aws::DocDB::Client.new
|
32
|
-
# resp = doc_db.
|
32
|
+
# resp = doc_db.add_source_identifier_to_subscription(params)
|
33
33
|
#
|
34
34
|
# See {Client} for more information.
|
35
35
|
#
|
@@ -49,6 +49,6 @@ require_relative 'aws-sdk-docdb/customizations'
|
|
49
49
|
# @!group service
|
50
50
|
module Aws::DocDB
|
51
51
|
|
52
|
-
GEM_VERSION = '1.
|
52
|
+
GEM_VERSION = '1.32.0'
|
53
53
|
|
54
54
|
end
|
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -329,10 +329,67 @@ module Aws::DocDB
|
|
329
329
|
|
330
330
|
# @!group API Operations
|
331
331
|
|
332
|
+
# Adds a source identifier to an existing event notification
|
333
|
+
# subscription.
|
334
|
+
#
|
335
|
+
# @option params [required, String] :subscription_name
|
336
|
+
# The name of the Amazon DocumentDB event notification subscription that
|
337
|
+
# you want to add a source identifier to.
|
338
|
+
#
|
339
|
+
# @option params [required, String] :source_identifier
|
340
|
+
# The identifier of the event source to be added:
|
341
|
+
#
|
342
|
+
# * If the source type is an instance, a `DBInstanceIdentifier` must be
|
343
|
+
# provided.
|
344
|
+
#
|
345
|
+
# * If the source type is a security group, a `DBSecurityGroupName` must
|
346
|
+
# be provided.
|
347
|
+
#
|
348
|
+
# * If the source type is a parameter group, a `DBParameterGroupName`
|
349
|
+
# must be provided.
|
350
|
+
#
|
351
|
+
# * If the source type is a snapshot, a `DBSnapshotIdentifier` must be
|
352
|
+
# provided.
|
353
|
+
#
|
354
|
+
# @return [Types::AddSourceIdentifierToSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
355
|
+
#
|
356
|
+
# * {Types::AddSourceIdentifierToSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription
|
357
|
+
#
|
358
|
+
# @example Request syntax with placeholder values
|
359
|
+
#
|
360
|
+
# resp = client.add_source_identifier_to_subscription({
|
361
|
+
# subscription_name: "String", # required
|
362
|
+
# source_identifier: "String", # required
|
363
|
+
# })
|
364
|
+
#
|
365
|
+
# @example Response structure
|
366
|
+
#
|
367
|
+
# resp.event_subscription.customer_aws_id #=> String
|
368
|
+
# resp.event_subscription.cust_subscription_id #=> String
|
369
|
+
# resp.event_subscription.sns_topic_arn #=> String
|
370
|
+
# resp.event_subscription.status #=> String
|
371
|
+
# resp.event_subscription.subscription_creation_time #=> String
|
372
|
+
# resp.event_subscription.source_type #=> String
|
373
|
+
# resp.event_subscription.source_ids_list #=> Array
|
374
|
+
# resp.event_subscription.source_ids_list[0] #=> String
|
375
|
+
# resp.event_subscription.event_categories_list #=> Array
|
376
|
+
# resp.event_subscription.event_categories_list[0] #=> String
|
377
|
+
# resp.event_subscription.enabled #=> Boolean
|
378
|
+
# resp.event_subscription.event_subscription_arn #=> String
|
379
|
+
#
|
380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddSourceIdentifierToSubscription AWS API Documentation
|
381
|
+
#
|
382
|
+
# @overload add_source_identifier_to_subscription(params = {})
|
383
|
+
# @param [Hash] params ({})
|
384
|
+
def add_source_identifier_to_subscription(params = {}, options = {})
|
385
|
+
req = build_request(:add_source_identifier_to_subscription, params)
|
386
|
+
req.send_request(options)
|
387
|
+
end
|
388
|
+
|
332
389
|
# Adds metadata tags to an Amazon DocumentDB resource. You can use these
|
333
390
|
# tags with cost allocation reporting to track costs that are associated
|
334
|
-
# with Amazon DocumentDB resources
|
335
|
-
#
|
391
|
+
# with Amazon DocumentDB resources or in a `Condition` statement in an
|
392
|
+
# Identity and Access Management (IAM) policy for Amazon DocumentDB.
|
336
393
|
#
|
337
394
|
# @option params [required, String] :resource_name
|
338
395
|
# The Amazon DocumentDB resource that the tags are added to. This value
|
@@ -432,11 +489,11 @@ module Aws::DocDB
|
|
432
489
|
#
|
433
490
|
# * Must specify a valid cluster parameter group.
|
434
491
|
#
|
435
|
-
# * If the source cluster parameter group is in the same
|
436
|
-
#
|
492
|
+
# * If the source cluster parameter group is in the same Region as the
|
493
|
+
# copy, specify a valid parameter group identifier; for example,
|
437
494
|
# `my-db-cluster-param-group`, or a valid ARN.
|
438
495
|
#
|
439
|
-
# * If the source parameter group is in a different
|
496
|
+
# * If the source parameter group is in a different Region than the
|
440
497
|
# copy, specify a valid cluster parameter group ARN; for example,
|
441
498
|
# `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
|
442
499
|
#
|
@@ -500,7 +557,7 @@ module Aws::DocDB
|
|
500
557
|
# To copy a cluster snapshot from a shared manual cluster snapshot,
|
501
558
|
# `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
|
502
559
|
# (ARN) of the shared cluster snapshot. You can only copy a shared DB
|
503
|
-
# cluster snapshot, whether encrypted or not, in the same
|
560
|
+
# cluster snapshot, whether encrypted or not, in the same Region.
|
504
561
|
#
|
505
562
|
# To cancel the copy operation after it is in progress, delete the
|
506
563
|
# target cluster snapshot identified by
|
@@ -515,10 +572,10 @@ module Aws::DocDB
|
|
515
572
|
#
|
516
573
|
# * Must specify a valid system snapshot in the *available* state.
|
517
574
|
#
|
518
|
-
# * If the source snapshot is in the same
|
519
|
-
#
|
575
|
+
# * If the source snapshot is in the same Region as the copy, specify a
|
576
|
+
# valid snapshot identifier.
|
520
577
|
#
|
521
|
-
# * If the source snapshot is in a different
|
578
|
+
# * If the source snapshot is in a different Region than the copy,
|
522
579
|
# specify a valid cluster snapshot ARN.
|
523
580
|
#
|
524
581
|
# Example: `my-cluster-snapshot1`
|
@@ -538,54 +595,53 @@ module Aws::DocDB
|
|
538
595
|
# Example: `my-cluster-snapshot2`
|
539
596
|
#
|
540
597
|
# @option params [String] :kms_key_id
|
541
|
-
# The
|
542
|
-
#
|
543
|
-
#
|
598
|
+
# The KMS key ID for an encrypted cluster snapshot. The KMS key ID is
|
599
|
+
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
600
|
+
# alias for the KMS encryption key.
|
544
601
|
#
|
545
|
-
# If you copy an encrypted cluster snapshot from your
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
549
|
-
#
|
602
|
+
# If you copy an encrypted cluster snapshot from your account, you can
|
603
|
+
# specify a value for `KmsKeyId` to encrypt the copy with a new KMS
|
604
|
+
# encryption key. If you don't specify a value for `KmsKeyId`, then the
|
605
|
+
# copy of the cluster snapshot is encrypted with the same KMS key as the
|
606
|
+
# source cluster snapshot.
|
550
607
|
#
|
551
608
|
# If you copy an encrypted cluster snapshot that is shared from another
|
552
|
-
#
|
609
|
+
# account, then you must specify a value for `KmsKeyId`.
|
553
610
|
#
|
554
|
-
# To copy an encrypted cluster snapshot to another
|
555
|
-
# `KmsKeyId` to the
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
# AWS Region.
|
611
|
+
# To copy an encrypted cluster snapshot to another Region, set
|
612
|
+
# `KmsKeyId` to the KMS key ID that you want to use to encrypt the copy
|
613
|
+
# of the cluster snapshot in the destination Region. KMS encryption keys
|
614
|
+
# are specific to the Region that they are created in, and you can't
|
615
|
+
# use encryption keys from one Region in another Region.
|
560
616
|
#
|
561
617
|
# If you copy an unencrypted cluster snapshot and specify a value for
|
562
618
|
# the `KmsKeyId` parameter, an error is returned.
|
563
619
|
#
|
564
620
|
# @option params [String] :pre_signed_url
|
565
|
-
# The URL that contains a Signature Version 4 signed request for
|
566
|
-
# `CopyDBClusterSnapshot` API action in the
|
621
|
+
# The URL that contains a Signature Version 4 signed request for
|
622
|
+
# the`CopyDBClusterSnapshot` API action in the Region that contains the
|
567
623
|
# source cluster snapshot to copy. You must use the `PreSignedUrl`
|
568
|
-
# parameter when copying a cluster snapshot from another
|
624
|
+
# parameter when copying a cluster snapshot from another Region.
|
569
625
|
#
|
570
|
-
# If you are using an
|
571
|
-
# `SourceRegion` (or `--source-region` for the
|
626
|
+
# If you are using an Amazon Web Services SDK tool or the CLI, you can
|
627
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
572
628
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
573
629
|
# autogenerates a pre-signed URL that is a valid request for the
|
574
|
-
# operation that can be executed in the source
|
630
|
+
# operation that can be executed in the source Region.
|
575
631
|
#
|
576
632
|
# The presigned URL must be a valid request for the
|
577
633
|
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
578
|
-
#
|
579
|
-
#
|
634
|
+
# Region that contains the cluster snapshot to be copied. The presigned
|
635
|
+
# URL request must contain the following parameter values:
|
580
636
|
#
|
581
637
|
# * `SourceRegion` - The ID of the region that contains the snapshot to
|
582
638
|
# be copied.
|
583
639
|
#
|
584
640
|
# * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
|
585
641
|
# encrypted cluster snapshot to be copied. This identifier must be in
|
586
|
-
# the Amazon Resource Name (ARN) format for the source
|
642
|
+
# the Amazon Resource Name (ARN) format for the source Region. For
|
587
643
|
# example, if you are copying an encrypted cluster snapshot from the
|
588
|
-
# us-east-1
|
644
|
+
# us-east-1 Region, then your `SourceDBClusterSnapshotIdentifier`
|
589
645
|
# looks something like the following:
|
590
646
|
# `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
|
591
647
|
#
|
@@ -709,16 +765,16 @@ module Aws::DocDB
|
|
709
765
|
# Valid values: `docdb`
|
710
766
|
#
|
711
767
|
# @option params [String] :engine_version
|
712
|
-
# The version number of the database engine to use. The
|
713
|
-
# will default to the latest major engine version.
|
714
|
-
# workloads, we recommend explicitly declaring this
|
715
|
-
# intended major engine version.
|
768
|
+
# The version number of the database engine to use. The
|
769
|
+
# `--engine-version` will default to the latest major engine version.
|
770
|
+
# For production workloads, we recommend explicitly declaring this
|
771
|
+
# parameter with the intended major engine version.
|
716
772
|
#
|
717
773
|
# @option params [Integer] :port
|
718
774
|
# The port number on which the instances in the cluster accept
|
719
775
|
# connections.
|
720
776
|
#
|
721
|
-
# @option params [
|
777
|
+
# @option params [String] :master_username
|
722
778
|
# The name of the master user for the cluster.
|
723
779
|
#
|
724
780
|
# Constraints:
|
@@ -729,7 +785,7 @@ module Aws::DocDB
|
|
729
785
|
#
|
730
786
|
# * Cannot be a reserved word for the chosen database engine.
|
731
787
|
#
|
732
|
-
# @option params [
|
788
|
+
# @option params [String] :master_user_password
|
733
789
|
# The password for the master database user. This password can contain
|
734
790
|
# any printable ASCII character except forward slash (/), double quote
|
735
791
|
# ("), or the "at" symbol (@).
|
@@ -742,7 +798,7 @@ module Aws::DocDB
|
|
742
798
|
# parameter.
|
743
799
|
#
|
744
800
|
# The default is a 30-minute window selected at random from an 8-hour
|
745
|
-
# block of time for each
|
801
|
+
# block of time for each Region.
|
746
802
|
#
|
747
803
|
# Constraints:
|
748
804
|
#
|
@@ -761,8 +817,7 @@ module Aws::DocDB
|
|
761
817
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
762
818
|
#
|
763
819
|
# The default is a 30-minute window selected at random from an 8-hour
|
764
|
-
# block of time for each
|
765
|
-
# week.
|
820
|
+
# block of time for each Region, occurring on a random day of the week.
|
766
821
|
#
|
767
822
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
768
823
|
#
|
@@ -775,13 +830,13 @@ module Aws::DocDB
|
|
775
830
|
# Specifies whether the cluster is encrypted.
|
776
831
|
#
|
777
832
|
# @option params [String] :kms_key_id
|
778
|
-
# The
|
833
|
+
# The KMS key identifier for an encrypted cluster.
|
779
834
|
#
|
780
|
-
# The
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
835
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
836
|
+
# encryption key. If you are creating a cluster using the same account
|
837
|
+
# that owns the KMS encryption key that is used to encrypt the new
|
838
|
+
# cluster, you can use the KMS key alias instead of the ARN for the KMS
|
839
|
+
# encryption key.
|
785
840
|
#
|
786
841
|
# If an encryption key is not specified in `KmsKeyId`\:
|
787
842
|
#
|
@@ -790,9 +845,8 @@ module Aws::DocDB
|
|
790
845
|
#
|
791
846
|
# ^
|
792
847
|
#
|
793
|
-
#
|
794
|
-
#
|
795
|
-
# Region.
|
848
|
+
# KMS creates the default encryption key for your account. Your account
|
849
|
+
# has a different default encryption key for each Regions.
|
796
850
|
#
|
797
851
|
# @option params [String] :pre_signed_url
|
798
852
|
# Not currently supported.
|
@@ -814,6 +868,9 @@ module Aws::DocDB
|
|
814
868
|
# `DeletionProtection` is disabled. `DeletionProtection` protects
|
815
869
|
# clusters from being accidentally deleted.
|
816
870
|
#
|
871
|
+
# @option params [String] :global_cluster_identifier
|
872
|
+
# The cluster identifier of the new global cluster.
|
873
|
+
#
|
817
874
|
# @option params [String] :source_region
|
818
875
|
# The source region of the snapshot. This is only needed when the
|
819
876
|
# shapshot is encrypted and in a different region.
|
@@ -834,8 +891,8 @@ module Aws::DocDB
|
|
834
891
|
# engine: "String", # required
|
835
892
|
# engine_version: "String",
|
836
893
|
# port: 1,
|
837
|
-
# master_username: "String",
|
838
|
-
# master_user_password: "String",
|
894
|
+
# master_username: "String",
|
895
|
+
# master_user_password: "String",
|
839
896
|
# preferred_backup_window: "String",
|
840
897
|
# preferred_maintenance_window: "String",
|
841
898
|
# tags: [
|
@@ -849,6 +906,7 @@ module Aws::DocDB
|
|
849
906
|
# pre_signed_url: "String",
|
850
907
|
# enable_cloudwatch_logs_exports: ["String"],
|
851
908
|
# deletion_protection: false,
|
909
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
852
910
|
# source_region: "String",
|
853
911
|
# })
|
854
912
|
#
|
@@ -873,6 +931,9 @@ module Aws::DocDB
|
|
873
931
|
# resp.db_cluster.master_username #=> String
|
874
932
|
# resp.db_cluster.preferred_backup_window #=> String
|
875
933
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
934
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
935
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
936
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
876
937
|
# resp.db_cluster.db_cluster_members #=> Array
|
877
938
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
878
939
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -1090,7 +1151,7 @@ module Aws::DocDB
|
|
1090
1151
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
1091
1152
|
#
|
1092
1153
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1093
|
-
#
|
1154
|
+
# Region.
|
1094
1155
|
#
|
1095
1156
|
# Example: `us-east-1d`
|
1096
1157
|
#
|
@@ -1101,18 +1162,17 @@ module Aws::DocDB
|
|
1101
1162
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1102
1163
|
#
|
1103
1164
|
# The default is a 30-minute window selected at random from an 8-hour
|
1104
|
-
# block of time for each
|
1105
|
-
# week.
|
1165
|
+
# block of time for each Region, occurring on a random day of the week.
|
1106
1166
|
#
|
1107
1167
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1108
1168
|
#
|
1109
1169
|
# Constraints: Minimum 30-minute window.
|
1110
1170
|
#
|
1111
1171
|
# @option params [Boolean] :auto_minor_version_upgrade
|
1112
|
-
#
|
1113
|
-
#
|
1172
|
+
# This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
|
1173
|
+
# does not perform minor version upgrades regardless of the value set.
|
1114
1174
|
#
|
1115
|
-
# Default: `
|
1175
|
+
# Default: `false`
|
1116
1176
|
#
|
1117
1177
|
# @option params [Array<Types::Tag>] :tags
|
1118
1178
|
# The tags to be assigned to the instance. You can assign up to 10 tags
|
@@ -1225,7 +1285,7 @@ module Aws::DocDB
|
|
1225
1285
|
end
|
1226
1286
|
|
1227
1287
|
# Creates a new subnet group. subnet groups must contain at least one
|
1228
|
-
# subnet in at least two Availability Zones in the
|
1288
|
+
# subnet in at least two Availability Zones in the Region.
|
1229
1289
|
#
|
1230
1290
|
# @option params [required, String] :db_subnet_group_name
|
1231
1291
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -1284,6 +1344,214 @@ module Aws::DocDB
|
|
1284
1344
|
req.send_request(options)
|
1285
1345
|
end
|
1286
1346
|
|
1347
|
+
# Creates an Amazon DocumentDB event notification subscription. This
|
1348
|
+
# action requires a topic Amazon Resource Name (ARN) created by using
|
1349
|
+
# the Amazon DocumentDB console, the Amazon SNS console, or the Amazon
|
1350
|
+
# SNS API. To obtain an ARN with Amazon SNS, you must create a topic in
|
1351
|
+
# Amazon SNS and subscribe to the topic. The ARN is displayed in the
|
1352
|
+
# Amazon SNS console.
|
1353
|
+
#
|
1354
|
+
# You can specify the type of source (`SourceType`) that you want to be
|
1355
|
+
# notified of. You can also provide a list of Amazon DocumentDB sources
|
1356
|
+
# (`SourceIds`) that trigger the events, and you can provide a list of
|
1357
|
+
# event categories (`EventCategories`) for events that you want to be
|
1358
|
+
# notified of. For example, you can specify `SourceType = db-instance`,
|
1359
|
+
# `SourceIds = mydbinstance1, mydbinstance2` and `EventCategories =
|
1360
|
+
# Availability, Backup`.
|
1361
|
+
#
|
1362
|
+
# If you specify both the `SourceType` and `SourceIds` (such as
|
1363
|
+
# `SourceType = db-instance` and `SourceIdentifier = myDBInstance1`),
|
1364
|
+
# you are notified of all the `db-instance` events for the specified
|
1365
|
+
# source. If you specify a `SourceType` but do not specify a
|
1366
|
+
# `SourceIdentifier`, you receive notice of the events for that source
|
1367
|
+
# type for all your Amazon DocumentDB sources. If you do not specify
|
1368
|
+
# either the `SourceType` or the `SourceIdentifier`, you are notified of
|
1369
|
+
# events generated from all Amazon DocumentDB sources belonging to your
|
1370
|
+
# customer account.
|
1371
|
+
#
|
1372
|
+
# @option params [required, String] :subscription_name
|
1373
|
+
# The name of the subscription.
|
1374
|
+
#
|
1375
|
+
# Constraints: The name must be fewer than 255 characters.
|
1376
|
+
#
|
1377
|
+
# @option params [required, String] :sns_topic_arn
|
1378
|
+
# The Amazon Resource Name (ARN) of the SNS topic created for event
|
1379
|
+
# notification. Amazon SNS creates the ARN when you create a topic and
|
1380
|
+
# subscribe to it.
|
1381
|
+
#
|
1382
|
+
# @option params [String] :source_type
|
1383
|
+
# The type of source that is generating the events. For example, if you
|
1384
|
+
# want to be notified of events generated by an instance, you would set
|
1385
|
+
# this parameter to `db-instance`. If this value is not specified, all
|
1386
|
+
# events are returned.
|
1387
|
+
#
|
1388
|
+
# Valid values: `db-instance`, `db-cluster`, `db-parameter-group`,
|
1389
|
+
# `db-security-group`, `db-cluster-snapshot`
|
1390
|
+
#
|
1391
|
+
# @option params [Array<String>] :event_categories
|
1392
|
+
# A list of event categories for a `SourceType` that you want to
|
1393
|
+
# subscribe to.
|
1394
|
+
#
|
1395
|
+
# @option params [Array<String>] :source_ids
|
1396
|
+
# The list of identifiers of the event sources for which events are
|
1397
|
+
# returned. If not specified, then all sources are included in the
|
1398
|
+
# response. An identifier must begin with a letter and must contain only
|
1399
|
+
# ASCII letters, digits, and hyphens; it can't end with a hyphen or
|
1400
|
+
# contain two consecutive hyphens.
|
1401
|
+
#
|
1402
|
+
# Constraints:
|
1403
|
+
#
|
1404
|
+
# * If `SourceIds` are provided, `SourceType` must also be provided.
|
1405
|
+
#
|
1406
|
+
# * If the source type is an instance, a `DBInstanceIdentifier` must be
|
1407
|
+
# provided.
|
1408
|
+
#
|
1409
|
+
# * If the source type is a security group, a `DBSecurityGroupName` must
|
1410
|
+
# be provided.
|
1411
|
+
#
|
1412
|
+
# * If the source type is a parameter group, a `DBParameterGroupName`
|
1413
|
+
# must be provided.
|
1414
|
+
#
|
1415
|
+
# * If the source type is a snapshot, a `DBSnapshotIdentifier` must be
|
1416
|
+
# provided.
|
1417
|
+
#
|
1418
|
+
# @option params [Boolean] :enabled
|
1419
|
+
# A Boolean value; set to `true` to activate the subscription, set to
|
1420
|
+
# `false` to create the subscription but not active it.
|
1421
|
+
#
|
1422
|
+
# @option params [Array<Types::Tag>] :tags
|
1423
|
+
# The tags to be assigned to the event subscription.
|
1424
|
+
#
|
1425
|
+
# @return [Types::CreateEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1426
|
+
#
|
1427
|
+
# * {Types::CreateEventSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription
|
1428
|
+
#
|
1429
|
+
# @example Request syntax with placeholder values
|
1430
|
+
#
|
1431
|
+
# resp = client.create_event_subscription({
|
1432
|
+
# subscription_name: "String", # required
|
1433
|
+
# sns_topic_arn: "String", # required
|
1434
|
+
# source_type: "String",
|
1435
|
+
# event_categories: ["String"],
|
1436
|
+
# source_ids: ["String"],
|
1437
|
+
# enabled: false,
|
1438
|
+
# tags: [
|
1439
|
+
# {
|
1440
|
+
# key: "String",
|
1441
|
+
# value: "String",
|
1442
|
+
# },
|
1443
|
+
# ],
|
1444
|
+
# })
|
1445
|
+
#
|
1446
|
+
# @example Response structure
|
1447
|
+
#
|
1448
|
+
# resp.event_subscription.customer_aws_id #=> String
|
1449
|
+
# resp.event_subscription.cust_subscription_id #=> String
|
1450
|
+
# resp.event_subscription.sns_topic_arn #=> String
|
1451
|
+
# resp.event_subscription.status #=> String
|
1452
|
+
# resp.event_subscription.subscription_creation_time #=> String
|
1453
|
+
# resp.event_subscription.source_type #=> String
|
1454
|
+
# resp.event_subscription.source_ids_list #=> Array
|
1455
|
+
# resp.event_subscription.source_ids_list[0] #=> String
|
1456
|
+
# resp.event_subscription.event_categories_list #=> Array
|
1457
|
+
# resp.event_subscription.event_categories_list[0] #=> String
|
1458
|
+
# resp.event_subscription.enabled #=> Boolean
|
1459
|
+
# resp.event_subscription.event_subscription_arn #=> String
|
1460
|
+
#
|
1461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateEventSubscription AWS API Documentation
|
1462
|
+
#
|
1463
|
+
# @overload create_event_subscription(params = {})
|
1464
|
+
# @param [Hash] params ({})
|
1465
|
+
def create_event_subscription(params = {}, options = {})
|
1466
|
+
req = build_request(:create_event_subscription, params)
|
1467
|
+
req.send_request(options)
|
1468
|
+
end
|
1469
|
+
|
1470
|
+
# Creates an Amazon DocumentDB global cluster that can span multiple
|
1471
|
+
# multiple Regions. The global cluster contains one primary cluster with
|
1472
|
+
# read-write capability, and up-to give read-only secondary clusters.
|
1473
|
+
# Global clusters uses storage-based fast replication across regions
|
1474
|
+
# with latencies less than one second, using dedicated infrastructure
|
1475
|
+
# with no impact to your workload’s performance.
|
1476
|
+
#
|
1477
|
+
#
|
1478
|
+
#
|
1479
|
+
# You can create a global cluster that is initially empty, and then add
|
1480
|
+
# a primary and a secondary to it. Or you can specify an existing
|
1481
|
+
# cluster during the create operation, and this cluster becomes the
|
1482
|
+
# primary of the global cluster.
|
1483
|
+
#
|
1484
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
1485
|
+
#
|
1486
|
+
# </note>
|
1487
|
+
#
|
1488
|
+
# @option params [required, String] :global_cluster_identifier
|
1489
|
+
# The cluster identifier of the new global cluster.
|
1490
|
+
#
|
1491
|
+
# @option params [String] :source_db_cluster_identifier
|
1492
|
+
# The Amazon Resource Name (ARN) to use as the primary cluster of the
|
1493
|
+
# global cluster. This parameter is optional.
|
1494
|
+
#
|
1495
|
+
# @option params [String] :engine
|
1496
|
+
# The name of the database engine to be used for this cluster.
|
1497
|
+
#
|
1498
|
+
# @option params [String] :engine_version
|
1499
|
+
# The engine version of the global cluster.
|
1500
|
+
#
|
1501
|
+
# @option params [Boolean] :deletion_protection
|
1502
|
+
# The deletion protection setting for the new global cluster. The global
|
1503
|
+
# cluster can't be deleted when deletion protection is enabled.
|
1504
|
+
#
|
1505
|
+
# @option params [String] :database_name
|
1506
|
+
# The name for your database of up to 64 alpha-numeric characters. If
|
1507
|
+
# you do not provide a name, Amazon DocumentDB will not create a
|
1508
|
+
# database in the global cluster you are creating.
|
1509
|
+
#
|
1510
|
+
# @option params [Boolean] :storage_encrypted
|
1511
|
+
# The storage encryption setting for the new global cluster.
|
1512
|
+
#
|
1513
|
+
# @return [Types::CreateGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1514
|
+
#
|
1515
|
+
# * {Types::CreateGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
1516
|
+
#
|
1517
|
+
# @example Request syntax with placeholder values
|
1518
|
+
#
|
1519
|
+
# resp = client.create_global_cluster({
|
1520
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
1521
|
+
# source_db_cluster_identifier: "String",
|
1522
|
+
# engine: "String",
|
1523
|
+
# engine_version: "String",
|
1524
|
+
# deletion_protection: false,
|
1525
|
+
# database_name: "String",
|
1526
|
+
# storage_encrypted: false,
|
1527
|
+
# })
|
1528
|
+
#
|
1529
|
+
# @example Response structure
|
1530
|
+
#
|
1531
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
1532
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
1533
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
1534
|
+
# resp.global_cluster.status #=> String
|
1535
|
+
# resp.global_cluster.engine #=> String
|
1536
|
+
# resp.global_cluster.engine_version #=> String
|
1537
|
+
# resp.global_cluster.database_name #=> String
|
1538
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
1539
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
1540
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
1541
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
1542
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
1543
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
1544
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
1545
|
+
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateGlobalCluster AWS API Documentation
|
1547
|
+
#
|
1548
|
+
# @overload create_global_cluster(params = {})
|
1549
|
+
# @param [Hash] params ({})
|
1550
|
+
def create_global_cluster(params = {}, options = {})
|
1551
|
+
req = build_request(:create_global_cluster, params)
|
1552
|
+
req.send_request(options)
|
1553
|
+
end
|
1554
|
+
|
1287
1555
|
# Deletes a previously provisioned cluster. When you delete a cluster,
|
1288
1556
|
# all automated backups for that cluster are deleted and can't be
|
1289
1557
|
# recovered. Manual DB cluster snapshots of the specified cluster are
|
@@ -1362,6 +1630,9 @@ module Aws::DocDB
|
|
1362
1630
|
# resp.db_cluster.master_username #=> String
|
1363
1631
|
# resp.db_cluster.preferred_backup_window #=> String
|
1364
1632
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
1633
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
1634
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
1635
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
1365
1636
|
# resp.db_cluster.db_cluster_members #=> Array
|
1366
1637
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
1367
1638
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -1607,8 +1878,95 @@ module Aws::DocDB
|
|
1607
1878
|
req.send_request(options)
|
1608
1879
|
end
|
1609
1880
|
|
1881
|
+
# Deletes an Amazon DocumentDB event notification subscription.
|
1882
|
+
#
|
1883
|
+
# @option params [required, String] :subscription_name
|
1884
|
+
# The name of the Amazon DocumentDB event notification subscription that
|
1885
|
+
# you want to delete.
|
1886
|
+
#
|
1887
|
+
# @return [Types::DeleteEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1888
|
+
#
|
1889
|
+
# * {Types::DeleteEventSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription
|
1890
|
+
#
|
1891
|
+
# @example Request syntax with placeholder values
|
1892
|
+
#
|
1893
|
+
# resp = client.delete_event_subscription({
|
1894
|
+
# subscription_name: "String", # required
|
1895
|
+
# })
|
1896
|
+
#
|
1897
|
+
# @example Response structure
|
1898
|
+
#
|
1899
|
+
# resp.event_subscription.customer_aws_id #=> String
|
1900
|
+
# resp.event_subscription.cust_subscription_id #=> String
|
1901
|
+
# resp.event_subscription.sns_topic_arn #=> String
|
1902
|
+
# resp.event_subscription.status #=> String
|
1903
|
+
# resp.event_subscription.subscription_creation_time #=> String
|
1904
|
+
# resp.event_subscription.source_type #=> String
|
1905
|
+
# resp.event_subscription.source_ids_list #=> Array
|
1906
|
+
# resp.event_subscription.source_ids_list[0] #=> String
|
1907
|
+
# resp.event_subscription.event_categories_list #=> Array
|
1908
|
+
# resp.event_subscription.event_categories_list[0] #=> String
|
1909
|
+
# resp.event_subscription.enabled #=> Boolean
|
1910
|
+
# resp.event_subscription.event_subscription_arn #=> String
|
1911
|
+
#
|
1912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteEventSubscription AWS API Documentation
|
1913
|
+
#
|
1914
|
+
# @overload delete_event_subscription(params = {})
|
1915
|
+
# @param [Hash] params ({})
|
1916
|
+
def delete_event_subscription(params = {}, options = {})
|
1917
|
+
req = build_request(:delete_event_subscription, params)
|
1918
|
+
req.send_request(options)
|
1919
|
+
end
|
1920
|
+
|
1921
|
+
# Deletes a global cluster. The primary and secondary clusters must
|
1922
|
+
# already be detached or deleted before attempting to delete a global
|
1923
|
+
# cluster.
|
1924
|
+
#
|
1925
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
1926
|
+
#
|
1927
|
+
# </note>
|
1928
|
+
#
|
1929
|
+
# @option params [required, String] :global_cluster_identifier
|
1930
|
+
# The cluster identifier of the global cluster being deleted.
|
1931
|
+
#
|
1932
|
+
# @return [Types::DeleteGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1933
|
+
#
|
1934
|
+
# * {Types::DeleteGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
1935
|
+
#
|
1936
|
+
# @example Request syntax with placeholder values
|
1937
|
+
#
|
1938
|
+
# resp = client.delete_global_cluster({
|
1939
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
1940
|
+
# })
|
1941
|
+
#
|
1942
|
+
# @example Response structure
|
1943
|
+
#
|
1944
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
1945
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
1946
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
1947
|
+
# resp.global_cluster.status #=> String
|
1948
|
+
# resp.global_cluster.engine #=> String
|
1949
|
+
# resp.global_cluster.engine_version #=> String
|
1950
|
+
# resp.global_cluster.database_name #=> String
|
1951
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
1952
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
1953
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
1954
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
1955
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
1956
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
1957
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
1958
|
+
#
|
1959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteGlobalCluster AWS API Documentation
|
1960
|
+
#
|
1961
|
+
# @overload delete_global_cluster(params = {})
|
1962
|
+
# @param [Hash] params ({})
|
1963
|
+
def delete_global_cluster(params = {}, options = {})
|
1964
|
+
req = build_request(:delete_global_cluster, params)
|
1965
|
+
req.send_request(options)
|
1966
|
+
end
|
1967
|
+
|
1610
1968
|
# Returns a list of certificate authority (CA) certificates provided by
|
1611
|
-
# Amazon DocumentDB for this
|
1969
|
+
# Amazon DocumentDB for this account.
|
1612
1970
|
#
|
1613
1971
|
# @option params [String] :certificate_identifier
|
1614
1972
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -1843,12 +2201,12 @@ module Aws::DocDB
|
|
1843
2201
|
# Returns a list of cluster snapshot attribute names and values for a
|
1844
2202
|
# manual DB cluster snapshot.
|
1845
2203
|
#
|
1846
|
-
# When you share snapshots with other
|
2204
|
+
# When you share snapshots with other accounts,
|
1847
2205
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
1848
|
-
# and a list of IDs for the
|
2206
|
+
# and a list of IDs for the accounts that are authorized to copy or
|
1849
2207
|
# restore the manual cluster snapshot. If `all` is included in the list
|
1850
2208
|
# of values for the `restore` attribute, then the manual cluster
|
1851
|
-
# snapshot is public and can be copied or restored by all
|
2209
|
+
# snapshot is public and can be copied or restored by all accounts.
|
1852
2210
|
#
|
1853
2211
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
1854
2212
|
# The identifier for the cluster snapshot to describe the attributes
|
@@ -1913,13 +2271,13 @@ module Aws::DocDB
|
|
1913
2271
|
# the following values:
|
1914
2272
|
#
|
1915
2273
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
1916
|
-
# has automatically created for your
|
2274
|
+
# has automatically created for your account.
|
1917
2275
|
#
|
1918
2276
|
# * `manual` - Return all cluster snapshots that you have manually
|
1919
|
-
# created for your
|
2277
|
+
# created for your account.
|
1920
2278
|
#
|
1921
2279
|
# * `shared` - Return all manual cluster snapshots that have been shared
|
1922
|
-
# to your
|
2280
|
+
# to your account.
|
1923
2281
|
#
|
1924
2282
|
# * `public` - Return all cluster snapshots that have been marked as
|
1925
2283
|
# public.
|
@@ -1928,7 +2286,7 @@ module Aws::DocDB
|
|
1928
2286
|
# manual cluster snapshots are returned. You can include shared cluster
|
1929
2287
|
# snapshots with these results by setting the `IncludeShared` parameter
|
1930
2288
|
# to `true`. You can include public cluster snapshots with these results
|
1931
|
-
# by setting the
|
2289
|
+
# by setting the`IncludePublic` parameter to `true`.
|
1932
2290
|
#
|
1933
2291
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
1934
2292
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -1956,13 +2314,13 @@ module Aws::DocDB
|
|
1956
2314
|
#
|
1957
2315
|
# @option params [Boolean] :include_shared
|
1958
2316
|
# Set to `true` to include shared manual cluster snapshots from other
|
1959
|
-
#
|
1960
|
-
#
|
2317
|
+
# accounts that this account has been given permission to copy or
|
2318
|
+
# restore, and otherwise `false`. The default is `false`.
|
1961
2319
|
#
|
1962
2320
|
# @option params [Boolean] :include_public
|
1963
2321
|
# Set to `true` to include manual cluster snapshots that are public and
|
1964
|
-
# can be copied or restored by any
|
1965
|
-
#
|
2322
|
+
# can be copied or restored by any account, and otherwise `false`. The
|
2323
|
+
# default is `false`.
|
1966
2324
|
#
|
1967
2325
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1968
2326
|
#
|
@@ -2109,6 +2467,9 @@ module Aws::DocDB
|
|
2109
2467
|
# resp.db_clusters[0].master_username #=> String
|
2110
2468
|
# resp.db_clusters[0].preferred_backup_window #=> String
|
2111
2469
|
# resp.db_clusters[0].preferred_maintenance_window #=> String
|
2470
|
+
# resp.db_clusters[0].replication_source_identifier #=> String
|
2471
|
+
# resp.db_clusters[0].read_replica_identifiers #=> Array
|
2472
|
+
# resp.db_clusters[0].read_replica_identifiers[0] #=> String
|
2112
2473
|
# resp.db_clusters[0].db_cluster_members #=> Array
|
2113
2474
|
# resp.db_clusters[0].db_cluster_members[0].db_instance_identifier #=> String
|
2114
2475
|
# resp.db_clusters[0].db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -2530,8 +2891,7 @@ module Aws::DocDB
|
|
2530
2891
|
# @option params [String] :source_type
|
2531
2892
|
# The type of source that is generating the events.
|
2532
2893
|
#
|
2533
|
-
# Valid values: `db-instance`, `db-parameter-group`,
|
2534
|
-
# `db-security-group`, `db-snapshot`
|
2894
|
+
# Valid values: `db-instance`, `db-parameter-group`, `db-security-group`
|
2535
2895
|
#
|
2536
2896
|
# @option params [Array<Types::Filter>] :filters
|
2537
2897
|
# This parameter is not currently supported.
|
@@ -2568,6 +2928,83 @@ module Aws::DocDB
|
|
2568
2928
|
req.send_request(options)
|
2569
2929
|
end
|
2570
2930
|
|
2931
|
+
# Lists all the subscription descriptions for a customer account. The
|
2932
|
+
# description for a subscription includes `SubscriptionName`,
|
2933
|
+
# `SNSTopicARN`, `CustomerID`, `SourceType`, `SourceID`, `CreationTime`,
|
2934
|
+
# and `Status`.
|
2935
|
+
#
|
2936
|
+
# If you specify a `SubscriptionName`, lists the description for that
|
2937
|
+
# subscription.
|
2938
|
+
#
|
2939
|
+
# @option params [String] :subscription_name
|
2940
|
+
# The name of the Amazon DocumentDB event notification subscription that
|
2941
|
+
# you want to describe.
|
2942
|
+
#
|
2943
|
+
# @option params [Array<Types::Filter>] :filters
|
2944
|
+
# This parameter is not currently supported.
|
2945
|
+
#
|
2946
|
+
# @option params [Integer] :max_records
|
2947
|
+
# The maximum number of records to include in the response. If more
|
2948
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
2949
|
+
# token (marker) is included in the response so that the remaining
|
2950
|
+
# results can be retrieved.
|
2951
|
+
#
|
2952
|
+
# Default: 100
|
2953
|
+
#
|
2954
|
+
# Constraints: Minimum 20, maximum 100.
|
2955
|
+
#
|
2956
|
+
# @option params [String] :marker
|
2957
|
+
# An optional pagination token provided by a previous request. If this
|
2958
|
+
# parameter is specified, the response includes only records beyond the
|
2959
|
+
# marker, up to the value specified by `MaxRecords`.
|
2960
|
+
#
|
2961
|
+
# @return [Types::EventSubscriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2962
|
+
#
|
2963
|
+
# * {Types::EventSubscriptionsMessage#marker #marker} => String
|
2964
|
+
# * {Types::EventSubscriptionsMessage#event_subscriptions_list #event_subscriptions_list} => Array<Types::EventSubscription>
|
2965
|
+
#
|
2966
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2967
|
+
#
|
2968
|
+
# @example Request syntax with placeholder values
|
2969
|
+
#
|
2970
|
+
# resp = client.describe_event_subscriptions({
|
2971
|
+
# subscription_name: "String",
|
2972
|
+
# filters: [
|
2973
|
+
# {
|
2974
|
+
# name: "String", # required
|
2975
|
+
# values: ["String"], # required
|
2976
|
+
# },
|
2977
|
+
# ],
|
2978
|
+
# max_records: 1,
|
2979
|
+
# marker: "String",
|
2980
|
+
# })
|
2981
|
+
#
|
2982
|
+
# @example Response structure
|
2983
|
+
#
|
2984
|
+
# resp.marker #=> String
|
2985
|
+
# resp.event_subscriptions_list #=> Array
|
2986
|
+
# resp.event_subscriptions_list[0].customer_aws_id #=> String
|
2987
|
+
# resp.event_subscriptions_list[0].cust_subscription_id #=> String
|
2988
|
+
# resp.event_subscriptions_list[0].sns_topic_arn #=> String
|
2989
|
+
# resp.event_subscriptions_list[0].status #=> String
|
2990
|
+
# resp.event_subscriptions_list[0].subscription_creation_time #=> String
|
2991
|
+
# resp.event_subscriptions_list[0].source_type #=> String
|
2992
|
+
# resp.event_subscriptions_list[0].source_ids_list #=> Array
|
2993
|
+
# resp.event_subscriptions_list[0].source_ids_list[0] #=> String
|
2994
|
+
# resp.event_subscriptions_list[0].event_categories_list #=> Array
|
2995
|
+
# resp.event_subscriptions_list[0].event_categories_list[0] #=> String
|
2996
|
+
# resp.event_subscriptions_list[0].enabled #=> Boolean
|
2997
|
+
# resp.event_subscriptions_list[0].event_subscription_arn #=> String
|
2998
|
+
#
|
2999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventSubscriptions AWS API Documentation
|
3000
|
+
#
|
3001
|
+
# @overload describe_event_subscriptions(params = {})
|
3002
|
+
# @param [Hash] params ({})
|
3003
|
+
def describe_event_subscriptions(params = {}, options = {})
|
3004
|
+
req = build_request(:describe_event_subscriptions, params)
|
3005
|
+
req.send_request(options)
|
3006
|
+
end
|
3007
|
+
|
2571
3008
|
# Returns events related to instances, security groups, snapshots, and
|
2572
3009
|
# DB parameter groups for the past 14 days. You can obtain events
|
2573
3010
|
# specific to a particular DB instance, security group, snapshot, or
|
@@ -2687,6 +3124,86 @@ module Aws::DocDB
|
|
2687
3124
|
req.send_request(options)
|
2688
3125
|
end
|
2689
3126
|
|
3127
|
+
# Returns information about Amazon DocumentDB global clusters. This API
|
3128
|
+
# supports pagination.
|
3129
|
+
#
|
3130
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
3131
|
+
#
|
3132
|
+
# </note>
|
3133
|
+
#
|
3134
|
+
# @option params [String] :global_cluster_identifier
|
3135
|
+
# The user-supplied cluster identifier. If this parameter is specified,
|
3136
|
+
# information from only the specific cluster is returned. This parameter
|
3137
|
+
# isn't case-sensitive.
|
3138
|
+
#
|
3139
|
+
# @option params [Array<Types::Filter>] :filters
|
3140
|
+
# A filter that specifies one or more global DB clusters to describe.
|
3141
|
+
#
|
3142
|
+
# Supported filters: `db-cluster-id` accepts cluster identifiers and
|
3143
|
+
# cluster Amazon Resource Names (ARNs). The results list will only
|
3144
|
+
# include information about the clusters identified by these ARNs.
|
3145
|
+
#
|
3146
|
+
# @option params [Integer] :max_records
|
3147
|
+
# The maximum number of records to include in the response. If more
|
3148
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
3149
|
+
# token called a marker is included in the response so that you can
|
3150
|
+
# retrieve the remaining results.
|
3151
|
+
#
|
3152
|
+
# @option params [String] :marker
|
3153
|
+
# An optional pagination token provided by a previous
|
3154
|
+
# `DescribeGlobalClusters` request. If this parameter is specified, the
|
3155
|
+
# response includes only records beyond the marker, up to the value
|
3156
|
+
# specified by `MaxRecords`.
|
3157
|
+
#
|
3158
|
+
# @return [Types::GlobalClustersMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3159
|
+
#
|
3160
|
+
# * {Types::GlobalClustersMessage#marker #marker} => String
|
3161
|
+
# * {Types::GlobalClustersMessage#global_clusters #global_clusters} => Array<Types::GlobalCluster>
|
3162
|
+
#
|
3163
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3164
|
+
#
|
3165
|
+
# @example Request syntax with placeholder values
|
3166
|
+
#
|
3167
|
+
# resp = client.describe_global_clusters({
|
3168
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
3169
|
+
# filters: [
|
3170
|
+
# {
|
3171
|
+
# name: "String", # required
|
3172
|
+
# values: ["String"], # required
|
3173
|
+
# },
|
3174
|
+
# ],
|
3175
|
+
# max_records: 1,
|
3176
|
+
# marker: "String",
|
3177
|
+
# })
|
3178
|
+
#
|
3179
|
+
# @example Response structure
|
3180
|
+
#
|
3181
|
+
# resp.marker #=> String
|
3182
|
+
# resp.global_clusters #=> Array
|
3183
|
+
# resp.global_clusters[0].global_cluster_identifier #=> String
|
3184
|
+
# resp.global_clusters[0].global_cluster_resource_id #=> String
|
3185
|
+
# resp.global_clusters[0].global_cluster_arn #=> String
|
3186
|
+
# resp.global_clusters[0].status #=> String
|
3187
|
+
# resp.global_clusters[0].engine #=> String
|
3188
|
+
# resp.global_clusters[0].engine_version #=> String
|
3189
|
+
# resp.global_clusters[0].database_name #=> String
|
3190
|
+
# resp.global_clusters[0].storage_encrypted #=> Boolean
|
3191
|
+
# resp.global_clusters[0].deletion_protection #=> Boolean
|
3192
|
+
# resp.global_clusters[0].global_cluster_members #=> Array
|
3193
|
+
# resp.global_clusters[0].global_cluster_members[0].db_cluster_arn #=> String
|
3194
|
+
# resp.global_clusters[0].global_cluster_members[0].readers #=> Array
|
3195
|
+
# resp.global_clusters[0].global_cluster_members[0].readers[0] #=> String
|
3196
|
+
# resp.global_clusters[0].global_cluster_members[0].is_writer #=> Boolean
|
3197
|
+
#
|
3198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeGlobalClusters AWS API Documentation
|
3199
|
+
#
|
3200
|
+
# @overload describe_global_clusters(params = {})
|
3201
|
+
# @param [Hash] params ({})
|
3202
|
+
def describe_global_clusters(params = {}, options = {})
|
3203
|
+
req = build_request(:describe_global_clusters, params)
|
3204
|
+
req.send_request(options)
|
3205
|
+
end
|
3206
|
+
|
2690
3207
|
# Returns a list of orderable instance options for the specified engine.
|
2691
3208
|
#
|
2692
3209
|
# @option params [required, String] :engine
|
@@ -2909,6 +3426,9 @@ module Aws::DocDB
|
|
2909
3426
|
# resp.db_cluster.master_username #=> String
|
2910
3427
|
# resp.db_cluster.preferred_backup_window #=> String
|
2911
3428
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
3429
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
3430
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
3431
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
2912
3432
|
# resp.db_cluster.db_cluster_members #=> Array
|
2913
3433
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
2914
3434
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -3063,7 +3583,7 @@ module Aws::DocDB
|
|
3063
3583
|
# parameter.
|
3064
3584
|
#
|
3065
3585
|
# The default is a 30-minute window selected at random from an 8-hour
|
3066
|
-
# block of time for each
|
3586
|
+
# block of time for each Region.
|
3067
3587
|
#
|
3068
3588
|
# Constraints:
|
3069
3589
|
#
|
@@ -3082,8 +3602,7 @@ module Aws::DocDB
|
|
3082
3602
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
3083
3603
|
#
|
3084
3604
|
# The default is a 30-minute window selected at random from an 8-hour
|
3085
|
-
# block of time for each
|
3086
|
-
# week.
|
3605
|
+
# block of time for each Region, occurring on a random day of the week.
|
3087
3606
|
#
|
3088
3607
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
3089
3608
|
#
|
@@ -3097,9 +3616,8 @@ module Aws::DocDB
|
|
3097
3616
|
#
|
3098
3617
|
# @option params [String] :engine_version
|
3099
3618
|
# The version number of the database engine to which you want to
|
3100
|
-
# upgrade.
|
3101
|
-
#
|
3102
|
-
# `ApplyImmediately` parameter is set to `true`.
|
3619
|
+
# upgrade. Modifying engine version is not supported on Amazon
|
3620
|
+
# DocumentDB.
|
3103
3621
|
#
|
3104
3622
|
# @option params [Boolean] :deletion_protection
|
3105
3623
|
# Specifies whether this cluster can be deleted. If `DeletionProtection`
|
@@ -3153,6 +3671,9 @@ module Aws::DocDB
|
|
3153
3671
|
# resp.db_cluster.master_username #=> String
|
3154
3672
|
# resp.db_cluster.preferred_backup_window #=> String
|
3155
3673
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
3674
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
3675
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
3676
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
3156
3677
|
# resp.db_cluster.db_cluster_members #=> Array
|
3157
3678
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
3158
3679
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -3247,19 +3768,19 @@ module Aws::DocDB
|
|
3247
3768
|
end
|
3248
3769
|
|
3249
3770
|
# Adds an attribute and values to, or removes an attribute and values
|
3250
|
-
# from, a manual
|
3771
|
+
# from, a manual cluster snapshot.
|
3251
3772
|
#
|
3252
|
-
# To share a manual cluster snapshot with other
|
3773
|
+
# To share a manual cluster snapshot with other accounts, specify
|
3253
3774
|
# `restore` as the `AttributeName`, and use the `ValuesToAdd` parameter
|
3254
|
-
# to add a list of IDs of the
|
3255
|
-
#
|
3256
|
-
#
|
3257
|
-
#
|
3258
|
-
#
|
3259
|
-
#
|
3260
|
-
#
|
3261
|
-
#
|
3262
|
-
#
|
3775
|
+
# to add a list of IDs of the accounts that are authorized to restore
|
3776
|
+
# the manual cluster snapshot. Use the value `all` to make the manual
|
3777
|
+
# cluster snapshot public, which means that it can be copied or restored
|
3778
|
+
# by all accounts. Do not add the `all` value for any manual cluster
|
3779
|
+
# snapshots that contain private information that you don't want
|
3780
|
+
# available to all accounts. If a manual cluster snapshot is encrypted,
|
3781
|
+
# it can be shared, but only by specifying a list of authorized account
|
3782
|
+
# IDs for the `ValuesToAdd` parameter. You can't use `all` as a value
|
3783
|
+
# for that parameter in this case.
|
3263
3784
|
#
|
3264
3785
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
3265
3786
|
# The identifier for the cluster snapshot to modify the attributes for.
|
@@ -3267,31 +3788,30 @@ module Aws::DocDB
|
|
3267
3788
|
# @option params [required, String] :attribute_name
|
3268
3789
|
# The name of the cluster snapshot attribute to modify.
|
3269
3790
|
#
|
3270
|
-
# To manage authorization for other
|
3271
|
-
#
|
3791
|
+
# To manage authorization for other accounts to copy or restore a manual
|
3792
|
+
# cluster snapshot, set this value to `restore`.
|
3272
3793
|
#
|
3273
3794
|
# @option params [Array<String>] :values_to_add
|
3274
3795
|
# A list of cluster snapshot attributes to add to the attribute
|
3275
3796
|
# specified by `AttributeName`.
|
3276
3797
|
#
|
3277
|
-
# To authorize other
|
3278
|
-
# snapshot, set this list to include one or more
|
3279
|
-
#
|
3280
|
-
#
|
3798
|
+
# To authorize other accounts to copy or restore a manual cluster
|
3799
|
+
# snapshot, set this list to include one or more account IDs. To make
|
3800
|
+
# the manual cluster snapshot restorable by any account, set it to
|
3801
|
+
# `all`. Do not add the `all` value for any manual cluster snapshots
|
3281
3802
|
# that contain private information that you don't want to be available
|
3282
|
-
# to all
|
3803
|
+
# to all accounts.
|
3283
3804
|
#
|
3284
3805
|
# @option params [Array<String>] :values_to_remove
|
3285
3806
|
# A list of cluster snapshot attributes to remove from the attribute
|
3286
3807
|
# specified by `AttributeName`.
|
3287
3808
|
#
|
3288
|
-
# To remove authorization for other
|
3289
|
-
#
|
3290
|
-
#
|
3291
|
-
#
|
3292
|
-
#
|
3293
|
-
#
|
3294
|
-
# snapshot.
|
3809
|
+
# To remove authorization for other accounts to copy or restore a manual
|
3810
|
+
# cluster snapshot, set this list to include one or more account
|
3811
|
+
# identifiers. To remove authorization for any account to copy or
|
3812
|
+
# restore the cluster snapshot, set it to `all` . If you specify `all`,
|
3813
|
+
# an account whose account ID is explicitly added to the `restore`
|
3814
|
+
# attribute can still copy or restore a manual cluster snapshot.
|
3295
3815
|
#
|
3296
3816
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3297
3817
|
#
|
@@ -3338,8 +3858,7 @@ module Aws::DocDB
|
|
3338
3858
|
#
|
3339
3859
|
# @option params [String] :db_instance_class
|
3340
3860
|
# The new compute and memory capacity of the instance; for example,
|
3341
|
-
# `db.r5.large`. Not all instance classes are available in all
|
3342
|
-
# Regions.
|
3861
|
+
# `db.r5.large`. Not all instance classes are available in all Regions.
|
3343
3862
|
#
|
3344
3863
|
# If you modify the instance class, an outage occurs during the change.
|
3345
3864
|
# The change is applied during the next maintenance window, unless
|
@@ -3379,13 +3898,8 @@ module Aws::DocDB
|
|
3379
3898
|
# Constraints: Must be at least 30 minutes.
|
3380
3899
|
#
|
3381
3900
|
# @option params [Boolean] :auto_minor_version_upgrade
|
3382
|
-
#
|
3383
|
-
#
|
3384
|
-
# doesn't result in an outage except in the following case, and the
|
3385
|
-
# change is asynchronously applied as soon as possible. An outage
|
3386
|
-
# results if this parameter is set to `true` during the maintenance
|
3387
|
-
# window, and a newer minor version is available, and Amazon DocumentDB
|
3388
|
-
# has enabled automatic patching for that engine version.
|
3901
|
+
# This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
|
3902
|
+
# does not perform minor version upgrades regardless of the value set.
|
3389
3903
|
#
|
3390
3904
|
# @option params [String] :new_db_instance_identifier
|
3391
3905
|
# The new instance identifier for the instance when renaming an
|
@@ -3506,7 +4020,7 @@ module Aws::DocDB
|
|
3506
4020
|
end
|
3507
4021
|
|
3508
4022
|
# Modifies an existing subnet group. subnet groups must contain at least
|
3509
|
-
# one subnet in at least two Availability Zones in the
|
4023
|
+
# one subnet in at least two Availability Zones in the Region.
|
3510
4024
|
#
|
3511
4025
|
# @option params [required, String] :db_subnet_group_name
|
3512
4026
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -3556,6 +4070,143 @@ module Aws::DocDB
|
|
3556
4070
|
req.send_request(options)
|
3557
4071
|
end
|
3558
4072
|
|
4073
|
+
# Modifies an existing Amazon DocumentDB event notification
|
4074
|
+
# subscription.
|
4075
|
+
#
|
4076
|
+
# @option params [required, String] :subscription_name
|
4077
|
+
# The name of the Amazon DocumentDB event notification subscription.
|
4078
|
+
#
|
4079
|
+
# @option params [String] :sns_topic_arn
|
4080
|
+
# The Amazon Resource Name (ARN) of the SNS topic created for event
|
4081
|
+
# notification. The ARN is created by Amazon SNS when you create a topic
|
4082
|
+
# and subscribe to it.
|
4083
|
+
#
|
4084
|
+
# @option params [String] :source_type
|
4085
|
+
# The type of source that is generating the events. For example, if you
|
4086
|
+
# want to be notified of events generated by an instance, set this
|
4087
|
+
# parameter to `db-instance`. If this value is not specified, all events
|
4088
|
+
# are returned.
|
4089
|
+
#
|
4090
|
+
# Valid values: `db-instance`, `db-parameter-group`, `db-security-group`
|
4091
|
+
#
|
4092
|
+
# @option params [Array<String>] :event_categories
|
4093
|
+
# A list of event categories for a `SourceType` that you want to
|
4094
|
+
# subscribe to.
|
4095
|
+
#
|
4096
|
+
# @option params [Boolean] :enabled
|
4097
|
+
# A Boolean value; set to `true` to activate the subscription.
|
4098
|
+
#
|
4099
|
+
# @return [Types::ModifyEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4100
|
+
#
|
4101
|
+
# * {Types::ModifyEventSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription
|
4102
|
+
#
|
4103
|
+
# @example Request syntax with placeholder values
|
4104
|
+
#
|
4105
|
+
# resp = client.modify_event_subscription({
|
4106
|
+
# subscription_name: "String", # required
|
4107
|
+
# sns_topic_arn: "String",
|
4108
|
+
# source_type: "String",
|
4109
|
+
# event_categories: ["String"],
|
4110
|
+
# enabled: false,
|
4111
|
+
# })
|
4112
|
+
#
|
4113
|
+
# @example Response structure
|
4114
|
+
#
|
4115
|
+
# resp.event_subscription.customer_aws_id #=> String
|
4116
|
+
# resp.event_subscription.cust_subscription_id #=> String
|
4117
|
+
# resp.event_subscription.sns_topic_arn #=> String
|
4118
|
+
# resp.event_subscription.status #=> String
|
4119
|
+
# resp.event_subscription.subscription_creation_time #=> String
|
4120
|
+
# resp.event_subscription.source_type #=> String
|
4121
|
+
# resp.event_subscription.source_ids_list #=> Array
|
4122
|
+
# resp.event_subscription.source_ids_list[0] #=> String
|
4123
|
+
# resp.event_subscription.event_categories_list #=> Array
|
4124
|
+
# resp.event_subscription.event_categories_list[0] #=> String
|
4125
|
+
# resp.event_subscription.enabled #=> Boolean
|
4126
|
+
# resp.event_subscription.event_subscription_arn #=> String
|
4127
|
+
#
|
4128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyEventSubscription AWS API Documentation
|
4129
|
+
#
|
4130
|
+
# @overload modify_event_subscription(params = {})
|
4131
|
+
# @param [Hash] params ({})
|
4132
|
+
def modify_event_subscription(params = {}, options = {})
|
4133
|
+
req = build_request(:modify_event_subscription, params)
|
4134
|
+
req.send_request(options)
|
4135
|
+
end
|
4136
|
+
|
4137
|
+
# Modify a setting for an Amazon DocumentDB global cluster. You can
|
4138
|
+
# change one or more configuration parameters (for example: deletion
|
4139
|
+
# protection), or the global cluster identifier by specifying these
|
4140
|
+
# parameters and the new values in the request.
|
4141
|
+
#
|
4142
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
4143
|
+
#
|
4144
|
+
# </note>
|
4145
|
+
#
|
4146
|
+
# @option params [required, String] :global_cluster_identifier
|
4147
|
+
# The identifier for the global cluster being modified. This parameter
|
4148
|
+
# isn't case-sensitive.
|
4149
|
+
#
|
4150
|
+
# Constraints:
|
4151
|
+
#
|
4152
|
+
# * Must match the identifier of an existing global cluster.
|
4153
|
+
#
|
4154
|
+
# ^
|
4155
|
+
#
|
4156
|
+
# @option params [String] :new_global_cluster_identifier
|
4157
|
+
# The new identifier for a global cluster when you modify a global
|
4158
|
+
# cluster. This value is stored as a lowercase string.
|
4159
|
+
#
|
4160
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
4161
|
+
#
|
4162
|
+
# The first character must be a letter
|
4163
|
+
#
|
4164
|
+
# Can't end with a hyphen or contain two consecutive hyphens
|
4165
|
+
#
|
4166
|
+
# Example: `my-cluster2`
|
4167
|
+
#
|
4168
|
+
# @option params [Boolean] :deletion_protection
|
4169
|
+
# Indicates if the global cluster has deletion protection enabled. The
|
4170
|
+
# global cluster can't be deleted when deletion protection is enabled.
|
4171
|
+
#
|
4172
|
+
# @return [Types::ModifyGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4173
|
+
#
|
4174
|
+
# * {Types::ModifyGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
4175
|
+
#
|
4176
|
+
# @example Request syntax with placeholder values
|
4177
|
+
#
|
4178
|
+
# resp = client.modify_global_cluster({
|
4179
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
4180
|
+
# new_global_cluster_identifier: "GlobalClusterIdentifier",
|
4181
|
+
# deletion_protection: false,
|
4182
|
+
# })
|
4183
|
+
#
|
4184
|
+
# @example Response structure
|
4185
|
+
#
|
4186
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
4187
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
4188
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
4189
|
+
# resp.global_cluster.status #=> String
|
4190
|
+
# resp.global_cluster.engine #=> String
|
4191
|
+
# resp.global_cluster.engine_version #=> String
|
4192
|
+
# resp.global_cluster.database_name #=> String
|
4193
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
4194
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
4195
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
4196
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
4197
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
4198
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
4199
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
4200
|
+
#
|
4201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyGlobalCluster AWS API Documentation
|
4202
|
+
#
|
4203
|
+
# @overload modify_global_cluster(params = {})
|
4204
|
+
# @param [Hash] params ({})
|
4205
|
+
def modify_global_cluster(params = {}, options = {})
|
4206
|
+
req = build_request(:modify_global_cluster, params)
|
4207
|
+
req.send_request(options)
|
4208
|
+
end
|
4209
|
+
|
3559
4210
|
# You might need to reboot your instance, usually for maintenance
|
3560
4211
|
# reasons. For example, if you make certain changes, or if you change
|
3561
4212
|
# the cluster parameter group that is associated with the instance, you
|
@@ -3663,6 +4314,106 @@ module Aws::DocDB
|
|
3663
4314
|
req.send_request(options)
|
3664
4315
|
end
|
3665
4316
|
|
4317
|
+
# Detaches an Amazon DocumentDB secondary cluster from a global cluster.
|
4318
|
+
# The cluster becomes a standalone cluster with read-write capability
|
4319
|
+
# instead of being read-only and receiving data from a primary in a
|
4320
|
+
# different region.
|
4321
|
+
#
|
4322
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
4323
|
+
#
|
4324
|
+
# </note>
|
4325
|
+
#
|
4326
|
+
# @option params [required, String] :global_cluster_identifier
|
4327
|
+
# The cluster identifier to detach from the Amazon DocumentDB global
|
4328
|
+
# cluster.
|
4329
|
+
#
|
4330
|
+
# @option params [required, String] :db_cluster_identifier
|
4331
|
+
# The Amazon Resource Name (ARN) identifying the cluster that was
|
4332
|
+
# detached from the Amazon DocumentDB global cluster.
|
4333
|
+
#
|
4334
|
+
# @return [Types::RemoveFromGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4335
|
+
#
|
4336
|
+
# * {Types::RemoveFromGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
4337
|
+
#
|
4338
|
+
# @example Request syntax with placeholder values
|
4339
|
+
#
|
4340
|
+
# resp = client.remove_from_global_cluster({
|
4341
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
4342
|
+
# db_cluster_identifier: "String", # required
|
4343
|
+
# })
|
4344
|
+
#
|
4345
|
+
# @example Response structure
|
4346
|
+
#
|
4347
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
4348
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
4349
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
4350
|
+
# resp.global_cluster.status #=> String
|
4351
|
+
# resp.global_cluster.engine #=> String
|
4352
|
+
# resp.global_cluster.engine_version #=> String
|
4353
|
+
# resp.global_cluster.database_name #=> String
|
4354
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
4355
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
4356
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
4357
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
4358
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
4359
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
4360
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
4361
|
+
#
|
4362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveFromGlobalCluster AWS API Documentation
|
4363
|
+
#
|
4364
|
+
# @overload remove_from_global_cluster(params = {})
|
4365
|
+
# @param [Hash] params ({})
|
4366
|
+
def remove_from_global_cluster(params = {}, options = {})
|
4367
|
+
req = build_request(:remove_from_global_cluster, params)
|
4368
|
+
req.send_request(options)
|
4369
|
+
end
|
4370
|
+
|
4371
|
+
# Removes a source identifier from an existing Amazon DocumentDB event
|
4372
|
+
# notification subscription.
|
4373
|
+
#
|
4374
|
+
# @option params [required, String] :subscription_name
|
4375
|
+
# The name of the Amazon DocumentDB event notification subscription that
|
4376
|
+
# you want to remove a source identifier from.
|
4377
|
+
#
|
4378
|
+
# @option params [required, String] :source_identifier
|
4379
|
+
# The source identifier to be removed from the subscription, such as the
|
4380
|
+
# instance identifier for an instance, or the name of a security group.
|
4381
|
+
#
|
4382
|
+
# @return [Types::RemoveSourceIdentifierFromSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4383
|
+
#
|
4384
|
+
# * {Types::RemoveSourceIdentifierFromSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription
|
4385
|
+
#
|
4386
|
+
# @example Request syntax with placeholder values
|
4387
|
+
#
|
4388
|
+
# resp = client.remove_source_identifier_from_subscription({
|
4389
|
+
# subscription_name: "String", # required
|
4390
|
+
# source_identifier: "String", # required
|
4391
|
+
# })
|
4392
|
+
#
|
4393
|
+
# @example Response structure
|
4394
|
+
#
|
4395
|
+
# resp.event_subscription.customer_aws_id #=> String
|
4396
|
+
# resp.event_subscription.cust_subscription_id #=> String
|
4397
|
+
# resp.event_subscription.sns_topic_arn #=> String
|
4398
|
+
# resp.event_subscription.status #=> String
|
4399
|
+
# resp.event_subscription.subscription_creation_time #=> String
|
4400
|
+
# resp.event_subscription.source_type #=> String
|
4401
|
+
# resp.event_subscription.source_ids_list #=> Array
|
4402
|
+
# resp.event_subscription.source_ids_list[0] #=> String
|
4403
|
+
# resp.event_subscription.event_categories_list #=> Array
|
4404
|
+
# resp.event_subscription.event_categories_list[0] #=> String
|
4405
|
+
# resp.event_subscription.enabled #=> Boolean
|
4406
|
+
# resp.event_subscription.event_subscription_arn #=> String
|
4407
|
+
#
|
4408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription AWS API Documentation
|
4409
|
+
#
|
4410
|
+
# @overload remove_source_identifier_from_subscription(params = {})
|
4411
|
+
# @param [Hash] params ({})
|
4412
|
+
def remove_source_identifier_from_subscription(params = {}, options = {})
|
4413
|
+
req = build_request(:remove_source_identifier_from_subscription, params)
|
4414
|
+
req.send_request(options)
|
4415
|
+
end
|
4416
|
+
|
3666
4417
|
# Removes metadata tags from an Amazon DocumentDB resource.
|
3667
4418
|
#
|
3668
4419
|
# @option params [required, String] :resource_name
|
@@ -3827,21 +4578,21 @@ module Aws::DocDB
|
|
3827
4578
|
# The tags to be assigned to the restored cluster.
|
3828
4579
|
#
|
3829
4580
|
# @option params [String] :kms_key_id
|
3830
|
-
# The
|
3831
|
-
#
|
4581
|
+
# The KMS key identifier to use when restoring an encrypted cluster from
|
4582
|
+
# a DB snapshot or cluster snapshot.
|
3832
4583
|
#
|
3833
|
-
# The
|
3834
|
-
#
|
3835
|
-
#
|
3836
|
-
#
|
3837
|
-
#
|
4584
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4585
|
+
# encryption key. If you are restoring a cluster with the same account
|
4586
|
+
# that owns the KMS encryption key used to encrypt the new cluster, then
|
4587
|
+
# you can use the KMS key alias instead of the ARN for the KMS
|
4588
|
+
# encryption key.
|
3838
4589
|
#
|
3839
4590
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
3840
4591
|
# following occurs:
|
3841
4592
|
#
|
3842
4593
|
# * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
|
3843
|
-
# encrypted, then the restored cluster is encrypted using the
|
3844
|
-
#
|
4594
|
+
# encrypted, then the restored cluster is encrypted using the KMS key
|
4595
|
+
# that was used to encrypt the snapshot or the cluster snapshot.
|
3845
4596
|
#
|
3846
4597
|
# * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
|
3847
4598
|
# not encrypted, then the restored DB cluster is not encrypted.
|
@@ -3903,6 +4654,9 @@ module Aws::DocDB
|
|
3903
4654
|
# resp.db_cluster.master_username #=> String
|
3904
4655
|
# resp.db_cluster.preferred_backup_window #=> String
|
3905
4656
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
4657
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
4658
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
4659
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
3906
4660
|
# resp.db_cluster.db_cluster_members #=> Array
|
3907
4661
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
3908
4662
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4011,25 +4765,25 @@ module Aws::DocDB
|
|
4011
4765
|
# The tags to be assigned to the restored cluster.
|
4012
4766
|
#
|
4013
4767
|
# @option params [String] :kms_key_id
|
4014
|
-
# The
|
4015
|
-
#
|
4768
|
+
# The KMS key identifier to use when restoring an encrypted cluster from
|
4769
|
+
# an encrypted cluster.
|
4016
4770
|
#
|
4017
|
-
# The
|
4018
|
-
#
|
4019
|
-
#
|
4020
|
-
#
|
4021
|
-
#
|
4771
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4772
|
+
# encryption key. If you are restoring a cluster with the same account
|
4773
|
+
# that owns the KMS encryption key used to encrypt the new cluster, then
|
4774
|
+
# you can use the KMS key alias instead of the ARN for the KMS
|
4775
|
+
# encryption key.
|
4022
4776
|
#
|
4023
4777
|
# You can restore to a new cluster and encrypt the new cluster with an
|
4024
|
-
#
|
4025
|
-
#
|
4026
|
-
#
|
4778
|
+
# KMS key that is different from the KMS key used to encrypt the source
|
4779
|
+
# cluster. The new DB cluster is encrypted with the KMS key identified
|
4780
|
+
# by the `KmsKeyId` parameter.
|
4027
4781
|
#
|
4028
4782
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4029
4783
|
# following occurs:
|
4030
4784
|
#
|
4031
4785
|
# * If the cluster is encrypted, then the restored cluster is encrypted
|
4032
|
-
# using the
|
4786
|
+
# using the KMS key that was used to encrypt the source cluster.
|
4033
4787
|
#
|
4034
4788
|
# * If the cluster is not encrypted, then the restored cluster is not
|
4035
4789
|
# encrypted.
|
@@ -4093,6 +4847,9 @@ module Aws::DocDB
|
|
4093
4847
|
# resp.db_cluster.master_username #=> String
|
4094
4848
|
# resp.db_cluster.preferred_backup_window #=> String
|
4095
4849
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
4850
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
4851
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
4852
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
4096
4853
|
# resp.db_cluster.db_cluster_members #=> Array
|
4097
4854
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
4098
4855
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4166,6 +4923,9 @@ module Aws::DocDB
|
|
4166
4923
|
# resp.db_cluster.master_username #=> String
|
4167
4924
|
# resp.db_cluster.preferred_backup_window #=> String
|
4168
4925
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
4926
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
4927
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
4928
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
4169
4929
|
# resp.db_cluster.db_cluster_members #=> Array
|
4170
4930
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
4171
4931
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4239,6 +4999,9 @@ module Aws::DocDB
|
|
4239
4999
|
# resp.db_cluster.master_username #=> String
|
4240
5000
|
# resp.db_cluster.preferred_backup_window #=> String
|
4241
5001
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
5002
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
5003
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
5004
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
4242
5005
|
# resp.db_cluster.db_cluster_members #=> Array
|
4243
5006
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
4244
5007
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4282,7 +5045,7 @@ module Aws::DocDB
|
|
4282
5045
|
params: params,
|
4283
5046
|
config: config)
|
4284
5047
|
context[:gem_name] = 'aws-sdk-docdb'
|
4285
|
-
context[:gem_version] = '1.
|
5048
|
+
context[:gem_version] = '1.32.0'
|
4286
5049
|
Seahorse::Client::Request.new(handlers, context)
|
4287
5050
|
end
|
4288
5051
|
|