aws-sdk-docdb 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-docdb.rb +48 -0
- data/lib/aws-sdk-docdb/client.rb +4001 -0
- data/lib/aws-sdk-docdb/client_api.rb +1389 -0
- data/lib/aws-sdk-docdb/customizations.rb +0 -0
- data/lib/aws-sdk-docdb/errors.rb +14 -0
- data/lib/aws-sdk-docdb/resource.rb +23 -0
- data/lib/aws-sdk-docdb/types.rb +4559 -0
- data/lib/aws-sdk-docdb/waiters.rb +148 -0
- metadata +89 -0
|
File without changes
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws::DocDB
|
|
9
|
+
module Errors
|
|
10
|
+
|
|
11
|
+
extend Aws::Errors::DynamicErrors
|
|
12
|
+
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws::DocDB
|
|
9
|
+
class Resource
|
|
10
|
+
|
|
11
|
+
# @param options ({})
|
|
12
|
+
# @option options [Client] :client
|
|
13
|
+
def initialize(options = {})
|
|
14
|
+
@client = options[:client] || Client.new(options)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# @return [Client]
|
|
18
|
+
def client
|
|
19
|
+
@client
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,4559 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws::DocDB
|
|
9
|
+
module Types
|
|
10
|
+
|
|
11
|
+
# Represents the input to AddTagsToResource.
|
|
12
|
+
#
|
|
13
|
+
# @note When making an API call, you may pass AddTagsToResourceMessage
|
|
14
|
+
# data as a hash:
|
|
15
|
+
#
|
|
16
|
+
# {
|
|
17
|
+
# resource_name: "String", # required
|
|
18
|
+
# tags: [ # required
|
|
19
|
+
# {
|
|
20
|
+
# key: "String",
|
|
21
|
+
# value: "String",
|
|
22
|
+
# },
|
|
23
|
+
# ],
|
|
24
|
+
# }
|
|
25
|
+
#
|
|
26
|
+
# @!attribute [rw] resource_name
|
|
27
|
+
# The Amazon DocumentDB resource that the tags are added to. This
|
|
28
|
+
# value is an Amazon Resource Name (ARN).
|
|
29
|
+
# @return [String]
|
|
30
|
+
#
|
|
31
|
+
# @!attribute [rw] tags
|
|
32
|
+
# The tags to be assigned to the Amazon DocumentDB resource.
|
|
33
|
+
# @return [Array<Types::Tag>]
|
|
34
|
+
#
|
|
35
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddTagsToResourceMessage AWS API Documentation
|
|
36
|
+
#
|
|
37
|
+
class AddTagsToResourceMessage < Struct.new(
|
|
38
|
+
:resource_name,
|
|
39
|
+
:tags)
|
|
40
|
+
include Aws::Structure
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Represents the input to ApplyPendingMaintenanceAction.
|
|
44
|
+
#
|
|
45
|
+
# @note When making an API call, you may pass ApplyPendingMaintenanceActionMessage
|
|
46
|
+
# data as a hash:
|
|
47
|
+
#
|
|
48
|
+
# {
|
|
49
|
+
# resource_identifier: "String", # required
|
|
50
|
+
# apply_action: "String", # required
|
|
51
|
+
# opt_in_type: "String", # required
|
|
52
|
+
# }
|
|
53
|
+
#
|
|
54
|
+
# @!attribute [rw] resource_identifier
|
|
55
|
+
# The Amazon Resource Name (ARN) of the resource that the pending
|
|
56
|
+
# maintenance action applies to.
|
|
57
|
+
# @return [String]
|
|
58
|
+
#
|
|
59
|
+
# @!attribute [rw] apply_action
|
|
60
|
+
# The pending maintenance action to apply to this resource.
|
|
61
|
+
#
|
|
62
|
+
# Valid values: `system-update`, `db-upgrade`
|
|
63
|
+
# @return [String]
|
|
64
|
+
#
|
|
65
|
+
# @!attribute [rw] opt_in_type
|
|
66
|
+
# A value that specifies the type of opt-in request or undoes an
|
|
67
|
+
# opt-in request. An opt-in request of type `immediate` can't be
|
|
68
|
+
# undone.
|
|
69
|
+
#
|
|
70
|
+
# Valid values:
|
|
71
|
+
#
|
|
72
|
+
# * `immediate` - Apply the maintenance action immediately.
|
|
73
|
+
#
|
|
74
|
+
# * `next-maintenance` - Apply the maintenance action during the next
|
|
75
|
+
# maintenance window for the resource.
|
|
76
|
+
#
|
|
77
|
+
# * `undo-opt-in` - Cancel any existing `next-maintenance` opt-in
|
|
78
|
+
# requests.
|
|
79
|
+
# @return [String]
|
|
80
|
+
#
|
|
81
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceActionMessage AWS API Documentation
|
|
82
|
+
#
|
|
83
|
+
class ApplyPendingMaintenanceActionMessage < Struct.new(
|
|
84
|
+
:resource_identifier,
|
|
85
|
+
:apply_action,
|
|
86
|
+
:opt_in_type)
|
|
87
|
+
include Aws::Structure
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# @!attribute [rw] resource_pending_maintenance_actions
|
|
91
|
+
# Represents the output of ApplyPendingMaintenanceAction.
|
|
92
|
+
# @return [Types::ResourcePendingMaintenanceActions]
|
|
93
|
+
#
|
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceActionResult AWS API Documentation
|
|
95
|
+
#
|
|
96
|
+
class ApplyPendingMaintenanceActionResult < Struct.new(
|
|
97
|
+
:resource_pending_maintenance_actions)
|
|
98
|
+
include Aws::Structure
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Information about an Availability Zone.
|
|
102
|
+
#
|
|
103
|
+
# @!attribute [rw] name
|
|
104
|
+
# The name of the Availability Zone.
|
|
105
|
+
# @return [String]
|
|
106
|
+
#
|
|
107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AvailabilityZone AWS API Documentation
|
|
108
|
+
#
|
|
109
|
+
class AvailabilityZone < Struct.new(
|
|
110
|
+
:name)
|
|
111
|
+
include Aws::Structure
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# The configuration setting for the log types to be enabled for export
|
|
115
|
+
# to Amazon CloudWatch Logs for a specific DB instance or DB cluster.
|
|
116
|
+
#
|
|
117
|
+
# The `EnableLogTypes` and `DisableLogTypes` arrays determine which logs
|
|
118
|
+
# are exported (or not exported) to CloudWatch Logs. The values within
|
|
119
|
+
# these arrays depend on the DB engine that is being used.
|
|
120
|
+
#
|
|
121
|
+
# @note When making an API call, you may pass CloudwatchLogsExportConfiguration
|
|
122
|
+
# data as a hash:
|
|
123
|
+
#
|
|
124
|
+
# {
|
|
125
|
+
# enable_log_types: ["String"],
|
|
126
|
+
# disable_log_types: ["String"],
|
|
127
|
+
# }
|
|
128
|
+
#
|
|
129
|
+
# @!attribute [rw] enable_log_types
|
|
130
|
+
# The list of log types to enable.
|
|
131
|
+
# @return [Array<String>]
|
|
132
|
+
#
|
|
133
|
+
# @!attribute [rw] disable_log_types
|
|
134
|
+
# The list of log types to disable.
|
|
135
|
+
# @return [Array<String>]
|
|
136
|
+
#
|
|
137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CloudwatchLogsExportConfiguration AWS API Documentation
|
|
138
|
+
#
|
|
139
|
+
class CloudwatchLogsExportConfiguration < Struct.new(
|
|
140
|
+
:enable_log_types,
|
|
141
|
+
:disable_log_types)
|
|
142
|
+
include Aws::Structure
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# Represents the input to CopyDBClusterParameterGroup.
|
|
146
|
+
#
|
|
147
|
+
# @note When making an API call, you may pass CopyDBClusterParameterGroupMessage
|
|
148
|
+
# data as a hash:
|
|
149
|
+
#
|
|
150
|
+
# {
|
|
151
|
+
# source_db_cluster_parameter_group_identifier: "String", # required
|
|
152
|
+
# target_db_cluster_parameter_group_identifier: "String", # required
|
|
153
|
+
# target_db_cluster_parameter_group_description: "String", # required
|
|
154
|
+
# tags: [
|
|
155
|
+
# {
|
|
156
|
+
# key: "String",
|
|
157
|
+
# value: "String",
|
|
158
|
+
# },
|
|
159
|
+
# ],
|
|
160
|
+
# }
|
|
161
|
+
#
|
|
162
|
+
# @!attribute [rw] source_db_cluster_parameter_group_identifier
|
|
163
|
+
# The identifier or Amazon Resource Name (ARN) for the source DB
|
|
164
|
+
# cluster parameter group.
|
|
165
|
+
#
|
|
166
|
+
# Constraints:
|
|
167
|
+
#
|
|
168
|
+
# * Must specify a valid DB cluster parameter group.
|
|
169
|
+
#
|
|
170
|
+
# * If the source DB cluster parameter group is in the same AWS Region
|
|
171
|
+
# as the copy, specify a valid DB parameter group identifier; for
|
|
172
|
+
# example, `my-db-cluster-param-group`, or a valid ARN.
|
|
173
|
+
#
|
|
174
|
+
# * If the source DB parameter group is in a different AWS Region than
|
|
175
|
+
# the copy, specify a valid DB cluster parameter group ARN; for
|
|
176
|
+
# example,
|
|
177
|
+
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
|
|
178
|
+
# @return [String]
|
|
179
|
+
#
|
|
180
|
+
# @!attribute [rw] target_db_cluster_parameter_group_identifier
|
|
181
|
+
# The identifier for the copied DB cluster parameter group.
|
|
182
|
+
#
|
|
183
|
+
# Constraints:
|
|
184
|
+
#
|
|
185
|
+
# * Cannot be null, empty, or blank.
|
|
186
|
+
#
|
|
187
|
+
# * Must contain from 1 to 255 letters, numbers, or hyphens.
|
|
188
|
+
#
|
|
189
|
+
# * The first character must be a letter.
|
|
190
|
+
#
|
|
191
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
192
|
+
#
|
|
193
|
+
# Example: `my-cluster-param-group1`
|
|
194
|
+
# @return [String]
|
|
195
|
+
#
|
|
196
|
+
# @!attribute [rw] target_db_cluster_parameter_group_description
|
|
197
|
+
# A description for the copied DB cluster parameter group.
|
|
198
|
+
# @return [String]
|
|
199
|
+
#
|
|
200
|
+
# @!attribute [rw] tags
|
|
201
|
+
# The tags that are to be assigned to the parameter group.
|
|
202
|
+
# @return [Array<Types::Tag>]
|
|
203
|
+
#
|
|
204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroupMessage AWS API Documentation
|
|
205
|
+
#
|
|
206
|
+
class CopyDBClusterParameterGroupMessage < Struct.new(
|
|
207
|
+
:source_db_cluster_parameter_group_identifier,
|
|
208
|
+
:target_db_cluster_parameter_group_identifier,
|
|
209
|
+
:target_db_cluster_parameter_group_description,
|
|
210
|
+
:tags)
|
|
211
|
+
include Aws::Structure
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
# @!attribute [rw] db_cluster_parameter_group
|
|
215
|
+
# Detailed information about a DB cluster parameter group.
|
|
216
|
+
# @return [Types::DBClusterParameterGroup]
|
|
217
|
+
#
|
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroupResult AWS API Documentation
|
|
219
|
+
#
|
|
220
|
+
class CopyDBClusterParameterGroupResult < Struct.new(
|
|
221
|
+
:db_cluster_parameter_group)
|
|
222
|
+
include Aws::Structure
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# Represents the input to CopyDBClusterSnapshot.
|
|
226
|
+
#
|
|
227
|
+
# @note When making an API call, you may pass CopyDBClusterSnapshotMessage
|
|
228
|
+
# data as a hash:
|
|
229
|
+
#
|
|
230
|
+
# {
|
|
231
|
+
# source_db_cluster_snapshot_identifier: "String", # required
|
|
232
|
+
# target_db_cluster_snapshot_identifier: "String", # required
|
|
233
|
+
# kms_key_id: "String",
|
|
234
|
+
# pre_signed_url: "String",
|
|
235
|
+
# copy_tags: false,
|
|
236
|
+
# tags: [
|
|
237
|
+
# {
|
|
238
|
+
# key: "String",
|
|
239
|
+
# value: "String",
|
|
240
|
+
# },
|
|
241
|
+
# ],
|
|
242
|
+
# }
|
|
243
|
+
#
|
|
244
|
+
# @!attribute [rw] source_db_cluster_snapshot_identifier
|
|
245
|
+
# The identifier of the DB cluster snapshot to copy. This parameter is
|
|
246
|
+
# not case sensitive.
|
|
247
|
+
#
|
|
248
|
+
# You can't copy an encrypted, shared DB cluster snapshot from one
|
|
249
|
+
# AWS Region to another.
|
|
250
|
+
#
|
|
251
|
+
# Constraints:
|
|
252
|
+
#
|
|
253
|
+
# * Must specify a valid system snapshot in the "available" state.
|
|
254
|
+
#
|
|
255
|
+
# * If the source snapshot is in the same AWS Region as the copy,
|
|
256
|
+
# specify a valid DB snapshot identifier.
|
|
257
|
+
#
|
|
258
|
+
# * If the source snapshot is in a different AWS Region than the copy,
|
|
259
|
+
# specify a valid DB cluster snapshot ARN.
|
|
260
|
+
#
|
|
261
|
+
# Example: `my-cluster-snapshot1`
|
|
262
|
+
# @return [String]
|
|
263
|
+
#
|
|
264
|
+
# @!attribute [rw] target_db_cluster_snapshot_identifier
|
|
265
|
+
# The identifier of the new DB cluster snapshot to create from the
|
|
266
|
+
# source DB cluster snapshot. This parameter is not case sensitive.
|
|
267
|
+
#
|
|
268
|
+
# Constraints:
|
|
269
|
+
#
|
|
270
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
271
|
+
#
|
|
272
|
+
# * The first character must be a letter.
|
|
273
|
+
#
|
|
274
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
275
|
+
#
|
|
276
|
+
# Example: `my-cluster-snapshot2`
|
|
277
|
+
# @return [String]
|
|
278
|
+
#
|
|
279
|
+
# @!attribute [rw] kms_key_id
|
|
280
|
+
# The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS
|
|
281
|
+
# key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or
|
|
282
|
+
# the AWS KMS key alias for the AWS KMS encryption key.
|
|
283
|
+
#
|
|
284
|
+
# If you copy an encrypted DB cluster snapshot from your AWS account,
|
|
285
|
+
# you can specify a value for `KmsKeyId` to encrypt the copy with a
|
|
286
|
+
# new AWS KMS encryption key. If you don't specify a value for
|
|
287
|
+
# `KmsKeyId`, then the copy of the DB cluster snapshot is encrypted
|
|
288
|
+
# with the same AWS KMS key as the source DB cluster snapshot.
|
|
289
|
+
#
|
|
290
|
+
# If you copy an encrypted DB cluster snapshot that is shared from
|
|
291
|
+
# another AWS account, then you must specify a value for `KmsKeyId`.
|
|
292
|
+
#
|
|
293
|
+
# To copy an encrypted DB cluster snapshot to another AWS Region, set
|
|
294
|
+
# `KmsKeyId` to the AWS KMS key ID that you want to use to encrypt the
|
|
295
|
+
# copy of the DB cluster snapshot in the destination Region. AWS KMS
|
|
296
|
+
# encryption keys are specific to the AWS Region that they are created
|
|
297
|
+
# in, and you can't use encryption keys from one Region in another
|
|
298
|
+
# Region.
|
|
299
|
+
#
|
|
300
|
+
# If you copy an unencrypted DB cluster snapshot and specify a value
|
|
301
|
+
# for the `KmsKeyId` parameter, an error is returned.
|
|
302
|
+
# @return [String]
|
|
303
|
+
#
|
|
304
|
+
# @!attribute [rw] pre_signed_url
|
|
305
|
+
# The URL that contains a Signature Version 4 signed request for the
|
|
306
|
+
# `CopyDBClusterSnapshot` API action in the AWS Region that contains
|
|
307
|
+
# the source DB cluster snapshot to copy. You must use the
|
|
308
|
+
# `PreSignedUrl` parameter when copying an encrypted DB cluster
|
|
309
|
+
# snapshot from another AWS Region.
|
|
310
|
+
#
|
|
311
|
+
# The presigned URL must be a valid request for the
|
|
312
|
+
# `CopyDBSClusterSnapshot` API action that can be executed in the
|
|
313
|
+
# source AWS Region that contains the encrypted DB cluster snapshot to
|
|
314
|
+
# be copied. The presigned URL request must contain the following
|
|
315
|
+
# parameter values:
|
|
316
|
+
#
|
|
317
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
|
318
|
+
# encrypt the copy of the DB cluster snapshot in the destination AWS
|
|
319
|
+
# Region. This is the same identifier for both the
|
|
320
|
+
# `CopyDBClusterSnapshot` action that is called in the destination
|
|
321
|
+
# AWS Region, and the action contained in the presigned URL.
|
|
322
|
+
#
|
|
323
|
+
# * `DestinationRegion` - The name of the AWS Region that the DB
|
|
324
|
+
# cluster snapshot will be created in.
|
|
325
|
+
#
|
|
326
|
+
# * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
|
|
327
|
+
# identifier for the encrypted DB cluster snapshot to be copied.
|
|
328
|
+
# This identifier must be in the Amazon Resource Name (ARN) format
|
|
329
|
+
# for the source AWS Region. For example, if you are copying an
|
|
330
|
+
# encrypted DB cluster snapshot from the us-west-2 AWS Region, then
|
|
331
|
+
# your `SourceDBClusterSnapshotIdentifier` looks like the following
|
|
332
|
+
# example:
|
|
333
|
+
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115`.
|
|
334
|
+
# @return [String]
|
|
335
|
+
#
|
|
336
|
+
# @!attribute [rw] copy_tags
|
|
337
|
+
# Set to `true` to copy all tags from the source DB cluster snapshot
|
|
338
|
+
# to the target DB cluster snapshot, and otherwise `false`. The
|
|
339
|
+
# default is `false`.
|
|
340
|
+
# @return [Boolean]
|
|
341
|
+
#
|
|
342
|
+
# @!attribute [rw] tags
|
|
343
|
+
# The tags to be assigned to the DB cluster snapshot.
|
|
344
|
+
# @return [Array<Types::Tag>]
|
|
345
|
+
#
|
|
346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshotMessage AWS API Documentation
|
|
347
|
+
#
|
|
348
|
+
class CopyDBClusterSnapshotMessage < Struct.new(
|
|
349
|
+
:source_db_cluster_snapshot_identifier,
|
|
350
|
+
:target_db_cluster_snapshot_identifier,
|
|
351
|
+
:kms_key_id,
|
|
352
|
+
:pre_signed_url,
|
|
353
|
+
:copy_tags,
|
|
354
|
+
:tags)
|
|
355
|
+
include Aws::Structure
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# @!attribute [rw] db_cluster_snapshot
|
|
359
|
+
# Detailed information about a DB cluster snapshot.
|
|
360
|
+
# @return [Types::DBClusterSnapshot]
|
|
361
|
+
#
|
|
362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshotResult AWS API Documentation
|
|
363
|
+
#
|
|
364
|
+
class CopyDBClusterSnapshotResult < Struct.new(
|
|
365
|
+
:db_cluster_snapshot)
|
|
366
|
+
include Aws::Structure
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
# Represents the input to CreateDBCluster.
|
|
370
|
+
#
|
|
371
|
+
# @note When making an API call, you may pass CreateDBClusterMessage
|
|
372
|
+
# data as a hash:
|
|
373
|
+
#
|
|
374
|
+
# {
|
|
375
|
+
# availability_zones: ["String"],
|
|
376
|
+
# backup_retention_period: 1,
|
|
377
|
+
# db_cluster_identifier: "String", # required
|
|
378
|
+
# db_cluster_parameter_group_name: "String",
|
|
379
|
+
# vpc_security_group_ids: ["String"],
|
|
380
|
+
# db_subnet_group_name: "String",
|
|
381
|
+
# engine: "String", # required
|
|
382
|
+
# engine_version: "String",
|
|
383
|
+
# port: 1,
|
|
384
|
+
# master_username: "String",
|
|
385
|
+
# master_user_password: "String",
|
|
386
|
+
# preferred_backup_window: "String",
|
|
387
|
+
# preferred_maintenance_window: "String",
|
|
388
|
+
# tags: [
|
|
389
|
+
# {
|
|
390
|
+
# key: "String",
|
|
391
|
+
# value: "String",
|
|
392
|
+
# },
|
|
393
|
+
# ],
|
|
394
|
+
# storage_encrypted: false,
|
|
395
|
+
# kms_key_id: "String",
|
|
396
|
+
# enable_cloudwatch_logs_exports: ["String"],
|
|
397
|
+
# }
|
|
398
|
+
#
|
|
399
|
+
# @!attribute [rw] availability_zones
|
|
400
|
+
# A list of Amazon EC2 Availability Zones that instances in the DB
|
|
401
|
+
# cluster can be created in.
|
|
402
|
+
# @return [Array<String>]
|
|
403
|
+
#
|
|
404
|
+
# @!attribute [rw] backup_retention_period
|
|
405
|
+
# The number of days for which automated backups are retained. You
|
|
406
|
+
# must specify a minimum value of 1.
|
|
407
|
+
#
|
|
408
|
+
# Default: 1
|
|
409
|
+
#
|
|
410
|
+
# Constraints:
|
|
411
|
+
#
|
|
412
|
+
# * Must be a value from 1 to 35.
|
|
413
|
+
#
|
|
414
|
+
# ^
|
|
415
|
+
# @return [Integer]
|
|
416
|
+
#
|
|
417
|
+
# @!attribute [rw] db_cluster_identifier
|
|
418
|
+
# The DB cluster identifier. This parameter is stored as a lowercase
|
|
419
|
+
# string.
|
|
420
|
+
#
|
|
421
|
+
# Constraints:
|
|
422
|
+
#
|
|
423
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
424
|
+
#
|
|
425
|
+
# * The first character must be a letter.
|
|
426
|
+
#
|
|
427
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
428
|
+
#
|
|
429
|
+
# Example: `my-cluster`
|
|
430
|
+
# @return [String]
|
|
431
|
+
#
|
|
432
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
433
|
+
# The name of the DB cluster parameter group to associate with this DB
|
|
434
|
+
# cluster.
|
|
435
|
+
# @return [String]
|
|
436
|
+
#
|
|
437
|
+
# @!attribute [rw] vpc_security_group_ids
|
|
438
|
+
# A list of EC2 VPC security groups to associate with this DB cluster.
|
|
439
|
+
# @return [Array<String>]
|
|
440
|
+
#
|
|
441
|
+
# @!attribute [rw] db_subnet_group_name
|
|
442
|
+
# A DB subnet group to associate with this DB cluster.
|
|
443
|
+
#
|
|
444
|
+
# Constraints: Must match the name of an existing `DBSubnetGroup`.
|
|
445
|
+
# Must not be default.
|
|
446
|
+
#
|
|
447
|
+
# Example: `mySubnetgroup`
|
|
448
|
+
# @return [String]
|
|
449
|
+
#
|
|
450
|
+
# @!attribute [rw] engine
|
|
451
|
+
# The name of the database engine to be used for this DB cluster.
|
|
452
|
+
#
|
|
453
|
+
# Valid values: `docdb`
|
|
454
|
+
# @return [String]
|
|
455
|
+
#
|
|
456
|
+
# @!attribute [rw] engine_version
|
|
457
|
+
# The version number of the database engine to use.
|
|
458
|
+
# @return [String]
|
|
459
|
+
#
|
|
460
|
+
# @!attribute [rw] port
|
|
461
|
+
# The port number on which the instances in the DB cluster accept
|
|
462
|
+
# connections.
|
|
463
|
+
# @return [Integer]
|
|
464
|
+
#
|
|
465
|
+
# @!attribute [rw] master_username
|
|
466
|
+
# The name of the master user for the DB cluster.
|
|
467
|
+
#
|
|
468
|
+
# Constraints:
|
|
469
|
+
#
|
|
470
|
+
# * Must be from 1 to 16 letters or numbers.
|
|
471
|
+
#
|
|
472
|
+
# * The first character must be a letter.
|
|
473
|
+
#
|
|
474
|
+
# * Cannot be a reserved word for the chosen database engine.
|
|
475
|
+
# @return [String]
|
|
476
|
+
#
|
|
477
|
+
# @!attribute [rw] master_user_password
|
|
478
|
+
# The password for the master database user. This password can contain
|
|
479
|
+
# any printable ASCII character except "/", """, or "@".
|
|
480
|
+
#
|
|
481
|
+
# Constraints: Must contain from 8 to 41 characters.
|
|
482
|
+
# @return [String]
|
|
483
|
+
#
|
|
484
|
+
# @!attribute [rw] preferred_backup_window
|
|
485
|
+
# The daily time range during which automated backups are created if
|
|
486
|
+
# automated backups are enabled using the `BackupRetentionPeriod`
|
|
487
|
+
# parameter.
|
|
488
|
+
#
|
|
489
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
|
490
|
+
# block of time for each AWS Region.
|
|
491
|
+
#
|
|
492
|
+
# Constraints:
|
|
493
|
+
#
|
|
494
|
+
# * Must be in the format `hh24:mi-hh24:mi`.
|
|
495
|
+
#
|
|
496
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
497
|
+
#
|
|
498
|
+
# * Must not conflict with the preferred maintenance window.
|
|
499
|
+
#
|
|
500
|
+
# * Must be at least 30 minutes.
|
|
501
|
+
# @return [String]
|
|
502
|
+
#
|
|
503
|
+
# @!attribute [rw] preferred_maintenance_window
|
|
504
|
+
# The weekly time range during which system maintenance can occur, in
|
|
505
|
+
# Universal Coordinated Time (UTC).
|
|
506
|
+
#
|
|
507
|
+
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
|
508
|
+
#
|
|
509
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
|
510
|
+
# block of time for each AWS Region, occurring on a random day of the
|
|
511
|
+
# week.
|
|
512
|
+
#
|
|
513
|
+
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
|
514
|
+
#
|
|
515
|
+
# Constraints: Minimum 30-minute window.
|
|
516
|
+
# @return [String]
|
|
517
|
+
#
|
|
518
|
+
# @!attribute [rw] tags
|
|
519
|
+
# The tags to be assigned to the DB cluster.
|
|
520
|
+
# @return [Array<Types::Tag>]
|
|
521
|
+
#
|
|
522
|
+
# @!attribute [rw] storage_encrypted
|
|
523
|
+
# Specifies whether the DB cluster is encrypted.
|
|
524
|
+
# @return [Boolean]
|
|
525
|
+
#
|
|
526
|
+
# @!attribute [rw] kms_key_id
|
|
527
|
+
# The AWS KMS key identifier for an encrypted DB cluster.
|
|
528
|
+
#
|
|
529
|
+
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
|
530
|
+
# AWS KMS encryption key. If you are creating a DB cluster using the
|
|
531
|
+
# same AWS account that owns the AWS KMS encryption key that is used
|
|
532
|
+
# to encrypt the new DB cluster, you can use the AWS KMS key alias
|
|
533
|
+
# instead of the ARN for the AWS KMS encryption key.
|
|
534
|
+
#
|
|
535
|
+
# If an encryption key is not specified in `KmsKeyId`\:
|
|
536
|
+
#
|
|
537
|
+
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
|
538
|
+
# then Amazon DocumentDB uses the encryption key that is used to
|
|
539
|
+
# encrypt the source. Otherwise, Amazon DocumentDB uses your default
|
|
540
|
+
# encryption key.
|
|
541
|
+
#
|
|
542
|
+
# * If the `StorageEncrypted` parameter is `true` and
|
|
543
|
+
# `ReplicationSourceIdentifier` is not specified, Amazon DocumentDB
|
|
544
|
+
# uses your default encryption key.
|
|
545
|
+
#
|
|
546
|
+
# AWS KMS creates the default encryption key for your AWS account.
|
|
547
|
+
# Your AWS account has a different default encryption key for each AWS
|
|
548
|
+
# Region.
|
|
549
|
+
#
|
|
550
|
+
# If you create a replica of an encrypted DB cluster in another AWS
|
|
551
|
+
# Region, you must set `KmsKeyId` to a KMS key ID that is valid in the
|
|
552
|
+
# destination AWS Region. This key is used to encrypt the replica in
|
|
553
|
+
# that AWS Region.
|
|
554
|
+
# @return [String]
|
|
555
|
+
#
|
|
556
|
+
# @!attribute [rw] enable_cloudwatch_logs_exports
|
|
557
|
+
# A list of log types that need to be enabled for exporting to Amazon
|
|
558
|
+
# CloudWatch Logs.
|
|
559
|
+
# @return [Array<String>]
|
|
560
|
+
#
|
|
561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterMessage AWS API Documentation
|
|
562
|
+
#
|
|
563
|
+
class CreateDBClusterMessage < Struct.new(
|
|
564
|
+
:availability_zones,
|
|
565
|
+
:backup_retention_period,
|
|
566
|
+
:db_cluster_identifier,
|
|
567
|
+
:db_cluster_parameter_group_name,
|
|
568
|
+
:vpc_security_group_ids,
|
|
569
|
+
:db_subnet_group_name,
|
|
570
|
+
:engine,
|
|
571
|
+
:engine_version,
|
|
572
|
+
:port,
|
|
573
|
+
:master_username,
|
|
574
|
+
:master_user_password,
|
|
575
|
+
:preferred_backup_window,
|
|
576
|
+
:preferred_maintenance_window,
|
|
577
|
+
:tags,
|
|
578
|
+
:storage_encrypted,
|
|
579
|
+
:kms_key_id,
|
|
580
|
+
:enable_cloudwatch_logs_exports)
|
|
581
|
+
include Aws::Structure
|
|
582
|
+
end
|
|
583
|
+
|
|
584
|
+
# Represents the input of CreateDBClusterParameterGroup.
|
|
585
|
+
#
|
|
586
|
+
# @note When making an API call, you may pass CreateDBClusterParameterGroupMessage
|
|
587
|
+
# data as a hash:
|
|
588
|
+
#
|
|
589
|
+
# {
|
|
590
|
+
# db_cluster_parameter_group_name: "String", # required
|
|
591
|
+
# db_parameter_group_family: "String", # required
|
|
592
|
+
# description: "String", # required
|
|
593
|
+
# tags: [
|
|
594
|
+
# {
|
|
595
|
+
# key: "String",
|
|
596
|
+
# value: "String",
|
|
597
|
+
# },
|
|
598
|
+
# ],
|
|
599
|
+
# }
|
|
600
|
+
#
|
|
601
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
602
|
+
# The name of the DB cluster parameter group.
|
|
603
|
+
#
|
|
604
|
+
# Constraints:
|
|
605
|
+
#
|
|
606
|
+
# * Must match the name of an existing `DBClusterParameterGroup`.
|
|
607
|
+
#
|
|
608
|
+
# ^
|
|
609
|
+
#
|
|
610
|
+
# <note markdown="1"> This value is stored as a lowercase string.
|
|
611
|
+
#
|
|
612
|
+
# </note>
|
|
613
|
+
# @return [String]
|
|
614
|
+
#
|
|
615
|
+
# @!attribute [rw] db_parameter_group_family
|
|
616
|
+
# The DB cluster parameter group family name.
|
|
617
|
+
# @return [String]
|
|
618
|
+
#
|
|
619
|
+
# @!attribute [rw] description
|
|
620
|
+
# The description for the DB cluster parameter group.
|
|
621
|
+
# @return [String]
|
|
622
|
+
#
|
|
623
|
+
# @!attribute [rw] tags
|
|
624
|
+
# The tags to be assigned to the DB cluster parameter group.
|
|
625
|
+
# @return [Array<Types::Tag>]
|
|
626
|
+
#
|
|
627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroupMessage AWS API Documentation
|
|
628
|
+
#
|
|
629
|
+
class CreateDBClusterParameterGroupMessage < Struct.new(
|
|
630
|
+
:db_cluster_parameter_group_name,
|
|
631
|
+
:db_parameter_group_family,
|
|
632
|
+
:description,
|
|
633
|
+
:tags)
|
|
634
|
+
include Aws::Structure
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
# @!attribute [rw] db_cluster_parameter_group
|
|
638
|
+
# Detailed information about a DB cluster parameter group.
|
|
639
|
+
# @return [Types::DBClusterParameterGroup]
|
|
640
|
+
#
|
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroupResult AWS API Documentation
|
|
642
|
+
#
|
|
643
|
+
class CreateDBClusterParameterGroupResult < Struct.new(
|
|
644
|
+
:db_cluster_parameter_group)
|
|
645
|
+
include Aws::Structure
|
|
646
|
+
end
|
|
647
|
+
|
|
648
|
+
# @!attribute [rw] db_cluster
|
|
649
|
+
# Detailed information about a DB cluster.
|
|
650
|
+
# @return [Types::DBCluster]
|
|
651
|
+
#
|
|
652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterResult AWS API Documentation
|
|
653
|
+
#
|
|
654
|
+
class CreateDBClusterResult < Struct.new(
|
|
655
|
+
:db_cluster)
|
|
656
|
+
include Aws::Structure
|
|
657
|
+
end
|
|
658
|
+
|
|
659
|
+
# Represents the input of CreateDBClusterSnapshot.
|
|
660
|
+
#
|
|
661
|
+
# @note When making an API call, you may pass CreateDBClusterSnapshotMessage
|
|
662
|
+
# data as a hash:
|
|
663
|
+
#
|
|
664
|
+
# {
|
|
665
|
+
# db_cluster_snapshot_identifier: "String", # required
|
|
666
|
+
# db_cluster_identifier: "String", # required
|
|
667
|
+
# tags: [
|
|
668
|
+
# {
|
|
669
|
+
# key: "String",
|
|
670
|
+
# value: "String",
|
|
671
|
+
# },
|
|
672
|
+
# ],
|
|
673
|
+
# }
|
|
674
|
+
#
|
|
675
|
+
# @!attribute [rw] db_cluster_snapshot_identifier
|
|
676
|
+
# The identifier of the DB cluster snapshot. This parameter is stored
|
|
677
|
+
# as a lowercase string.
|
|
678
|
+
#
|
|
679
|
+
# Constraints:
|
|
680
|
+
#
|
|
681
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
682
|
+
#
|
|
683
|
+
# * The first character must be a letter.
|
|
684
|
+
#
|
|
685
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
686
|
+
#
|
|
687
|
+
# Example: `my-cluster-snapshot1`
|
|
688
|
+
# @return [String]
|
|
689
|
+
#
|
|
690
|
+
# @!attribute [rw] db_cluster_identifier
|
|
691
|
+
# The identifier of the DB cluster to create a snapshot for. This
|
|
692
|
+
# parameter is not case sensitive.
|
|
693
|
+
#
|
|
694
|
+
# Constraints:
|
|
695
|
+
#
|
|
696
|
+
# * Must match the identifier of an existing `DBCluster`.
|
|
697
|
+
#
|
|
698
|
+
# ^
|
|
699
|
+
#
|
|
700
|
+
# Example: `my-cluster`
|
|
701
|
+
# @return [String]
|
|
702
|
+
#
|
|
703
|
+
# @!attribute [rw] tags
|
|
704
|
+
# The tags to be assigned to the DB cluster snapshot.
|
|
705
|
+
# @return [Array<Types::Tag>]
|
|
706
|
+
#
|
|
707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshotMessage AWS API Documentation
|
|
708
|
+
#
|
|
709
|
+
class CreateDBClusterSnapshotMessage < Struct.new(
|
|
710
|
+
:db_cluster_snapshot_identifier,
|
|
711
|
+
:db_cluster_identifier,
|
|
712
|
+
:tags)
|
|
713
|
+
include Aws::Structure
|
|
714
|
+
end
|
|
715
|
+
|
|
716
|
+
# @!attribute [rw] db_cluster_snapshot
|
|
717
|
+
# Detailed information about a DB cluster snapshot.
|
|
718
|
+
# @return [Types::DBClusterSnapshot]
|
|
719
|
+
#
|
|
720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshotResult AWS API Documentation
|
|
721
|
+
#
|
|
722
|
+
class CreateDBClusterSnapshotResult < Struct.new(
|
|
723
|
+
:db_cluster_snapshot)
|
|
724
|
+
include Aws::Structure
|
|
725
|
+
end
|
|
726
|
+
|
|
727
|
+
# Represents the input to CreateDBInstance.
|
|
728
|
+
#
|
|
729
|
+
# @note When making an API call, you may pass CreateDBInstanceMessage
|
|
730
|
+
# data as a hash:
|
|
731
|
+
#
|
|
732
|
+
# {
|
|
733
|
+
# db_instance_identifier: "String", # required
|
|
734
|
+
# db_instance_class: "String", # required
|
|
735
|
+
# engine: "String", # required
|
|
736
|
+
# availability_zone: "String",
|
|
737
|
+
# preferred_maintenance_window: "String",
|
|
738
|
+
# auto_minor_version_upgrade: false,
|
|
739
|
+
# tags: [
|
|
740
|
+
# {
|
|
741
|
+
# key: "String",
|
|
742
|
+
# value: "String",
|
|
743
|
+
# },
|
|
744
|
+
# ],
|
|
745
|
+
# db_cluster_identifier: "String", # required
|
|
746
|
+
# promotion_tier: 1,
|
|
747
|
+
# }
|
|
748
|
+
#
|
|
749
|
+
# @!attribute [rw] db_instance_identifier
|
|
750
|
+
# The DB instance identifier. This parameter is stored as a lowercase
|
|
751
|
+
# string.
|
|
752
|
+
#
|
|
753
|
+
# Constraints:
|
|
754
|
+
#
|
|
755
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
756
|
+
#
|
|
757
|
+
# * The first character must be a letter.
|
|
758
|
+
#
|
|
759
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
760
|
+
#
|
|
761
|
+
# Example: `mydbinstance`
|
|
762
|
+
# @return [String]
|
|
763
|
+
#
|
|
764
|
+
# @!attribute [rw] db_instance_class
|
|
765
|
+
# The compute and memory capacity of the DB instance; for example,
|
|
766
|
+
# `db.m4.large`.
|
|
767
|
+
# @return [String]
|
|
768
|
+
#
|
|
769
|
+
# @!attribute [rw] engine
|
|
770
|
+
# The name of the database engine to be used for this instance.
|
|
771
|
+
#
|
|
772
|
+
# Valid value: `docdb`
|
|
773
|
+
# @return [String]
|
|
774
|
+
#
|
|
775
|
+
# @!attribute [rw] availability_zone
|
|
776
|
+
# The Amazon EC2 Availability Zone that the DB instance is created in.
|
|
777
|
+
#
|
|
778
|
+
# Default: A random, system-chosen Availability Zone in the
|
|
779
|
+
# endpoint's AWS Region.
|
|
780
|
+
#
|
|
781
|
+
# Example: `us-east-1d`
|
|
782
|
+
#
|
|
783
|
+
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
|
784
|
+
# the `MultiAZ` parameter is set to `true`. The specified Availability
|
|
785
|
+
# Zone must be in the same AWS Region as the current endpoint.
|
|
786
|
+
# @return [String]
|
|
787
|
+
#
|
|
788
|
+
# @!attribute [rw] preferred_maintenance_window
|
|
789
|
+
# The time range each week during which system maintenance can occur,
|
|
790
|
+
# in Universal Coordinated Time (UTC).
|
|
791
|
+
#
|
|
792
|
+
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
|
793
|
+
#
|
|
794
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
|
795
|
+
# block of time for each AWS Region, occurring on a random day of the
|
|
796
|
+
# week.
|
|
797
|
+
#
|
|
798
|
+
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
|
799
|
+
#
|
|
800
|
+
# Constraints: Minimum 30-minute window.
|
|
801
|
+
# @return [String]
|
|
802
|
+
#
|
|
803
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
|
804
|
+
# Indicates that minor engine upgrades are applied automatically to
|
|
805
|
+
# the DB instance during the maintenance window.
|
|
806
|
+
#
|
|
807
|
+
# Default: `true`
|
|
808
|
+
# @return [Boolean]
|
|
809
|
+
#
|
|
810
|
+
# @!attribute [rw] tags
|
|
811
|
+
# The tags to be assigned to the DB instance.
|
|
812
|
+
# @return [Array<Types::Tag>]
|
|
813
|
+
#
|
|
814
|
+
# @!attribute [rw] db_cluster_identifier
|
|
815
|
+
# The identifier of the DB cluster that the instance will belong to.
|
|
816
|
+
# @return [String]
|
|
817
|
+
#
|
|
818
|
+
# @!attribute [rw] promotion_tier
|
|
819
|
+
# A value that specifies the order in which an Amazon DocumentDB
|
|
820
|
+
# replica is promoted to the primary instance after a failure of the
|
|
821
|
+
# existing primary instance.
|
|
822
|
+
#
|
|
823
|
+
# Default: 1
|
|
824
|
+
#
|
|
825
|
+
# Valid values: 0-15
|
|
826
|
+
# @return [Integer]
|
|
827
|
+
#
|
|
828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
|
829
|
+
#
|
|
830
|
+
class CreateDBInstanceMessage < Struct.new(
|
|
831
|
+
:db_instance_identifier,
|
|
832
|
+
:db_instance_class,
|
|
833
|
+
:engine,
|
|
834
|
+
:availability_zone,
|
|
835
|
+
:preferred_maintenance_window,
|
|
836
|
+
:auto_minor_version_upgrade,
|
|
837
|
+
:tags,
|
|
838
|
+
:db_cluster_identifier,
|
|
839
|
+
:promotion_tier)
|
|
840
|
+
include Aws::Structure
|
|
841
|
+
end
|
|
842
|
+
|
|
843
|
+
# @!attribute [rw] db_instance
|
|
844
|
+
# Detailed information about a DB instance.
|
|
845
|
+
# @return [Types::DBInstance]
|
|
846
|
+
#
|
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstanceResult AWS API Documentation
|
|
848
|
+
#
|
|
849
|
+
class CreateDBInstanceResult < Struct.new(
|
|
850
|
+
:db_instance)
|
|
851
|
+
include Aws::Structure
|
|
852
|
+
end
|
|
853
|
+
|
|
854
|
+
# Represents the input to CreateDBSubnetGroup.
|
|
855
|
+
#
|
|
856
|
+
# @note When making an API call, you may pass CreateDBSubnetGroupMessage
|
|
857
|
+
# data as a hash:
|
|
858
|
+
#
|
|
859
|
+
# {
|
|
860
|
+
# db_subnet_group_name: "String", # required
|
|
861
|
+
# db_subnet_group_description: "String", # required
|
|
862
|
+
# subnet_ids: ["String"], # required
|
|
863
|
+
# tags: [
|
|
864
|
+
# {
|
|
865
|
+
# key: "String",
|
|
866
|
+
# value: "String",
|
|
867
|
+
# },
|
|
868
|
+
# ],
|
|
869
|
+
# }
|
|
870
|
+
#
|
|
871
|
+
# @!attribute [rw] db_subnet_group_name
|
|
872
|
+
# The name for the DB subnet group. This value is stored as a
|
|
873
|
+
# lowercase string.
|
|
874
|
+
#
|
|
875
|
+
# Constraints: Must contain no more than 255 letters, numbers,
|
|
876
|
+
# periods, underscores, spaces, or hyphens. Must not be default.
|
|
877
|
+
#
|
|
878
|
+
# Example: `mySubnetgroup`
|
|
879
|
+
# @return [String]
|
|
880
|
+
#
|
|
881
|
+
# @!attribute [rw] db_subnet_group_description
|
|
882
|
+
# The description for the DB subnet group.
|
|
883
|
+
# @return [String]
|
|
884
|
+
#
|
|
885
|
+
# @!attribute [rw] subnet_ids
|
|
886
|
+
# The Amazon EC2 subnet IDs for the DB subnet group.
|
|
887
|
+
# @return [Array<String>]
|
|
888
|
+
#
|
|
889
|
+
# @!attribute [rw] tags
|
|
890
|
+
# The tags to be assigned to the DB subnet group.
|
|
891
|
+
# @return [Array<Types::Tag>]
|
|
892
|
+
#
|
|
893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroupMessage AWS API Documentation
|
|
894
|
+
#
|
|
895
|
+
class CreateDBSubnetGroupMessage < Struct.new(
|
|
896
|
+
:db_subnet_group_name,
|
|
897
|
+
:db_subnet_group_description,
|
|
898
|
+
:subnet_ids,
|
|
899
|
+
:tags)
|
|
900
|
+
include Aws::Structure
|
|
901
|
+
end
|
|
902
|
+
|
|
903
|
+
# @!attribute [rw] db_subnet_group
|
|
904
|
+
# Detailed information about a DB subnet group.
|
|
905
|
+
# @return [Types::DBSubnetGroup]
|
|
906
|
+
#
|
|
907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroupResult AWS API Documentation
|
|
908
|
+
#
|
|
909
|
+
class CreateDBSubnetGroupResult < Struct.new(
|
|
910
|
+
:db_subnet_group)
|
|
911
|
+
include Aws::Structure
|
|
912
|
+
end
|
|
913
|
+
|
|
914
|
+
# Detailed information about a DB cluster.
|
|
915
|
+
#
|
|
916
|
+
# @!attribute [rw] availability_zones
|
|
917
|
+
# Provides the list of Amazon EC2 Availability Zones that instances in
|
|
918
|
+
# the DB cluster can be created in.
|
|
919
|
+
# @return [Array<String>]
|
|
920
|
+
#
|
|
921
|
+
# @!attribute [rw] backup_retention_period
|
|
922
|
+
# Specifies the number of days for which automatic DB snapshots are
|
|
923
|
+
# retained.
|
|
924
|
+
# @return [Integer]
|
|
925
|
+
#
|
|
926
|
+
# @!attribute [rw] db_cluster_identifier
|
|
927
|
+
# Contains a user-supplied DB cluster identifier. This identifier is
|
|
928
|
+
# the unique key that identifies a DB cluster.
|
|
929
|
+
# @return [String]
|
|
930
|
+
#
|
|
931
|
+
# @!attribute [rw] db_cluster_parameter_group
|
|
932
|
+
# Specifies the name of the DB cluster parameter group for the DB
|
|
933
|
+
# cluster.
|
|
934
|
+
# @return [String]
|
|
935
|
+
#
|
|
936
|
+
# @!attribute [rw] db_subnet_group
|
|
937
|
+
# Specifies information on the subnet group that is associated with
|
|
938
|
+
# the DB cluster, including the name, description, and subnets in the
|
|
939
|
+
# subnet group.
|
|
940
|
+
# @return [String]
|
|
941
|
+
#
|
|
942
|
+
# @!attribute [rw] status
|
|
943
|
+
# Specifies the current state of this DB cluster.
|
|
944
|
+
# @return [String]
|
|
945
|
+
#
|
|
946
|
+
# @!attribute [rw] percent_progress
|
|
947
|
+
# Specifies the progress of the operation as a percentage.
|
|
948
|
+
# @return [String]
|
|
949
|
+
#
|
|
950
|
+
# @!attribute [rw] earliest_restorable_time
|
|
951
|
+
# The earliest time to which a database can be restored with
|
|
952
|
+
# point-in-time restore.
|
|
953
|
+
# @return [Time]
|
|
954
|
+
#
|
|
955
|
+
# @!attribute [rw] endpoint
|
|
956
|
+
# Specifies the connection endpoint for the primary instance of the DB
|
|
957
|
+
# cluster.
|
|
958
|
+
# @return [String]
|
|
959
|
+
#
|
|
960
|
+
# @!attribute [rw] reader_endpoint
|
|
961
|
+
# The reader endpoint for the DB cluster. The reader endpoint for a DB
|
|
962
|
+
# cluster load balances connections across the Amazon DocumentDB
|
|
963
|
+
# replicas that are available in a DB cluster. As clients request new
|
|
964
|
+
# connections to the reader endpoint, Amazon DocumentDB distributes
|
|
965
|
+
# the connection requests among the Amazon DocumentDB replicas in the
|
|
966
|
+
# DB cluster. This functionality can help balance your read workload
|
|
967
|
+
# across multiple Amazon DocumentDB replicas in your DB cluster.
|
|
968
|
+
#
|
|
969
|
+
# If a failover occurs, and the Amazon DocumentDB replica that you are
|
|
970
|
+
# connected to is promoted to be the primary instance, your connection
|
|
971
|
+
# is dropped. To continue sending your read workload to other Amazon
|
|
972
|
+
# DocumentDB replicas in the cluster, you can then reconnect to the
|
|
973
|
+
# reader endpoint.
|
|
974
|
+
# @return [String]
|
|
975
|
+
#
|
|
976
|
+
# @!attribute [rw] multi_az
|
|
977
|
+
# Specifies whether the DB cluster has instances in multiple
|
|
978
|
+
# Availability Zones.
|
|
979
|
+
# @return [Boolean]
|
|
980
|
+
#
|
|
981
|
+
# @!attribute [rw] engine
|
|
982
|
+
# Provides the name of the database engine to be used for this DB
|
|
983
|
+
# cluster.
|
|
984
|
+
# @return [String]
|
|
985
|
+
#
|
|
986
|
+
# @!attribute [rw] engine_version
|
|
987
|
+
# Indicates the database engine version.
|
|
988
|
+
# @return [String]
|
|
989
|
+
#
|
|
990
|
+
# @!attribute [rw] latest_restorable_time
|
|
991
|
+
# Specifies the latest time to which a database can be restored with
|
|
992
|
+
# point-in-time restore.
|
|
993
|
+
# @return [Time]
|
|
994
|
+
#
|
|
995
|
+
# @!attribute [rw] port
|
|
996
|
+
# Specifies the port that the database engine is listening on.
|
|
997
|
+
# @return [Integer]
|
|
998
|
+
#
|
|
999
|
+
# @!attribute [rw] master_username
|
|
1000
|
+
# Contains the master user name for the DB cluster.
|
|
1001
|
+
# @return [String]
|
|
1002
|
+
#
|
|
1003
|
+
# @!attribute [rw] preferred_backup_window
|
|
1004
|
+
# Specifies the daily time range during which automated backups are
|
|
1005
|
+
# created if automated backups are enabled, as determined by the
|
|
1006
|
+
# `BackupRetentionPeriod`.
|
|
1007
|
+
# @return [String]
|
|
1008
|
+
#
|
|
1009
|
+
# @!attribute [rw] preferred_maintenance_window
|
|
1010
|
+
# Specifies the weekly time range during which system maintenance can
|
|
1011
|
+
# occur, in Universal Coordinated Time (UTC).
|
|
1012
|
+
# @return [String]
|
|
1013
|
+
#
|
|
1014
|
+
# @!attribute [rw] db_cluster_members
|
|
1015
|
+
# Provides the list of instances that make up the DB cluster.
|
|
1016
|
+
# @return [Array<Types::DBClusterMember>]
|
|
1017
|
+
#
|
|
1018
|
+
# @!attribute [rw] vpc_security_groups
|
|
1019
|
+
# Provides a list of virtual private cloud (VPC) security groups that
|
|
1020
|
+
# the DB cluster belongs to.
|
|
1021
|
+
# @return [Array<Types::VpcSecurityGroupMembership>]
|
|
1022
|
+
#
|
|
1023
|
+
# @!attribute [rw] hosted_zone_id
|
|
1024
|
+
# Specifies the ID that Amazon Route 53 assigns when you create a
|
|
1025
|
+
# hosted zone.
|
|
1026
|
+
# @return [String]
|
|
1027
|
+
#
|
|
1028
|
+
# @!attribute [rw] storage_encrypted
|
|
1029
|
+
# Specifies whether the DB cluster is encrypted.
|
|
1030
|
+
# @return [Boolean]
|
|
1031
|
+
#
|
|
1032
|
+
# @!attribute [rw] kms_key_id
|
|
1033
|
+
# If `StorageEncrypted` is `true`, the AWS KMS key identifier for the
|
|
1034
|
+
# encrypted DB cluster.
|
|
1035
|
+
# @return [String]
|
|
1036
|
+
#
|
|
1037
|
+
# @!attribute [rw] db_cluster_resource_id
|
|
1038
|
+
# The AWS Region-unique, immutable identifier for the DB cluster. This
|
|
1039
|
+
# identifier is found in AWS CloudTrail log entries whenever the AWS
|
|
1040
|
+
# KMS key for the DB cluster is accessed.
|
|
1041
|
+
# @return [String]
|
|
1042
|
+
#
|
|
1043
|
+
# @!attribute [rw] db_cluster_arn
|
|
1044
|
+
# The Amazon Resource Name (ARN) for the DB cluster.
|
|
1045
|
+
# @return [String]
|
|
1046
|
+
#
|
|
1047
|
+
# @!attribute [rw] associated_roles
|
|
1048
|
+
# Provides a list of the AWS Identity and Access Management (IAM)
|
|
1049
|
+
# roles that are associated with the DB cluster. IAM roles that are
|
|
1050
|
+
# associated with a DB cluster grant permission for the DB cluster to
|
|
1051
|
+
# access other AWS services on your behalf.
|
|
1052
|
+
# @return [Array<Types::DBClusterRole>]
|
|
1053
|
+
#
|
|
1054
|
+
# @!attribute [rw] cluster_create_time
|
|
1055
|
+
# Specifies the time when the DB cluster was created, in Universal
|
|
1056
|
+
# Coordinated Time (UTC).
|
|
1057
|
+
# @return [Time]
|
|
1058
|
+
#
|
|
1059
|
+
# @!attribute [rw] enabled_cloudwatch_logs_exports
|
|
1060
|
+
# A list of log types that this DB cluster is configured to export to
|
|
1061
|
+
# Amazon CloudWatch Logs.
|
|
1062
|
+
# @return [Array<String>]
|
|
1063
|
+
#
|
|
1064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBCluster AWS API Documentation
|
|
1065
|
+
#
|
|
1066
|
+
class DBCluster < Struct.new(
|
|
1067
|
+
:availability_zones,
|
|
1068
|
+
:backup_retention_period,
|
|
1069
|
+
:db_cluster_identifier,
|
|
1070
|
+
:db_cluster_parameter_group,
|
|
1071
|
+
:db_subnet_group,
|
|
1072
|
+
:status,
|
|
1073
|
+
:percent_progress,
|
|
1074
|
+
:earliest_restorable_time,
|
|
1075
|
+
:endpoint,
|
|
1076
|
+
:reader_endpoint,
|
|
1077
|
+
:multi_az,
|
|
1078
|
+
:engine,
|
|
1079
|
+
:engine_version,
|
|
1080
|
+
:latest_restorable_time,
|
|
1081
|
+
:port,
|
|
1082
|
+
:master_username,
|
|
1083
|
+
:preferred_backup_window,
|
|
1084
|
+
:preferred_maintenance_window,
|
|
1085
|
+
:db_cluster_members,
|
|
1086
|
+
:vpc_security_groups,
|
|
1087
|
+
:hosted_zone_id,
|
|
1088
|
+
:storage_encrypted,
|
|
1089
|
+
:kms_key_id,
|
|
1090
|
+
:db_cluster_resource_id,
|
|
1091
|
+
:db_cluster_arn,
|
|
1092
|
+
:associated_roles,
|
|
1093
|
+
:cluster_create_time,
|
|
1094
|
+
:enabled_cloudwatch_logs_exports)
|
|
1095
|
+
include Aws::Structure
|
|
1096
|
+
end
|
|
1097
|
+
|
|
1098
|
+
# Contains information about an instance that is part of a DB cluster.
|
|
1099
|
+
#
|
|
1100
|
+
# @!attribute [rw] db_instance_identifier
|
|
1101
|
+
# Specifies the instance identifier for this member of the DB cluster.
|
|
1102
|
+
# @return [String]
|
|
1103
|
+
#
|
|
1104
|
+
# @!attribute [rw] is_cluster_writer
|
|
1105
|
+
# A value that is `true` if the cluster member is the primary instance
|
|
1106
|
+
# for the DB cluster and `false` otherwise.
|
|
1107
|
+
# @return [Boolean]
|
|
1108
|
+
#
|
|
1109
|
+
# @!attribute [rw] db_cluster_parameter_group_status
|
|
1110
|
+
# Specifies the status of the DB cluster parameter group for this
|
|
1111
|
+
# member of the DB cluster.
|
|
1112
|
+
# @return [String]
|
|
1113
|
+
#
|
|
1114
|
+
# @!attribute [rw] promotion_tier
|
|
1115
|
+
# A value that specifies the order in which an Amazon DocumentDB
|
|
1116
|
+
# replica is promoted to the primary instance after a failure of the
|
|
1117
|
+
# existing primary instance.
|
|
1118
|
+
# @return [Integer]
|
|
1119
|
+
#
|
|
1120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterMember AWS API Documentation
|
|
1121
|
+
#
|
|
1122
|
+
class DBClusterMember < Struct.new(
|
|
1123
|
+
:db_instance_identifier,
|
|
1124
|
+
:is_cluster_writer,
|
|
1125
|
+
:db_cluster_parameter_group_status,
|
|
1126
|
+
:promotion_tier)
|
|
1127
|
+
include Aws::Structure
|
|
1128
|
+
end
|
|
1129
|
+
|
|
1130
|
+
# Represents the output of DescribeDBClusters.
|
|
1131
|
+
#
|
|
1132
|
+
# @!attribute [rw] marker
|
|
1133
|
+
# An optional pagination token provided by a previous request. If this
|
|
1134
|
+
# parameter is specified, the response includes only records beyond
|
|
1135
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
1136
|
+
# @return [String]
|
|
1137
|
+
#
|
|
1138
|
+
# @!attribute [rw] db_clusters
|
|
1139
|
+
# A list of DB clusters.
|
|
1140
|
+
# @return [Array<Types::DBCluster>]
|
|
1141
|
+
#
|
|
1142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterMessage AWS API Documentation
|
|
1143
|
+
#
|
|
1144
|
+
class DBClusterMessage < Struct.new(
|
|
1145
|
+
:marker,
|
|
1146
|
+
:db_clusters)
|
|
1147
|
+
include Aws::Structure
|
|
1148
|
+
end
|
|
1149
|
+
|
|
1150
|
+
# Detailed information about a DB cluster parameter group.
|
|
1151
|
+
#
|
|
1152
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
1153
|
+
# Provides the name of the DB cluster parameter group.
|
|
1154
|
+
# @return [String]
|
|
1155
|
+
#
|
|
1156
|
+
# @!attribute [rw] db_parameter_group_family
|
|
1157
|
+
# Provides the name of the DB parameter group family that this DB
|
|
1158
|
+
# cluster parameter group is compatible with.
|
|
1159
|
+
# @return [String]
|
|
1160
|
+
#
|
|
1161
|
+
# @!attribute [rw] description
|
|
1162
|
+
# Provides the customer-specified description for this DB cluster
|
|
1163
|
+
# parameter group.
|
|
1164
|
+
# @return [String]
|
|
1165
|
+
#
|
|
1166
|
+
# @!attribute [rw] db_cluster_parameter_group_arn
|
|
1167
|
+
# The Amazon Resource Name (ARN) for the DB cluster parameter group.
|
|
1168
|
+
# @return [String]
|
|
1169
|
+
#
|
|
1170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroup AWS API Documentation
|
|
1171
|
+
#
|
|
1172
|
+
class DBClusterParameterGroup < Struct.new(
|
|
1173
|
+
:db_cluster_parameter_group_name,
|
|
1174
|
+
:db_parameter_group_family,
|
|
1175
|
+
:description,
|
|
1176
|
+
:db_cluster_parameter_group_arn)
|
|
1177
|
+
include Aws::Structure
|
|
1178
|
+
end
|
|
1179
|
+
|
|
1180
|
+
# Represents the output of DBClusterParameterGroup.
|
|
1181
|
+
#
|
|
1182
|
+
# @!attribute [rw] parameters
|
|
1183
|
+
# Provides a list of parameters for the DB cluster parameter group.
|
|
1184
|
+
# @return [Array<Types::Parameter>]
|
|
1185
|
+
#
|
|
1186
|
+
# @!attribute [rw] marker
|
|
1187
|
+
# An optional pagination token provided by a previous request. If this
|
|
1188
|
+
# parameter is specified, the response includes only records beyond
|
|
1189
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
1190
|
+
# @return [String]
|
|
1191
|
+
#
|
|
1192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupDetails AWS API Documentation
|
|
1193
|
+
#
|
|
1194
|
+
class DBClusterParameterGroupDetails < Struct.new(
|
|
1195
|
+
:parameters,
|
|
1196
|
+
:marker)
|
|
1197
|
+
include Aws::Structure
|
|
1198
|
+
end
|
|
1199
|
+
|
|
1200
|
+
# Contains the name of a DB cluster parameter group.
|
|
1201
|
+
#
|
|
1202
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
1203
|
+
# The name of a DB cluster parameter group.
|
|
1204
|
+
#
|
|
1205
|
+
# Constraints:
|
|
1206
|
+
#
|
|
1207
|
+
# * Must be from 1 to 255 letters or numbers.
|
|
1208
|
+
#
|
|
1209
|
+
# * The first character must be a letter.
|
|
1210
|
+
#
|
|
1211
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
1212
|
+
#
|
|
1213
|
+
# <note markdown="1"> This value is stored as a lowercase string.
|
|
1214
|
+
#
|
|
1215
|
+
# </note>
|
|
1216
|
+
# @return [String]
|
|
1217
|
+
#
|
|
1218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupNameMessage AWS API Documentation
|
|
1219
|
+
#
|
|
1220
|
+
class DBClusterParameterGroupNameMessage < Struct.new(
|
|
1221
|
+
:db_cluster_parameter_group_name)
|
|
1222
|
+
include Aws::Structure
|
|
1223
|
+
end
|
|
1224
|
+
|
|
1225
|
+
# Represents the output of DBClusterParameterGroups.
|
|
1226
|
+
#
|
|
1227
|
+
# @!attribute [rw] marker
|
|
1228
|
+
# An optional pagination token provided by a previous request. If this
|
|
1229
|
+
# parameter is specified, the response includes only records beyond
|
|
1230
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
1231
|
+
# @return [String]
|
|
1232
|
+
#
|
|
1233
|
+
# @!attribute [rw] db_cluster_parameter_groups
|
|
1234
|
+
# A list of DB cluster parameter groups.
|
|
1235
|
+
# @return [Array<Types::DBClusterParameterGroup>]
|
|
1236
|
+
#
|
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupsMessage AWS API Documentation
|
|
1238
|
+
#
|
|
1239
|
+
class DBClusterParameterGroupsMessage < Struct.new(
|
|
1240
|
+
:marker,
|
|
1241
|
+
:db_cluster_parameter_groups)
|
|
1242
|
+
include Aws::Structure
|
|
1243
|
+
end
|
|
1244
|
+
|
|
1245
|
+
# Describes an AWS Identity and Access Management (IAM) role that is
|
|
1246
|
+
# associated with a DB cluster.
|
|
1247
|
+
#
|
|
1248
|
+
# @!attribute [rw] role_arn
|
|
1249
|
+
# The Amazon Resource Name (ARN) of the IAM role that is associated
|
|
1250
|
+
# with the DB cluster.
|
|
1251
|
+
# @return [String]
|
|
1252
|
+
#
|
|
1253
|
+
# @!attribute [rw] status
|
|
1254
|
+
# Describes the state of association between the IAM role and the DB
|
|
1255
|
+
# cluster. The `Status` property returns one of the following values:
|
|
1256
|
+
#
|
|
1257
|
+
# * `ACTIVE` - The IAM role ARN is associated with the DB cluster and
|
|
1258
|
+
# can be used to access other AWS services on your behalf.
|
|
1259
|
+
#
|
|
1260
|
+
# * `PENDING` - The IAM role ARN is being associated with the DB
|
|
1261
|
+
# cluster.
|
|
1262
|
+
#
|
|
1263
|
+
# * `INVALID` - The IAM role ARN is associated with the DB cluster,
|
|
1264
|
+
# but the DB cluster cannot assume the IAM role to access other AWS
|
|
1265
|
+
# services on your behalf.
|
|
1266
|
+
# @return [String]
|
|
1267
|
+
#
|
|
1268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterRole AWS API Documentation
|
|
1269
|
+
#
|
|
1270
|
+
class DBClusterRole < Struct.new(
|
|
1271
|
+
:role_arn,
|
|
1272
|
+
:status)
|
|
1273
|
+
include Aws::Structure
|
|
1274
|
+
end
|
|
1275
|
+
|
|
1276
|
+
# Detailed information about a DB cluster snapshot.
|
|
1277
|
+
#
|
|
1278
|
+
# @!attribute [rw] availability_zones
|
|
1279
|
+
# Provides the list of Amazon EC2 Availability Zones that instances in
|
|
1280
|
+
# the DB cluster snapshot can be restored in.
|
|
1281
|
+
# @return [Array<String>]
|
|
1282
|
+
#
|
|
1283
|
+
# @!attribute [rw] db_cluster_snapshot_identifier
|
|
1284
|
+
# Specifies the identifier for the DB cluster snapshot.
|
|
1285
|
+
# @return [String]
|
|
1286
|
+
#
|
|
1287
|
+
# @!attribute [rw] db_cluster_identifier
|
|
1288
|
+
# Specifies the DB cluster identifier of the DB cluster that this DB
|
|
1289
|
+
# cluster snapshot was created from.
|
|
1290
|
+
# @return [String]
|
|
1291
|
+
#
|
|
1292
|
+
# @!attribute [rw] snapshot_create_time
|
|
1293
|
+
# Provides the time when the snapshot was taken, in UTC.
|
|
1294
|
+
# @return [Time]
|
|
1295
|
+
#
|
|
1296
|
+
# @!attribute [rw] engine
|
|
1297
|
+
# Specifies the name of the database engine.
|
|
1298
|
+
# @return [String]
|
|
1299
|
+
#
|
|
1300
|
+
# @!attribute [rw] status
|
|
1301
|
+
# Specifies the status of this DB cluster snapshot.
|
|
1302
|
+
# @return [String]
|
|
1303
|
+
#
|
|
1304
|
+
# @!attribute [rw] port
|
|
1305
|
+
# Specifies the port that the DB cluster was listening on at the time
|
|
1306
|
+
# of the snapshot.
|
|
1307
|
+
# @return [Integer]
|
|
1308
|
+
#
|
|
1309
|
+
# @!attribute [rw] vpc_id
|
|
1310
|
+
# Provides the virtual private cloud (VPC) ID that is associated with
|
|
1311
|
+
# the DB cluster snapshot.
|
|
1312
|
+
# @return [String]
|
|
1313
|
+
#
|
|
1314
|
+
# @!attribute [rw] cluster_create_time
|
|
1315
|
+
# Specifies the time when the DB cluster was created, in Universal
|
|
1316
|
+
# Coordinated Time (UTC).
|
|
1317
|
+
# @return [Time]
|
|
1318
|
+
#
|
|
1319
|
+
# @!attribute [rw] master_username
|
|
1320
|
+
# Provides the master user name for the DB cluster snapshot.
|
|
1321
|
+
# @return [String]
|
|
1322
|
+
#
|
|
1323
|
+
# @!attribute [rw] engine_version
|
|
1324
|
+
# Provides the version of the database engine for this DB cluster
|
|
1325
|
+
# snapshot.
|
|
1326
|
+
# @return [String]
|
|
1327
|
+
#
|
|
1328
|
+
# @!attribute [rw] snapshot_type
|
|
1329
|
+
# Provides the type of the DB cluster snapshot.
|
|
1330
|
+
# @return [String]
|
|
1331
|
+
#
|
|
1332
|
+
# @!attribute [rw] percent_progress
|
|
1333
|
+
# Specifies the percentage of the estimated data that has been
|
|
1334
|
+
# transferred.
|
|
1335
|
+
# @return [Integer]
|
|
1336
|
+
#
|
|
1337
|
+
# @!attribute [rw] storage_encrypted
|
|
1338
|
+
# Specifies whether the DB cluster snapshot is encrypted.
|
|
1339
|
+
# @return [Boolean]
|
|
1340
|
+
#
|
|
1341
|
+
# @!attribute [rw] kms_key_id
|
|
1342
|
+
# If `StorageEncrypted` is `true`, the AWS KMS key identifier for the
|
|
1343
|
+
# encrypted DB cluster snapshot.
|
|
1344
|
+
# @return [String]
|
|
1345
|
+
#
|
|
1346
|
+
# @!attribute [rw] db_cluster_snapshot_arn
|
|
1347
|
+
# The Amazon Resource Name (ARN) for the DB cluster snapshot.
|
|
1348
|
+
# @return [String]
|
|
1349
|
+
#
|
|
1350
|
+
# @!attribute [rw] source_db_cluster_snapshot_arn
|
|
1351
|
+
# If the DB cluster snapshot was copied from a source DB cluster
|
|
1352
|
+
# snapshot, the ARN for the source DB cluster snapshot; otherwise, a
|
|
1353
|
+
# null value.
|
|
1354
|
+
# @return [String]
|
|
1355
|
+
#
|
|
1356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshot AWS API Documentation
|
|
1357
|
+
#
|
|
1358
|
+
class DBClusterSnapshot < Struct.new(
|
|
1359
|
+
:availability_zones,
|
|
1360
|
+
:db_cluster_snapshot_identifier,
|
|
1361
|
+
:db_cluster_identifier,
|
|
1362
|
+
:snapshot_create_time,
|
|
1363
|
+
:engine,
|
|
1364
|
+
:status,
|
|
1365
|
+
:port,
|
|
1366
|
+
:vpc_id,
|
|
1367
|
+
:cluster_create_time,
|
|
1368
|
+
:master_username,
|
|
1369
|
+
:engine_version,
|
|
1370
|
+
:snapshot_type,
|
|
1371
|
+
:percent_progress,
|
|
1372
|
+
:storage_encrypted,
|
|
1373
|
+
:kms_key_id,
|
|
1374
|
+
:db_cluster_snapshot_arn,
|
|
1375
|
+
:source_db_cluster_snapshot_arn)
|
|
1376
|
+
include Aws::Structure
|
|
1377
|
+
end
|
|
1378
|
+
|
|
1379
|
+
# Contains the name and values of a manual DB cluster snapshot
|
|
1380
|
+
# attribute.
|
|
1381
|
+
#
|
|
1382
|
+
# Manual DB cluster snapshot attributes are used to authorize other AWS
|
|
1383
|
+
# accounts to restore a manual DB cluster snapshot.
|
|
1384
|
+
#
|
|
1385
|
+
# @!attribute [rw] attribute_name
|
|
1386
|
+
# The name of the manual DB cluster snapshot attribute.
|
|
1387
|
+
#
|
|
1388
|
+
# The attribute named `restore` refers to the list of AWS accounts
|
|
1389
|
+
# that have permission to copy or restore the manual DB cluster
|
|
1390
|
+
# snapshot.
|
|
1391
|
+
# @return [String]
|
|
1392
|
+
#
|
|
1393
|
+
# @!attribute [rw] attribute_values
|
|
1394
|
+
# The values for the manual DB cluster snapshot attribute.
|
|
1395
|
+
#
|
|
1396
|
+
# If the `AttributeName` field is set to `restore`, then this element
|
|
1397
|
+
# returns a list of IDs of the AWS accounts that are authorized to
|
|
1398
|
+
# copy or restore the manual DB cluster snapshot. If a value of `all`
|
|
1399
|
+
# is in the list, then the manual DB cluster snapshot is public and
|
|
1400
|
+
# available for any AWS account to copy or restore.
|
|
1401
|
+
# @return [Array<String>]
|
|
1402
|
+
#
|
|
1403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttribute AWS API Documentation
|
|
1404
|
+
#
|
|
1405
|
+
class DBClusterSnapshotAttribute < Struct.new(
|
|
1406
|
+
:attribute_name,
|
|
1407
|
+
:attribute_values)
|
|
1408
|
+
include Aws::Structure
|
|
1409
|
+
end
|
|
1410
|
+
|
|
1411
|
+
# Detailed information about the attributes that are associated with a
|
|
1412
|
+
# DB cluster snapshot.
|
|
1413
|
+
#
|
|
1414
|
+
# @!attribute [rw] db_cluster_snapshot_identifier
|
|
1415
|
+
# The identifier of the DB cluster snapshot that the attributes apply
|
|
1416
|
+
# to.
|
|
1417
|
+
# @return [String]
|
|
1418
|
+
#
|
|
1419
|
+
# @!attribute [rw] db_cluster_snapshot_attributes
|
|
1420
|
+
# The list of attributes and values for the DB cluster snapshot.
|
|
1421
|
+
# @return [Array<Types::DBClusterSnapshotAttribute>]
|
|
1422
|
+
#
|
|
1423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttributesResult AWS API Documentation
|
|
1424
|
+
#
|
|
1425
|
+
class DBClusterSnapshotAttributesResult < Struct.new(
|
|
1426
|
+
:db_cluster_snapshot_identifier,
|
|
1427
|
+
:db_cluster_snapshot_attributes)
|
|
1428
|
+
include Aws::Structure
|
|
1429
|
+
end
|
|
1430
|
+
|
|
1431
|
+
# Represents the output of DescribeDBClusterSnapshots.
|
|
1432
|
+
#
|
|
1433
|
+
# @!attribute [rw] marker
|
|
1434
|
+
# An optional pagination token provided by a previous request. If this
|
|
1435
|
+
# parameter is specified, the response includes only records beyond
|
|
1436
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
1437
|
+
# @return [String]
|
|
1438
|
+
#
|
|
1439
|
+
# @!attribute [rw] db_cluster_snapshots
|
|
1440
|
+
# Provides a list of DB cluster snapshots.
|
|
1441
|
+
# @return [Array<Types::DBClusterSnapshot>]
|
|
1442
|
+
#
|
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotMessage AWS API Documentation
|
|
1444
|
+
#
|
|
1445
|
+
class DBClusterSnapshotMessage < Struct.new(
|
|
1446
|
+
:marker,
|
|
1447
|
+
:db_cluster_snapshots)
|
|
1448
|
+
include Aws::Structure
|
|
1449
|
+
end
|
|
1450
|
+
|
|
1451
|
+
# Detailed information about a DB engine version.
|
|
1452
|
+
#
|
|
1453
|
+
# @!attribute [rw] engine
|
|
1454
|
+
# The name of the database engine.
|
|
1455
|
+
# @return [String]
|
|
1456
|
+
#
|
|
1457
|
+
# @!attribute [rw] engine_version
|
|
1458
|
+
# The version number of the database engine.
|
|
1459
|
+
# @return [String]
|
|
1460
|
+
#
|
|
1461
|
+
# @!attribute [rw] db_parameter_group_family
|
|
1462
|
+
# The name of the DB parameter group family for the database engine.
|
|
1463
|
+
# @return [String]
|
|
1464
|
+
#
|
|
1465
|
+
# @!attribute [rw] db_engine_description
|
|
1466
|
+
# The description of the database engine.
|
|
1467
|
+
# @return [String]
|
|
1468
|
+
#
|
|
1469
|
+
# @!attribute [rw] db_engine_version_description
|
|
1470
|
+
# The description of the database engine version.
|
|
1471
|
+
# @return [String]
|
|
1472
|
+
#
|
|
1473
|
+
# @!attribute [rw] valid_upgrade_target
|
|
1474
|
+
# A list of engine versions that this database engine version can be
|
|
1475
|
+
# upgraded to.
|
|
1476
|
+
# @return [Array<Types::UpgradeTarget>]
|
|
1477
|
+
#
|
|
1478
|
+
# @!attribute [rw] exportable_log_types
|
|
1479
|
+
# The types of logs that the database engine has available for export
|
|
1480
|
+
# to Amazon CloudWatch Logs.
|
|
1481
|
+
# @return [Array<String>]
|
|
1482
|
+
#
|
|
1483
|
+
# @!attribute [rw] supports_log_exports_to_cloudwatch_logs
|
|
1484
|
+
# A value that indicates whether the engine version supports exporting
|
|
1485
|
+
# the log types specified by `ExportableLogTypes` to CloudWatch Logs.
|
|
1486
|
+
# @return [Boolean]
|
|
1487
|
+
#
|
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBEngineVersion AWS API Documentation
|
|
1489
|
+
#
|
|
1490
|
+
class DBEngineVersion < Struct.new(
|
|
1491
|
+
:engine,
|
|
1492
|
+
:engine_version,
|
|
1493
|
+
:db_parameter_group_family,
|
|
1494
|
+
:db_engine_description,
|
|
1495
|
+
:db_engine_version_description,
|
|
1496
|
+
:valid_upgrade_target,
|
|
1497
|
+
:exportable_log_types,
|
|
1498
|
+
:supports_log_exports_to_cloudwatch_logs)
|
|
1499
|
+
include Aws::Structure
|
|
1500
|
+
end
|
|
1501
|
+
|
|
1502
|
+
# Represents the output of DescribeDBEngineVersions.
|
|
1503
|
+
#
|
|
1504
|
+
# @!attribute [rw] marker
|
|
1505
|
+
# An optional pagination token provided by a previous request. If this
|
|
1506
|
+
# parameter is specified, the response includes only records beyond
|
|
1507
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
1508
|
+
# @return [String]
|
|
1509
|
+
#
|
|
1510
|
+
# @!attribute [rw] db_engine_versions
|
|
1511
|
+
# Detailed information about one or more DB engine versions.
|
|
1512
|
+
# @return [Array<Types::DBEngineVersion>]
|
|
1513
|
+
#
|
|
1514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBEngineVersionMessage AWS API Documentation
|
|
1515
|
+
#
|
|
1516
|
+
class DBEngineVersionMessage < Struct.new(
|
|
1517
|
+
:marker,
|
|
1518
|
+
:db_engine_versions)
|
|
1519
|
+
include Aws::Structure
|
|
1520
|
+
end
|
|
1521
|
+
|
|
1522
|
+
# Detailed information about a DB instance.
|
|
1523
|
+
#
|
|
1524
|
+
# @!attribute [rw] db_instance_identifier
|
|
1525
|
+
# Contains a user-provided database identifier. This identifier is the
|
|
1526
|
+
# unique key that identifies a DB instance.
|
|
1527
|
+
# @return [String]
|
|
1528
|
+
#
|
|
1529
|
+
# @!attribute [rw] db_instance_class
|
|
1530
|
+
# Contains the name of the compute and memory capacity class of the DB
|
|
1531
|
+
# instance.
|
|
1532
|
+
# @return [String]
|
|
1533
|
+
#
|
|
1534
|
+
# @!attribute [rw] engine
|
|
1535
|
+
# Provides the name of the database engine to be used for this DB
|
|
1536
|
+
# instance.
|
|
1537
|
+
# @return [String]
|
|
1538
|
+
#
|
|
1539
|
+
# @!attribute [rw] db_instance_status
|
|
1540
|
+
# Specifies the current state of this database.
|
|
1541
|
+
# @return [String]
|
|
1542
|
+
#
|
|
1543
|
+
# @!attribute [rw] endpoint
|
|
1544
|
+
# Specifies the connection endpoint.
|
|
1545
|
+
# @return [Types::Endpoint]
|
|
1546
|
+
#
|
|
1547
|
+
# @!attribute [rw] instance_create_time
|
|
1548
|
+
# Provides the date and time that the DB instance was created.
|
|
1549
|
+
# @return [Time]
|
|
1550
|
+
#
|
|
1551
|
+
# @!attribute [rw] preferred_backup_window
|
|
1552
|
+
# Specifies the daily time range during which automated backups are
|
|
1553
|
+
# created if automated backups are enabled, as determined by the
|
|
1554
|
+
# `BackupRetentionPeriod`.
|
|
1555
|
+
# @return [String]
|
|
1556
|
+
#
|
|
1557
|
+
# @!attribute [rw] backup_retention_period
|
|
1558
|
+
# Specifies the number of days for which automatic DB snapshots are
|
|
1559
|
+
# retained.
|
|
1560
|
+
# @return [Integer]
|
|
1561
|
+
#
|
|
1562
|
+
# @!attribute [rw] vpc_security_groups
|
|
1563
|
+
# Provides a list of VPC security group elements that the DB instance
|
|
1564
|
+
# belongs to.
|
|
1565
|
+
# @return [Array<Types::VpcSecurityGroupMembership>]
|
|
1566
|
+
#
|
|
1567
|
+
# @!attribute [rw] availability_zone
|
|
1568
|
+
# Specifies the name of the Availability Zone that the DB instance is
|
|
1569
|
+
# located in.
|
|
1570
|
+
# @return [String]
|
|
1571
|
+
#
|
|
1572
|
+
# @!attribute [rw] db_subnet_group
|
|
1573
|
+
# Specifies information on the subnet group that is associated with
|
|
1574
|
+
# the DB instance, including the name, description, and subnets in the
|
|
1575
|
+
# subnet group.
|
|
1576
|
+
# @return [Types::DBSubnetGroup]
|
|
1577
|
+
#
|
|
1578
|
+
# @!attribute [rw] preferred_maintenance_window
|
|
1579
|
+
# Specifies the weekly time range during which system maintenance can
|
|
1580
|
+
# occur, in Universal Coordinated Time (UTC).
|
|
1581
|
+
# @return [String]
|
|
1582
|
+
#
|
|
1583
|
+
# @!attribute [rw] pending_modified_values
|
|
1584
|
+
# Specifies that changes to the DB instance are pending. This element
|
|
1585
|
+
# is included only when changes are pending. Specific changes are
|
|
1586
|
+
# identified by subelements.
|
|
1587
|
+
# @return [Types::PendingModifiedValues]
|
|
1588
|
+
#
|
|
1589
|
+
# @!attribute [rw] latest_restorable_time
|
|
1590
|
+
# Specifies the latest time to which a database can be restored with
|
|
1591
|
+
# point-in-time restore.
|
|
1592
|
+
# @return [Time]
|
|
1593
|
+
#
|
|
1594
|
+
# @!attribute [rw] engine_version
|
|
1595
|
+
# Indicates the database engine version.
|
|
1596
|
+
# @return [String]
|
|
1597
|
+
#
|
|
1598
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
|
1599
|
+
# Indicates that minor version patches are applied automatically.
|
|
1600
|
+
# @return [Boolean]
|
|
1601
|
+
#
|
|
1602
|
+
# @!attribute [rw] publicly_accessible
|
|
1603
|
+
# Specifies the availability options for the DB instance. A value of
|
|
1604
|
+
# `true` specifies an internet-facing instance with a publicly
|
|
1605
|
+
# resolvable DNS name, which resolves to a public IP address. A value
|
|
1606
|
+
# of `false` specifies an internal instance with a DNS name that
|
|
1607
|
+
# resolves to a private IP address.
|
|
1608
|
+
# @return [Boolean]
|
|
1609
|
+
#
|
|
1610
|
+
# @!attribute [rw] status_infos
|
|
1611
|
+
# The status of a read replica. If the instance is not a read replica,
|
|
1612
|
+
# this is blank.
|
|
1613
|
+
# @return [Array<Types::DBInstanceStatusInfo>]
|
|
1614
|
+
#
|
|
1615
|
+
# @!attribute [rw] db_cluster_identifier
|
|
1616
|
+
# Contains the name of the DB cluster that the DB instance is a member
|
|
1617
|
+
# of if the DB instance is a member of a DB cluster.
|
|
1618
|
+
# @return [String]
|
|
1619
|
+
#
|
|
1620
|
+
# @!attribute [rw] storage_encrypted
|
|
1621
|
+
# Specifies whether the DB instance is encrypted.
|
|
1622
|
+
# @return [Boolean]
|
|
1623
|
+
#
|
|
1624
|
+
# @!attribute [rw] kms_key_id
|
|
1625
|
+
# If `StorageEncrypted` is `true`, the AWS KMS key identifier for the
|
|
1626
|
+
# encrypted DB instance.
|
|
1627
|
+
# @return [String]
|
|
1628
|
+
#
|
|
1629
|
+
# @!attribute [rw] dbi_resource_id
|
|
1630
|
+
# The AWS Region-unique, immutable identifier for the DB instance.
|
|
1631
|
+
# This identifier is found in AWS CloudTrail log entries whenever the
|
|
1632
|
+
# AWS KMS key for the DB instance is accessed.
|
|
1633
|
+
# @return [String]
|
|
1634
|
+
#
|
|
1635
|
+
# @!attribute [rw] promotion_tier
|
|
1636
|
+
# A value that specifies the order in which an Amazon DocumentDB
|
|
1637
|
+
# replica is promoted to the primary instance after a failure of the
|
|
1638
|
+
# existing primary instance.
|
|
1639
|
+
# @return [Integer]
|
|
1640
|
+
#
|
|
1641
|
+
# @!attribute [rw] db_instance_arn
|
|
1642
|
+
# The Amazon Resource Name (ARN) for the DB instance.
|
|
1643
|
+
# @return [String]
|
|
1644
|
+
#
|
|
1645
|
+
# @!attribute [rw] enabled_cloudwatch_logs_exports
|
|
1646
|
+
# A list of log types that this DB instance is configured to export to
|
|
1647
|
+
# Amazon CloudWatch Logs.
|
|
1648
|
+
# @return [Array<String>]
|
|
1649
|
+
#
|
|
1650
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstance AWS API Documentation
|
|
1651
|
+
#
|
|
1652
|
+
class DBInstance < Struct.new(
|
|
1653
|
+
:db_instance_identifier,
|
|
1654
|
+
:db_instance_class,
|
|
1655
|
+
:engine,
|
|
1656
|
+
:db_instance_status,
|
|
1657
|
+
:endpoint,
|
|
1658
|
+
:instance_create_time,
|
|
1659
|
+
:preferred_backup_window,
|
|
1660
|
+
:backup_retention_period,
|
|
1661
|
+
:vpc_security_groups,
|
|
1662
|
+
:availability_zone,
|
|
1663
|
+
:db_subnet_group,
|
|
1664
|
+
:preferred_maintenance_window,
|
|
1665
|
+
:pending_modified_values,
|
|
1666
|
+
:latest_restorable_time,
|
|
1667
|
+
:engine_version,
|
|
1668
|
+
:auto_minor_version_upgrade,
|
|
1669
|
+
:publicly_accessible,
|
|
1670
|
+
:status_infos,
|
|
1671
|
+
:db_cluster_identifier,
|
|
1672
|
+
:storage_encrypted,
|
|
1673
|
+
:kms_key_id,
|
|
1674
|
+
:dbi_resource_id,
|
|
1675
|
+
:promotion_tier,
|
|
1676
|
+
:db_instance_arn,
|
|
1677
|
+
:enabled_cloudwatch_logs_exports)
|
|
1678
|
+
include Aws::Structure
|
|
1679
|
+
end
|
|
1680
|
+
|
|
1681
|
+
# Represents the output of DescribeDBInstances.
|
|
1682
|
+
#
|
|
1683
|
+
# @!attribute [rw] marker
|
|
1684
|
+
# An optional pagination token provided by a previous request. If this
|
|
1685
|
+
# parameter is specified, the response includes only records beyond
|
|
1686
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
1687
|
+
# @return [String]
|
|
1688
|
+
#
|
|
1689
|
+
# @!attribute [rw] db_instances
|
|
1690
|
+
# Detailed information about one or more DB instances.
|
|
1691
|
+
# @return [Array<Types::DBInstance>]
|
|
1692
|
+
#
|
|
1693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstanceMessage AWS API Documentation
|
|
1694
|
+
#
|
|
1695
|
+
class DBInstanceMessage < Struct.new(
|
|
1696
|
+
:marker,
|
|
1697
|
+
:db_instances)
|
|
1698
|
+
include Aws::Structure
|
|
1699
|
+
end
|
|
1700
|
+
|
|
1701
|
+
# Provides a list of status information for a DB instance.
|
|
1702
|
+
#
|
|
1703
|
+
# @!attribute [rw] status_type
|
|
1704
|
+
# This value is currently "`read replication`."
|
|
1705
|
+
# @return [String]
|
|
1706
|
+
#
|
|
1707
|
+
# @!attribute [rw] normal
|
|
1708
|
+
# A Boolean value that is `true` if the instance is operating
|
|
1709
|
+
# normally, or `false` if the instance is in an error state.
|
|
1710
|
+
# @return [Boolean]
|
|
1711
|
+
#
|
|
1712
|
+
# @!attribute [rw] status
|
|
1713
|
+
# Status of the DB instance. For a `StatusType` of read replica, the
|
|
1714
|
+
# values can be `replicating`, error, `stopped`, or `terminated`.
|
|
1715
|
+
# @return [String]
|
|
1716
|
+
#
|
|
1717
|
+
# @!attribute [rw] message
|
|
1718
|
+
# Details of the error if there is an error for the instance. If the
|
|
1719
|
+
# instance is not in an error state, this value is blank.
|
|
1720
|
+
# @return [String]
|
|
1721
|
+
#
|
|
1722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstanceStatusInfo AWS API Documentation
|
|
1723
|
+
#
|
|
1724
|
+
class DBInstanceStatusInfo < Struct.new(
|
|
1725
|
+
:status_type,
|
|
1726
|
+
:normal,
|
|
1727
|
+
:status,
|
|
1728
|
+
:message)
|
|
1729
|
+
include Aws::Structure
|
|
1730
|
+
end
|
|
1731
|
+
|
|
1732
|
+
# Detailed information about a DB subnet group.
|
|
1733
|
+
#
|
|
1734
|
+
# @!attribute [rw] db_subnet_group_name
|
|
1735
|
+
# The name of the DB subnet group.
|
|
1736
|
+
# @return [String]
|
|
1737
|
+
#
|
|
1738
|
+
# @!attribute [rw] db_subnet_group_description
|
|
1739
|
+
# Provides the description of the DB subnet group.
|
|
1740
|
+
# @return [String]
|
|
1741
|
+
#
|
|
1742
|
+
# @!attribute [rw] vpc_id
|
|
1743
|
+
# Provides the virtual private cloud (VPC) ID of the DB subnet group.
|
|
1744
|
+
# @return [String]
|
|
1745
|
+
#
|
|
1746
|
+
# @!attribute [rw] subnet_group_status
|
|
1747
|
+
# Provides the status of the DB subnet group.
|
|
1748
|
+
# @return [String]
|
|
1749
|
+
#
|
|
1750
|
+
# @!attribute [rw] subnets
|
|
1751
|
+
# Detailed information about one or more subnets within a DB subnet
|
|
1752
|
+
# group.
|
|
1753
|
+
# @return [Array<Types::Subnet>]
|
|
1754
|
+
#
|
|
1755
|
+
# @!attribute [rw] db_subnet_group_arn
|
|
1756
|
+
# The Amazon Resource Identifier (ARN) for the DB subnet group.
|
|
1757
|
+
# @return [String]
|
|
1758
|
+
#
|
|
1759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroup AWS API Documentation
|
|
1760
|
+
#
|
|
1761
|
+
class DBSubnetGroup < Struct.new(
|
|
1762
|
+
:db_subnet_group_name,
|
|
1763
|
+
:db_subnet_group_description,
|
|
1764
|
+
:vpc_id,
|
|
1765
|
+
:subnet_group_status,
|
|
1766
|
+
:subnets,
|
|
1767
|
+
:db_subnet_group_arn)
|
|
1768
|
+
include Aws::Structure
|
|
1769
|
+
end
|
|
1770
|
+
|
|
1771
|
+
# Represents the output of DescribeDBSubnetGroups.
|
|
1772
|
+
#
|
|
1773
|
+
# @!attribute [rw] marker
|
|
1774
|
+
# An optional pagination token provided by a previous request. If this
|
|
1775
|
+
# parameter is specified, the response includes only records beyond
|
|
1776
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
1777
|
+
# @return [String]
|
|
1778
|
+
#
|
|
1779
|
+
# @!attribute [rw] db_subnet_groups
|
|
1780
|
+
# Detailed information about one or more DB subnet groups.
|
|
1781
|
+
# @return [Array<Types::DBSubnetGroup>]
|
|
1782
|
+
#
|
|
1783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroupMessage AWS API Documentation
|
|
1784
|
+
#
|
|
1785
|
+
class DBSubnetGroupMessage < Struct.new(
|
|
1786
|
+
:marker,
|
|
1787
|
+
:db_subnet_groups)
|
|
1788
|
+
include Aws::Structure
|
|
1789
|
+
end
|
|
1790
|
+
|
|
1791
|
+
# Represents the input to DeleteDBCluster.
|
|
1792
|
+
#
|
|
1793
|
+
# @note When making an API call, you may pass DeleteDBClusterMessage
|
|
1794
|
+
# data as a hash:
|
|
1795
|
+
#
|
|
1796
|
+
# {
|
|
1797
|
+
# db_cluster_identifier: "String", # required
|
|
1798
|
+
# skip_final_snapshot: false,
|
|
1799
|
+
# final_db_snapshot_identifier: "String",
|
|
1800
|
+
# }
|
|
1801
|
+
#
|
|
1802
|
+
# @!attribute [rw] db_cluster_identifier
|
|
1803
|
+
# The DB cluster identifier for the DB cluster to be deleted. This
|
|
1804
|
+
# parameter isn't case sensitive.
|
|
1805
|
+
#
|
|
1806
|
+
# Constraints:
|
|
1807
|
+
#
|
|
1808
|
+
# * Must match an existing `DBClusterIdentifier`.
|
|
1809
|
+
#
|
|
1810
|
+
# ^
|
|
1811
|
+
# @return [String]
|
|
1812
|
+
#
|
|
1813
|
+
# @!attribute [rw] skip_final_snapshot
|
|
1814
|
+
# Determines whether a final DB cluster snapshot is created before the
|
|
1815
|
+
# DB cluster is deleted. If `true` is specified, no DB cluster
|
|
1816
|
+
# snapshot is created. If `false` is specified, a DB cluster snapshot
|
|
1817
|
+
# is created before the DB cluster is deleted.
|
|
1818
|
+
#
|
|
1819
|
+
# <note markdown="1"> If `SkipFinalSnapshot` is `false`, you must specify a
|
|
1820
|
+
# `FinalDBSnapshotIdentifier` parameter.
|
|
1821
|
+
#
|
|
1822
|
+
# </note>
|
|
1823
|
+
#
|
|
1824
|
+
# Default: `false`
|
|
1825
|
+
# @return [Boolean]
|
|
1826
|
+
#
|
|
1827
|
+
# @!attribute [rw] final_db_snapshot_identifier
|
|
1828
|
+
# The DB cluster snapshot identifier of the new DB cluster snapshot
|
|
1829
|
+
# created when `SkipFinalSnapshot` is set to `false`.
|
|
1830
|
+
#
|
|
1831
|
+
# <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
|
|
1832
|
+
# parameter to `true` results in an error.
|
|
1833
|
+
#
|
|
1834
|
+
# </note>
|
|
1835
|
+
#
|
|
1836
|
+
# Constraints:
|
|
1837
|
+
#
|
|
1838
|
+
# * Must be from 1 to 255 letters, numbers, or hyphens.
|
|
1839
|
+
#
|
|
1840
|
+
# * The first character must be a letter.
|
|
1841
|
+
#
|
|
1842
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
1843
|
+
# @return [String]
|
|
1844
|
+
#
|
|
1845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterMessage AWS API Documentation
|
|
1846
|
+
#
|
|
1847
|
+
class DeleteDBClusterMessage < Struct.new(
|
|
1848
|
+
:db_cluster_identifier,
|
|
1849
|
+
:skip_final_snapshot,
|
|
1850
|
+
:final_db_snapshot_identifier)
|
|
1851
|
+
include Aws::Structure
|
|
1852
|
+
end
|
|
1853
|
+
|
|
1854
|
+
# Represents the input to DeleteDBClusterParameterGroup.
|
|
1855
|
+
#
|
|
1856
|
+
# @note When making an API call, you may pass DeleteDBClusterParameterGroupMessage
|
|
1857
|
+
# data as a hash:
|
|
1858
|
+
#
|
|
1859
|
+
# {
|
|
1860
|
+
# db_cluster_parameter_group_name: "String", # required
|
|
1861
|
+
# }
|
|
1862
|
+
#
|
|
1863
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
1864
|
+
# The name of the DB cluster parameter group.
|
|
1865
|
+
#
|
|
1866
|
+
# Constraints:
|
|
1867
|
+
#
|
|
1868
|
+
# * Must be the name of an existing DB cluster parameter group.
|
|
1869
|
+
#
|
|
1870
|
+
# * You can't delete a default DB cluster parameter group.
|
|
1871
|
+
#
|
|
1872
|
+
# * Cannot be associated with any DB clusters.
|
|
1873
|
+
# @return [String]
|
|
1874
|
+
#
|
|
1875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroupMessage AWS API Documentation
|
|
1876
|
+
#
|
|
1877
|
+
class DeleteDBClusterParameterGroupMessage < Struct.new(
|
|
1878
|
+
:db_cluster_parameter_group_name)
|
|
1879
|
+
include Aws::Structure
|
|
1880
|
+
end
|
|
1881
|
+
|
|
1882
|
+
# @!attribute [rw] db_cluster
|
|
1883
|
+
# Detailed information about a DB cluster.
|
|
1884
|
+
# @return [Types::DBCluster]
|
|
1885
|
+
#
|
|
1886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterResult AWS API Documentation
|
|
1887
|
+
#
|
|
1888
|
+
class DeleteDBClusterResult < Struct.new(
|
|
1889
|
+
:db_cluster)
|
|
1890
|
+
include Aws::Structure
|
|
1891
|
+
end
|
|
1892
|
+
|
|
1893
|
+
# Represents the input to DeleteDBClusterSnapshot.
|
|
1894
|
+
#
|
|
1895
|
+
# @note When making an API call, you may pass DeleteDBClusterSnapshotMessage
|
|
1896
|
+
# data as a hash:
|
|
1897
|
+
#
|
|
1898
|
+
# {
|
|
1899
|
+
# db_cluster_snapshot_identifier: "String", # required
|
|
1900
|
+
# }
|
|
1901
|
+
#
|
|
1902
|
+
# @!attribute [rw] db_cluster_snapshot_identifier
|
|
1903
|
+
# The identifier of the DB cluster snapshot to delete.
|
|
1904
|
+
#
|
|
1905
|
+
# Constraints: Must be the name of an existing DB cluster snapshot in
|
|
1906
|
+
# the `available` state.
|
|
1907
|
+
# @return [String]
|
|
1908
|
+
#
|
|
1909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshotMessage AWS API Documentation
|
|
1910
|
+
#
|
|
1911
|
+
class DeleteDBClusterSnapshotMessage < Struct.new(
|
|
1912
|
+
:db_cluster_snapshot_identifier)
|
|
1913
|
+
include Aws::Structure
|
|
1914
|
+
end
|
|
1915
|
+
|
|
1916
|
+
# @!attribute [rw] db_cluster_snapshot
|
|
1917
|
+
# Detailed information about a DB cluster snapshot.
|
|
1918
|
+
# @return [Types::DBClusterSnapshot]
|
|
1919
|
+
#
|
|
1920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshotResult AWS API Documentation
|
|
1921
|
+
#
|
|
1922
|
+
class DeleteDBClusterSnapshotResult < Struct.new(
|
|
1923
|
+
:db_cluster_snapshot)
|
|
1924
|
+
include Aws::Structure
|
|
1925
|
+
end
|
|
1926
|
+
|
|
1927
|
+
# Represents the input to DeleteDBInstance.
|
|
1928
|
+
#
|
|
1929
|
+
# @note When making an API call, you may pass DeleteDBInstanceMessage
|
|
1930
|
+
# data as a hash:
|
|
1931
|
+
#
|
|
1932
|
+
# {
|
|
1933
|
+
# db_instance_identifier: "String", # required
|
|
1934
|
+
# }
|
|
1935
|
+
#
|
|
1936
|
+
# @!attribute [rw] db_instance_identifier
|
|
1937
|
+
# The DB instance identifier for the DB instance to be deleted. This
|
|
1938
|
+
# parameter isn't case sensitive.
|
|
1939
|
+
#
|
|
1940
|
+
# Constraints:
|
|
1941
|
+
#
|
|
1942
|
+
# * Must match the name of an existing DB instance.
|
|
1943
|
+
#
|
|
1944
|
+
# ^
|
|
1945
|
+
# @return [String]
|
|
1946
|
+
#
|
|
1947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstanceMessage AWS API Documentation
|
|
1948
|
+
#
|
|
1949
|
+
class DeleteDBInstanceMessage < Struct.new(
|
|
1950
|
+
:db_instance_identifier)
|
|
1951
|
+
include Aws::Structure
|
|
1952
|
+
end
|
|
1953
|
+
|
|
1954
|
+
# @!attribute [rw] db_instance
|
|
1955
|
+
# Detailed information about a DB instance.
|
|
1956
|
+
# @return [Types::DBInstance]
|
|
1957
|
+
#
|
|
1958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstanceResult AWS API Documentation
|
|
1959
|
+
#
|
|
1960
|
+
class DeleteDBInstanceResult < Struct.new(
|
|
1961
|
+
:db_instance)
|
|
1962
|
+
include Aws::Structure
|
|
1963
|
+
end
|
|
1964
|
+
|
|
1965
|
+
# Represents the input to DeleteDBSubnetGroup.
|
|
1966
|
+
#
|
|
1967
|
+
# @note When making an API call, you may pass DeleteDBSubnetGroupMessage
|
|
1968
|
+
# data as a hash:
|
|
1969
|
+
#
|
|
1970
|
+
# {
|
|
1971
|
+
# db_subnet_group_name: "String", # required
|
|
1972
|
+
# }
|
|
1973
|
+
#
|
|
1974
|
+
# @!attribute [rw] db_subnet_group_name
|
|
1975
|
+
# The name of the database subnet group to delete.
|
|
1976
|
+
#
|
|
1977
|
+
# <note markdown="1"> You can't delete the default subnet group.
|
|
1978
|
+
#
|
|
1979
|
+
# </note>
|
|
1980
|
+
#
|
|
1981
|
+
# Constraints:
|
|
1982
|
+
#
|
|
1983
|
+
# Must match the name of an existing `DBSubnetGroup`. Must not be
|
|
1984
|
+
# default.
|
|
1985
|
+
#
|
|
1986
|
+
# Example: `mySubnetgroup`
|
|
1987
|
+
# @return [String]
|
|
1988
|
+
#
|
|
1989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBSubnetGroupMessage AWS API Documentation
|
|
1990
|
+
#
|
|
1991
|
+
class DeleteDBSubnetGroupMessage < Struct.new(
|
|
1992
|
+
:db_subnet_group_name)
|
|
1993
|
+
include Aws::Structure
|
|
1994
|
+
end
|
|
1995
|
+
|
|
1996
|
+
# Represents the input to DescribeDBClusterParameterGroups.
|
|
1997
|
+
#
|
|
1998
|
+
# @note When making an API call, you may pass DescribeDBClusterParameterGroupsMessage
|
|
1999
|
+
# data as a hash:
|
|
2000
|
+
#
|
|
2001
|
+
# {
|
|
2002
|
+
# db_cluster_parameter_group_name: "String",
|
|
2003
|
+
# filters: [
|
|
2004
|
+
# {
|
|
2005
|
+
# name: "String", # required
|
|
2006
|
+
# values: ["String"], # required
|
|
2007
|
+
# },
|
|
2008
|
+
# ],
|
|
2009
|
+
# max_records: 1,
|
|
2010
|
+
# marker: "String",
|
|
2011
|
+
# }
|
|
2012
|
+
#
|
|
2013
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
2014
|
+
# The name of a specific DB cluster parameter group to return details
|
|
2015
|
+
# for.
|
|
2016
|
+
#
|
|
2017
|
+
# Constraints:
|
|
2018
|
+
#
|
|
2019
|
+
# * If provided, must match the name of an existing
|
|
2020
|
+
# `DBClusterParameterGroup`.
|
|
2021
|
+
#
|
|
2022
|
+
# ^
|
|
2023
|
+
# @return [String]
|
|
2024
|
+
#
|
|
2025
|
+
# @!attribute [rw] filters
|
|
2026
|
+
# This parameter is not currently supported.
|
|
2027
|
+
# @return [Array<Types::Filter>]
|
|
2028
|
+
#
|
|
2029
|
+
# @!attribute [rw] max_records
|
|
2030
|
+
# The maximum number of records to include in the response. If more
|
|
2031
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2032
|
+
# token (marker) is included in the response so that the remaining
|
|
2033
|
+
# results can be retrieved.
|
|
2034
|
+
#
|
|
2035
|
+
# Default: 100
|
|
2036
|
+
#
|
|
2037
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2038
|
+
# @return [Integer]
|
|
2039
|
+
#
|
|
2040
|
+
# @!attribute [rw] marker
|
|
2041
|
+
# An optional pagination token provided by a previous request. If this
|
|
2042
|
+
# parameter is specified, the response includes only records beyond
|
|
2043
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2044
|
+
# @return [String]
|
|
2045
|
+
#
|
|
2046
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameterGroupsMessage AWS API Documentation
|
|
2047
|
+
#
|
|
2048
|
+
class DescribeDBClusterParameterGroupsMessage < Struct.new(
|
|
2049
|
+
:db_cluster_parameter_group_name,
|
|
2050
|
+
:filters,
|
|
2051
|
+
:max_records,
|
|
2052
|
+
:marker)
|
|
2053
|
+
include Aws::Structure
|
|
2054
|
+
end
|
|
2055
|
+
|
|
2056
|
+
# Represents the input to DescribeDBClusterParameters.
|
|
2057
|
+
#
|
|
2058
|
+
# @note When making an API call, you may pass DescribeDBClusterParametersMessage
|
|
2059
|
+
# data as a hash:
|
|
2060
|
+
#
|
|
2061
|
+
# {
|
|
2062
|
+
# db_cluster_parameter_group_name: "String", # required
|
|
2063
|
+
# source: "String",
|
|
2064
|
+
# filters: [
|
|
2065
|
+
# {
|
|
2066
|
+
# name: "String", # required
|
|
2067
|
+
# values: ["String"], # required
|
|
2068
|
+
# },
|
|
2069
|
+
# ],
|
|
2070
|
+
# max_records: 1,
|
|
2071
|
+
# marker: "String",
|
|
2072
|
+
# }
|
|
2073
|
+
#
|
|
2074
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
2075
|
+
# The name of a specific DB cluster parameter group to return
|
|
2076
|
+
# parameter details for.
|
|
2077
|
+
#
|
|
2078
|
+
# Constraints:
|
|
2079
|
+
#
|
|
2080
|
+
# * If provided, must match the name of an existing
|
|
2081
|
+
# `DBClusterParameterGroup`.
|
|
2082
|
+
#
|
|
2083
|
+
# ^
|
|
2084
|
+
# @return [String]
|
|
2085
|
+
#
|
|
2086
|
+
# @!attribute [rw] source
|
|
2087
|
+
# A value that indicates to return only parameters for a specific
|
|
2088
|
+
# source. Parameter sources can be `engine`, `service`, or `customer`.
|
|
2089
|
+
# @return [String]
|
|
2090
|
+
#
|
|
2091
|
+
# @!attribute [rw] filters
|
|
2092
|
+
# This parameter is not currently supported.
|
|
2093
|
+
# @return [Array<Types::Filter>]
|
|
2094
|
+
#
|
|
2095
|
+
# @!attribute [rw] max_records
|
|
2096
|
+
# The maximum number of records to include in the response. If more
|
|
2097
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2098
|
+
# token (marker) is included in the response so that the remaining
|
|
2099
|
+
# results can be retrieved.
|
|
2100
|
+
#
|
|
2101
|
+
# Default: 100
|
|
2102
|
+
#
|
|
2103
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2104
|
+
# @return [Integer]
|
|
2105
|
+
#
|
|
2106
|
+
# @!attribute [rw] marker
|
|
2107
|
+
# An optional pagination token provided by a previous request. If this
|
|
2108
|
+
# parameter is specified, the response includes only records beyond
|
|
2109
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2110
|
+
# @return [String]
|
|
2111
|
+
#
|
|
2112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParametersMessage AWS API Documentation
|
|
2113
|
+
#
|
|
2114
|
+
class DescribeDBClusterParametersMessage < Struct.new(
|
|
2115
|
+
:db_cluster_parameter_group_name,
|
|
2116
|
+
:source,
|
|
2117
|
+
:filters,
|
|
2118
|
+
:max_records,
|
|
2119
|
+
:marker)
|
|
2120
|
+
include Aws::Structure
|
|
2121
|
+
end
|
|
2122
|
+
|
|
2123
|
+
# Represents the input to DescribeDBClusterSnapshotAttributes.
|
|
2124
|
+
#
|
|
2125
|
+
# @note When making an API call, you may pass DescribeDBClusterSnapshotAttributesMessage
|
|
2126
|
+
# data as a hash:
|
|
2127
|
+
#
|
|
2128
|
+
# {
|
|
2129
|
+
# db_cluster_snapshot_identifier: "String", # required
|
|
2130
|
+
# }
|
|
2131
|
+
#
|
|
2132
|
+
# @!attribute [rw] db_cluster_snapshot_identifier
|
|
2133
|
+
# The identifier for the DB cluster snapshot to describe the
|
|
2134
|
+
# attributes for.
|
|
2135
|
+
# @return [String]
|
|
2136
|
+
#
|
|
2137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributesMessage AWS API Documentation
|
|
2138
|
+
#
|
|
2139
|
+
class DescribeDBClusterSnapshotAttributesMessage < Struct.new(
|
|
2140
|
+
:db_cluster_snapshot_identifier)
|
|
2141
|
+
include Aws::Structure
|
|
2142
|
+
end
|
|
2143
|
+
|
|
2144
|
+
# @!attribute [rw] db_cluster_snapshot_attributes_result
|
|
2145
|
+
# Detailed information about the attributes that are associated with a
|
|
2146
|
+
# DB cluster snapshot.
|
|
2147
|
+
# @return [Types::DBClusterSnapshotAttributesResult]
|
|
2148
|
+
#
|
|
2149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributesResult AWS API Documentation
|
|
2150
|
+
#
|
|
2151
|
+
class DescribeDBClusterSnapshotAttributesResult < Struct.new(
|
|
2152
|
+
:db_cluster_snapshot_attributes_result)
|
|
2153
|
+
include Aws::Structure
|
|
2154
|
+
end
|
|
2155
|
+
|
|
2156
|
+
# Represents the input to DescribeDBClusterSnapshots.
|
|
2157
|
+
#
|
|
2158
|
+
# @note When making an API call, you may pass DescribeDBClusterSnapshotsMessage
|
|
2159
|
+
# data as a hash:
|
|
2160
|
+
#
|
|
2161
|
+
# {
|
|
2162
|
+
# db_cluster_identifier: "String",
|
|
2163
|
+
# db_cluster_snapshot_identifier: "String",
|
|
2164
|
+
# snapshot_type: "String",
|
|
2165
|
+
# filters: [
|
|
2166
|
+
# {
|
|
2167
|
+
# name: "String", # required
|
|
2168
|
+
# values: ["String"], # required
|
|
2169
|
+
# },
|
|
2170
|
+
# ],
|
|
2171
|
+
# max_records: 1,
|
|
2172
|
+
# marker: "String",
|
|
2173
|
+
# include_shared: false,
|
|
2174
|
+
# include_public: false,
|
|
2175
|
+
# }
|
|
2176
|
+
#
|
|
2177
|
+
# @!attribute [rw] db_cluster_identifier
|
|
2178
|
+
# The ID of the DB cluster to retrieve the list of DB cluster
|
|
2179
|
+
# snapshots for. This parameter can't be used with the
|
|
2180
|
+
# `DBClusterSnapshotIdentifier` parameter. This parameter is not case
|
|
2181
|
+
# sensitive.
|
|
2182
|
+
#
|
|
2183
|
+
# Constraints:
|
|
2184
|
+
#
|
|
2185
|
+
# * If provided, must match the identifier of an existing `DBCluster`.
|
|
2186
|
+
#
|
|
2187
|
+
# ^
|
|
2188
|
+
# @return [String]
|
|
2189
|
+
#
|
|
2190
|
+
# @!attribute [rw] db_cluster_snapshot_identifier
|
|
2191
|
+
# A specific DB cluster snapshot identifier to describe. This
|
|
2192
|
+
# parameter can't be used with the `DBClusterIdentifier` parameter.
|
|
2193
|
+
# This value is stored as a lowercase string.
|
|
2194
|
+
#
|
|
2195
|
+
# Constraints:
|
|
2196
|
+
#
|
|
2197
|
+
# * If provided, must match the identifier of an existing
|
|
2198
|
+
# `DBClusterSnapshot`.
|
|
2199
|
+
#
|
|
2200
|
+
# * If this identifier is for an automated snapshot, the
|
|
2201
|
+
# `SnapshotType` parameter must also be specified.
|
|
2202
|
+
# @return [String]
|
|
2203
|
+
#
|
|
2204
|
+
# @!attribute [rw] snapshot_type
|
|
2205
|
+
# The type of DB cluster snapshots to be returned. You can specify one
|
|
2206
|
+
# of the following values:
|
|
2207
|
+
#
|
|
2208
|
+
# * `automated` - Return all DB cluster snapshots that Amazon
|
|
2209
|
+
# DocumentDB has automatically created for your AWS account.
|
|
2210
|
+
#
|
|
2211
|
+
# * `manual` - Return all DB cluster snapshots that you have manually
|
|
2212
|
+
# created for your AWS account.
|
|
2213
|
+
#
|
|
2214
|
+
# * `shared` - Return all manual DB cluster snapshots that have been
|
|
2215
|
+
# shared to your AWS account.
|
|
2216
|
+
#
|
|
2217
|
+
# * `public` - Return all DB cluster snapshots that have been marked
|
|
2218
|
+
# as public.
|
|
2219
|
+
#
|
|
2220
|
+
# If you don't specify a `SnapshotType` value, then both automated
|
|
2221
|
+
# and manual DB cluster snapshots are returned. You can include shared
|
|
2222
|
+
# DB cluster snapshots with these results by setting the
|
|
2223
|
+
# `IncludeShared` parameter to `true`. You can include public DB
|
|
2224
|
+
# cluster snapshots with these results by setting the `IncludePublic`
|
|
2225
|
+
# parameter to `true`.
|
|
2226
|
+
#
|
|
2227
|
+
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
|
2228
|
+
# `SnapshotType` values of `manual` or `automated`. The
|
|
2229
|
+
# `IncludePublic` parameter doesn't apply when `SnapshotType` is set
|
|
2230
|
+
# to `shared`. The `IncludeShared` parameter doesn't apply when
|
|
2231
|
+
# `SnapshotType` is set to `public`.
|
|
2232
|
+
# @return [String]
|
|
2233
|
+
#
|
|
2234
|
+
# @!attribute [rw] filters
|
|
2235
|
+
# This parameter is not currently supported.
|
|
2236
|
+
# @return [Array<Types::Filter>]
|
|
2237
|
+
#
|
|
2238
|
+
# @!attribute [rw] max_records
|
|
2239
|
+
# The maximum number of records to include in the response. If more
|
|
2240
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2241
|
+
# token (marker) is included in the response so that the remaining
|
|
2242
|
+
# results can be retrieved.
|
|
2243
|
+
#
|
|
2244
|
+
# Default: 100
|
|
2245
|
+
#
|
|
2246
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2247
|
+
# @return [Integer]
|
|
2248
|
+
#
|
|
2249
|
+
# @!attribute [rw] marker
|
|
2250
|
+
# An optional pagination token provided by a previous request. If this
|
|
2251
|
+
# parameter is specified, the response includes only records beyond
|
|
2252
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2253
|
+
# @return [String]
|
|
2254
|
+
#
|
|
2255
|
+
# @!attribute [rw] include_shared
|
|
2256
|
+
# Set to `true` to include shared manual DB cluster snapshots from
|
|
2257
|
+
# other AWS accounts that this AWS account has been given permission
|
|
2258
|
+
# to copy or restore, and otherwise `false`. The default is `false`.
|
|
2259
|
+
# @return [Boolean]
|
|
2260
|
+
#
|
|
2261
|
+
# @!attribute [rw] include_public
|
|
2262
|
+
# Set to `true` to include manual DB cluster snapshots that are public
|
|
2263
|
+
# and can be copied or restored by any AWS account, and otherwise
|
|
2264
|
+
# `false`. The default is `false`.
|
|
2265
|
+
# @return [Boolean]
|
|
2266
|
+
#
|
|
2267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage AWS API Documentation
|
|
2268
|
+
#
|
|
2269
|
+
class DescribeDBClusterSnapshotsMessage < Struct.new(
|
|
2270
|
+
:db_cluster_identifier,
|
|
2271
|
+
:db_cluster_snapshot_identifier,
|
|
2272
|
+
:snapshot_type,
|
|
2273
|
+
:filters,
|
|
2274
|
+
:max_records,
|
|
2275
|
+
:marker,
|
|
2276
|
+
:include_shared,
|
|
2277
|
+
:include_public)
|
|
2278
|
+
include Aws::Structure
|
|
2279
|
+
end
|
|
2280
|
+
|
|
2281
|
+
# Represents the input to DescribeDBClusters.
|
|
2282
|
+
#
|
|
2283
|
+
# @note When making an API call, you may pass DescribeDBClustersMessage
|
|
2284
|
+
# data as a hash:
|
|
2285
|
+
#
|
|
2286
|
+
# {
|
|
2287
|
+
# db_cluster_identifier: "String",
|
|
2288
|
+
# filters: [
|
|
2289
|
+
# {
|
|
2290
|
+
# name: "String", # required
|
|
2291
|
+
# values: ["String"], # required
|
|
2292
|
+
# },
|
|
2293
|
+
# ],
|
|
2294
|
+
# max_records: 1,
|
|
2295
|
+
# marker: "String",
|
|
2296
|
+
# }
|
|
2297
|
+
#
|
|
2298
|
+
# @!attribute [rw] db_cluster_identifier
|
|
2299
|
+
# The user-provided DB cluster identifier. If this parameter is
|
|
2300
|
+
# specified, information from only the specific DB cluster is
|
|
2301
|
+
# returned. This parameter isn't case sensitive.
|
|
2302
|
+
#
|
|
2303
|
+
# Constraints:
|
|
2304
|
+
#
|
|
2305
|
+
# * If provided, must match an existing `DBClusterIdentifier`.
|
|
2306
|
+
#
|
|
2307
|
+
# ^
|
|
2308
|
+
# @return [String]
|
|
2309
|
+
#
|
|
2310
|
+
# @!attribute [rw] filters
|
|
2311
|
+
# A filter that specifies one or more DB clusters to describe.
|
|
2312
|
+
#
|
|
2313
|
+
# Supported filters:
|
|
2314
|
+
#
|
|
2315
|
+
# * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
|
|
2316
|
+
# Amazon Resource Names (ARNs). The results list only includes
|
|
2317
|
+
# information about the DB clusters identified by these ARNs.
|
|
2318
|
+
#
|
|
2319
|
+
# ^
|
|
2320
|
+
# @return [Array<Types::Filter>]
|
|
2321
|
+
#
|
|
2322
|
+
# @!attribute [rw] max_records
|
|
2323
|
+
# The maximum number of records to include in the response. If more
|
|
2324
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2325
|
+
# token (marker) is included in the response so that the remaining
|
|
2326
|
+
# results can be retrieved.
|
|
2327
|
+
#
|
|
2328
|
+
# Default: 100
|
|
2329
|
+
#
|
|
2330
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2331
|
+
# @return [Integer]
|
|
2332
|
+
#
|
|
2333
|
+
# @!attribute [rw] marker
|
|
2334
|
+
# An optional pagination token provided by a previous request. If this
|
|
2335
|
+
# parameter is specified, the response includes only records beyond
|
|
2336
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2337
|
+
# @return [String]
|
|
2338
|
+
#
|
|
2339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClustersMessage AWS API Documentation
|
|
2340
|
+
#
|
|
2341
|
+
class DescribeDBClustersMessage < Struct.new(
|
|
2342
|
+
:db_cluster_identifier,
|
|
2343
|
+
:filters,
|
|
2344
|
+
:max_records,
|
|
2345
|
+
:marker)
|
|
2346
|
+
include Aws::Structure
|
|
2347
|
+
end
|
|
2348
|
+
|
|
2349
|
+
# Represents the input to DescribeDBEngineVersions.
|
|
2350
|
+
#
|
|
2351
|
+
# @note When making an API call, you may pass DescribeDBEngineVersionsMessage
|
|
2352
|
+
# data as a hash:
|
|
2353
|
+
#
|
|
2354
|
+
# {
|
|
2355
|
+
# engine: "String",
|
|
2356
|
+
# engine_version: "String",
|
|
2357
|
+
# db_parameter_group_family: "String",
|
|
2358
|
+
# filters: [
|
|
2359
|
+
# {
|
|
2360
|
+
# name: "String", # required
|
|
2361
|
+
# values: ["String"], # required
|
|
2362
|
+
# },
|
|
2363
|
+
# ],
|
|
2364
|
+
# max_records: 1,
|
|
2365
|
+
# marker: "String",
|
|
2366
|
+
# default_only: false,
|
|
2367
|
+
# list_supported_character_sets: false,
|
|
2368
|
+
# list_supported_timezones: false,
|
|
2369
|
+
# }
|
|
2370
|
+
#
|
|
2371
|
+
# @!attribute [rw] engine
|
|
2372
|
+
# The database engine to return.
|
|
2373
|
+
# @return [String]
|
|
2374
|
+
#
|
|
2375
|
+
# @!attribute [rw] engine_version
|
|
2376
|
+
# The database engine version to return.
|
|
2377
|
+
#
|
|
2378
|
+
# Example: `5.1.49`
|
|
2379
|
+
# @return [String]
|
|
2380
|
+
#
|
|
2381
|
+
# @!attribute [rw] db_parameter_group_family
|
|
2382
|
+
# The name of a specific DB parameter group family to return details
|
|
2383
|
+
# for.
|
|
2384
|
+
#
|
|
2385
|
+
# Constraints:
|
|
2386
|
+
#
|
|
2387
|
+
# * If provided, must match an existing `DBParameterGroupFamily`.
|
|
2388
|
+
#
|
|
2389
|
+
# ^
|
|
2390
|
+
# @return [String]
|
|
2391
|
+
#
|
|
2392
|
+
# @!attribute [rw] filters
|
|
2393
|
+
# This parameter is not currently supported.
|
|
2394
|
+
# @return [Array<Types::Filter>]
|
|
2395
|
+
#
|
|
2396
|
+
# @!attribute [rw] max_records
|
|
2397
|
+
# The maximum number of records to include in the response. If more
|
|
2398
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2399
|
+
# token (marker) is included in the response so that the remaining
|
|
2400
|
+
# results can be retrieved.
|
|
2401
|
+
#
|
|
2402
|
+
# Default: 100
|
|
2403
|
+
#
|
|
2404
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2405
|
+
# @return [Integer]
|
|
2406
|
+
#
|
|
2407
|
+
# @!attribute [rw] marker
|
|
2408
|
+
# An optional pagination token provided by a previous request. If this
|
|
2409
|
+
# parameter is specified, the response includes only records beyond
|
|
2410
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2411
|
+
# @return [String]
|
|
2412
|
+
#
|
|
2413
|
+
# @!attribute [rw] default_only
|
|
2414
|
+
# Indicates that only the default version of the specified engine or
|
|
2415
|
+
# engine and major version combination is returned.
|
|
2416
|
+
# @return [Boolean]
|
|
2417
|
+
#
|
|
2418
|
+
# @!attribute [rw] list_supported_character_sets
|
|
2419
|
+
# If this parameter is specified and the requested engine supports the
|
|
2420
|
+
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
|
2421
|
+
# includes a list of supported character sets for each engine version.
|
|
2422
|
+
# @return [Boolean]
|
|
2423
|
+
#
|
|
2424
|
+
# @!attribute [rw] list_supported_timezones
|
|
2425
|
+
# If this parameter is specified and the requested engine supports the
|
|
2426
|
+
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
|
2427
|
+
# list of supported time zones for each engine version.
|
|
2428
|
+
# @return [Boolean]
|
|
2429
|
+
#
|
|
2430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBEngineVersionsMessage AWS API Documentation
|
|
2431
|
+
#
|
|
2432
|
+
class DescribeDBEngineVersionsMessage < Struct.new(
|
|
2433
|
+
:engine,
|
|
2434
|
+
:engine_version,
|
|
2435
|
+
:db_parameter_group_family,
|
|
2436
|
+
:filters,
|
|
2437
|
+
:max_records,
|
|
2438
|
+
:marker,
|
|
2439
|
+
:default_only,
|
|
2440
|
+
:list_supported_character_sets,
|
|
2441
|
+
:list_supported_timezones)
|
|
2442
|
+
include Aws::Structure
|
|
2443
|
+
end
|
|
2444
|
+
|
|
2445
|
+
# Represents the input to DescribeDBInstances.
|
|
2446
|
+
#
|
|
2447
|
+
# @note When making an API call, you may pass DescribeDBInstancesMessage
|
|
2448
|
+
# data as a hash:
|
|
2449
|
+
#
|
|
2450
|
+
# {
|
|
2451
|
+
# db_instance_identifier: "String",
|
|
2452
|
+
# filters: [
|
|
2453
|
+
# {
|
|
2454
|
+
# name: "String", # required
|
|
2455
|
+
# values: ["String"], # required
|
|
2456
|
+
# },
|
|
2457
|
+
# ],
|
|
2458
|
+
# max_records: 1,
|
|
2459
|
+
# marker: "String",
|
|
2460
|
+
# }
|
|
2461
|
+
#
|
|
2462
|
+
# @!attribute [rw] db_instance_identifier
|
|
2463
|
+
# The user-provided instance identifier. If this parameter is
|
|
2464
|
+
# specified, information from only the specific DB instance is
|
|
2465
|
+
# returned. This parameter isn't case sensitive.
|
|
2466
|
+
#
|
|
2467
|
+
# Constraints:
|
|
2468
|
+
#
|
|
2469
|
+
# * If provided, must match the identifier of an existing
|
|
2470
|
+
# `DBInstance`.
|
|
2471
|
+
#
|
|
2472
|
+
# ^
|
|
2473
|
+
# @return [String]
|
|
2474
|
+
#
|
|
2475
|
+
# @!attribute [rw] filters
|
|
2476
|
+
# A filter that specifies one or more DB instances to describe.
|
|
2477
|
+
#
|
|
2478
|
+
# Supported filters:
|
|
2479
|
+
#
|
|
2480
|
+
# * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
|
|
2481
|
+
# Amazon Resource Names (ARNs). The results list includes only the
|
|
2482
|
+
# information about the DB instances that are associated with the DB
|
|
2483
|
+
# clusters that are identified by these ARNs.
|
|
2484
|
+
#
|
|
2485
|
+
# * `db-instance-id` - Accepts DB instance identifiers and DB instance
|
|
2486
|
+
# ARNs. The results list includes only the information about the DB
|
|
2487
|
+
# instances that are identified by these ARNs.
|
|
2488
|
+
# @return [Array<Types::Filter>]
|
|
2489
|
+
#
|
|
2490
|
+
# @!attribute [rw] max_records
|
|
2491
|
+
# The maximum number of records to include in the response. If more
|
|
2492
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2493
|
+
# token (marker) is included in the response so that the remaining
|
|
2494
|
+
# results can be retrieved.
|
|
2495
|
+
#
|
|
2496
|
+
# Default: 100
|
|
2497
|
+
#
|
|
2498
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2499
|
+
# @return [Integer]
|
|
2500
|
+
#
|
|
2501
|
+
# @!attribute [rw] marker
|
|
2502
|
+
# An optional pagination token provided by a previous request. If this
|
|
2503
|
+
# parameter is specified, the response includes only records beyond
|
|
2504
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2505
|
+
# @return [String]
|
|
2506
|
+
#
|
|
2507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstancesMessage AWS API Documentation
|
|
2508
|
+
#
|
|
2509
|
+
class DescribeDBInstancesMessage < Struct.new(
|
|
2510
|
+
:db_instance_identifier,
|
|
2511
|
+
:filters,
|
|
2512
|
+
:max_records,
|
|
2513
|
+
:marker)
|
|
2514
|
+
include Aws::Structure
|
|
2515
|
+
end
|
|
2516
|
+
|
|
2517
|
+
# Represents the input to DescribeDBSubnetGroups.
|
|
2518
|
+
#
|
|
2519
|
+
# @note When making an API call, you may pass DescribeDBSubnetGroupsMessage
|
|
2520
|
+
# data as a hash:
|
|
2521
|
+
#
|
|
2522
|
+
# {
|
|
2523
|
+
# db_subnet_group_name: "String",
|
|
2524
|
+
# filters: [
|
|
2525
|
+
# {
|
|
2526
|
+
# name: "String", # required
|
|
2527
|
+
# values: ["String"], # required
|
|
2528
|
+
# },
|
|
2529
|
+
# ],
|
|
2530
|
+
# max_records: 1,
|
|
2531
|
+
# marker: "String",
|
|
2532
|
+
# }
|
|
2533
|
+
#
|
|
2534
|
+
# @!attribute [rw] db_subnet_group_name
|
|
2535
|
+
# The name of the DB subnet group to return details for.
|
|
2536
|
+
# @return [String]
|
|
2537
|
+
#
|
|
2538
|
+
# @!attribute [rw] filters
|
|
2539
|
+
# This parameter is not currently supported.
|
|
2540
|
+
# @return [Array<Types::Filter>]
|
|
2541
|
+
#
|
|
2542
|
+
# @!attribute [rw] max_records
|
|
2543
|
+
# The maximum number of records to include in the response. If more
|
|
2544
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2545
|
+
# token (marker) is included in the response so that the remaining
|
|
2546
|
+
# results can be retrieved.
|
|
2547
|
+
#
|
|
2548
|
+
# Default: 100
|
|
2549
|
+
#
|
|
2550
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2551
|
+
# @return [Integer]
|
|
2552
|
+
#
|
|
2553
|
+
# @!attribute [rw] marker
|
|
2554
|
+
# An optional pagination token provided by a previous request. If this
|
|
2555
|
+
# parameter is specified, the response includes only records beyond
|
|
2556
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2557
|
+
# @return [String]
|
|
2558
|
+
#
|
|
2559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBSubnetGroupsMessage AWS API Documentation
|
|
2560
|
+
#
|
|
2561
|
+
class DescribeDBSubnetGroupsMessage < Struct.new(
|
|
2562
|
+
:db_subnet_group_name,
|
|
2563
|
+
:filters,
|
|
2564
|
+
:max_records,
|
|
2565
|
+
:marker)
|
|
2566
|
+
include Aws::Structure
|
|
2567
|
+
end
|
|
2568
|
+
|
|
2569
|
+
# Represents the input to DescribeEngineDefaultClusterParameters.
|
|
2570
|
+
#
|
|
2571
|
+
# @note When making an API call, you may pass DescribeEngineDefaultClusterParametersMessage
|
|
2572
|
+
# data as a hash:
|
|
2573
|
+
#
|
|
2574
|
+
# {
|
|
2575
|
+
# db_parameter_group_family: "String", # required
|
|
2576
|
+
# filters: [
|
|
2577
|
+
# {
|
|
2578
|
+
# name: "String", # required
|
|
2579
|
+
# values: ["String"], # required
|
|
2580
|
+
# },
|
|
2581
|
+
# ],
|
|
2582
|
+
# max_records: 1,
|
|
2583
|
+
# marker: "String",
|
|
2584
|
+
# }
|
|
2585
|
+
#
|
|
2586
|
+
# @!attribute [rw] db_parameter_group_family
|
|
2587
|
+
# The name of the DB cluster parameter group family to return the
|
|
2588
|
+
# engine parameter information for.
|
|
2589
|
+
# @return [String]
|
|
2590
|
+
#
|
|
2591
|
+
# @!attribute [rw] filters
|
|
2592
|
+
# This parameter is not currently supported.
|
|
2593
|
+
# @return [Array<Types::Filter>]
|
|
2594
|
+
#
|
|
2595
|
+
# @!attribute [rw] max_records
|
|
2596
|
+
# The maximum number of records to include in the response. If more
|
|
2597
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2598
|
+
# token (marker) is included in the response so that the remaining
|
|
2599
|
+
# results can be retrieved.
|
|
2600
|
+
#
|
|
2601
|
+
# Default: 100
|
|
2602
|
+
#
|
|
2603
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2604
|
+
# @return [Integer]
|
|
2605
|
+
#
|
|
2606
|
+
# @!attribute [rw] marker
|
|
2607
|
+
# An optional pagination token provided by a previous request. If this
|
|
2608
|
+
# parameter is specified, the response includes only records beyond
|
|
2609
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2610
|
+
# @return [String]
|
|
2611
|
+
#
|
|
2612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParametersMessage AWS API Documentation
|
|
2613
|
+
#
|
|
2614
|
+
class DescribeEngineDefaultClusterParametersMessage < Struct.new(
|
|
2615
|
+
:db_parameter_group_family,
|
|
2616
|
+
:filters,
|
|
2617
|
+
:max_records,
|
|
2618
|
+
:marker)
|
|
2619
|
+
include Aws::Structure
|
|
2620
|
+
end
|
|
2621
|
+
|
|
2622
|
+
# @!attribute [rw] engine_defaults
|
|
2623
|
+
# Contains the result of a successful invocation of the
|
|
2624
|
+
# `DescribeEngineDefaultClusterParameters` operation.
|
|
2625
|
+
# @return [Types::EngineDefaults]
|
|
2626
|
+
#
|
|
2627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParametersResult AWS API Documentation
|
|
2628
|
+
#
|
|
2629
|
+
class DescribeEngineDefaultClusterParametersResult < Struct.new(
|
|
2630
|
+
:engine_defaults)
|
|
2631
|
+
include Aws::Structure
|
|
2632
|
+
end
|
|
2633
|
+
|
|
2634
|
+
# Represents the input to DescribeEventCategories.
|
|
2635
|
+
#
|
|
2636
|
+
# @note When making an API call, you may pass DescribeEventCategoriesMessage
|
|
2637
|
+
# data as a hash:
|
|
2638
|
+
#
|
|
2639
|
+
# {
|
|
2640
|
+
# source_type: "String",
|
|
2641
|
+
# filters: [
|
|
2642
|
+
# {
|
|
2643
|
+
# name: "String", # required
|
|
2644
|
+
# values: ["String"], # required
|
|
2645
|
+
# },
|
|
2646
|
+
# ],
|
|
2647
|
+
# }
|
|
2648
|
+
#
|
|
2649
|
+
# @!attribute [rw] source_type
|
|
2650
|
+
# The type of source that is generating the events.
|
|
2651
|
+
#
|
|
2652
|
+
# Valid values: `db-instance`, `db-parameter-group`,
|
|
2653
|
+
# `db-security-group`, `db-snapshot`
|
|
2654
|
+
# @return [String]
|
|
2655
|
+
#
|
|
2656
|
+
# @!attribute [rw] filters
|
|
2657
|
+
# This parameter is not currently supported.
|
|
2658
|
+
# @return [Array<Types::Filter>]
|
|
2659
|
+
#
|
|
2660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventCategoriesMessage AWS API Documentation
|
|
2661
|
+
#
|
|
2662
|
+
class DescribeEventCategoriesMessage < Struct.new(
|
|
2663
|
+
:source_type,
|
|
2664
|
+
:filters)
|
|
2665
|
+
include Aws::Structure
|
|
2666
|
+
end
|
|
2667
|
+
|
|
2668
|
+
# Represents the input to DescribeEvents.
|
|
2669
|
+
#
|
|
2670
|
+
# @note When making an API call, you may pass DescribeEventsMessage
|
|
2671
|
+
# data as a hash:
|
|
2672
|
+
#
|
|
2673
|
+
# {
|
|
2674
|
+
# source_identifier: "String",
|
|
2675
|
+
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
|
|
2676
|
+
# start_time: Time.now,
|
|
2677
|
+
# end_time: Time.now,
|
|
2678
|
+
# duration: 1,
|
|
2679
|
+
# event_categories: ["String"],
|
|
2680
|
+
# filters: [
|
|
2681
|
+
# {
|
|
2682
|
+
# name: "String", # required
|
|
2683
|
+
# values: ["String"], # required
|
|
2684
|
+
# },
|
|
2685
|
+
# ],
|
|
2686
|
+
# max_records: 1,
|
|
2687
|
+
# marker: "String",
|
|
2688
|
+
# }
|
|
2689
|
+
#
|
|
2690
|
+
# @!attribute [rw] source_identifier
|
|
2691
|
+
# The identifier of the event source for which events are returned. If
|
|
2692
|
+
# not specified, then all sources are included in the response.
|
|
2693
|
+
#
|
|
2694
|
+
# Constraints:
|
|
2695
|
+
#
|
|
2696
|
+
# * If `SourceIdentifier` is provided, `SourceType` must also be
|
|
2697
|
+
# provided.
|
|
2698
|
+
#
|
|
2699
|
+
# * If the source type is `DBInstance`, a `DBInstanceIdentifier` must
|
|
2700
|
+
# be provided.
|
|
2701
|
+
#
|
|
2702
|
+
# * If the source type is `DBSecurityGroup`, a `DBSecurityGroupName`
|
|
2703
|
+
# must be provided.
|
|
2704
|
+
#
|
|
2705
|
+
# * If the source type is `DBParameterGroup`, a `DBParameterGroupName`
|
|
2706
|
+
# must be provided.
|
|
2707
|
+
#
|
|
2708
|
+
# * If the source type is `DBSnapshot`, a `DBSnapshotIdentifier` must
|
|
2709
|
+
# be provided.
|
|
2710
|
+
#
|
|
2711
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
2712
|
+
# @return [String]
|
|
2713
|
+
#
|
|
2714
|
+
# @!attribute [rw] source_type
|
|
2715
|
+
# The event source to retrieve events for. If no value is specified,
|
|
2716
|
+
# all events are returned.
|
|
2717
|
+
# @return [String]
|
|
2718
|
+
#
|
|
2719
|
+
# @!attribute [rw] start_time
|
|
2720
|
+
# The beginning of the time interval to retrieve events for, specified
|
|
2721
|
+
# in ISO 8601 format.
|
|
2722
|
+
#
|
|
2723
|
+
# Example: 2009-07-08T18:00Z
|
|
2724
|
+
# @return [Time]
|
|
2725
|
+
#
|
|
2726
|
+
# @!attribute [rw] end_time
|
|
2727
|
+
# The end of the time interval for which to retrieve events, specified
|
|
2728
|
+
# in ISO 8601 format.
|
|
2729
|
+
#
|
|
2730
|
+
# Example: 2009-07-08T18:00Z
|
|
2731
|
+
# @return [Time]
|
|
2732
|
+
#
|
|
2733
|
+
# @!attribute [rw] duration
|
|
2734
|
+
# The number of minutes to retrieve events for.
|
|
2735
|
+
#
|
|
2736
|
+
# Default: 60
|
|
2737
|
+
# @return [Integer]
|
|
2738
|
+
#
|
|
2739
|
+
# @!attribute [rw] event_categories
|
|
2740
|
+
# A list of event categories that trigger notifications for an event
|
|
2741
|
+
# notification subscription.
|
|
2742
|
+
# @return [Array<String>]
|
|
2743
|
+
#
|
|
2744
|
+
# @!attribute [rw] filters
|
|
2745
|
+
# This parameter is not currently supported.
|
|
2746
|
+
# @return [Array<Types::Filter>]
|
|
2747
|
+
#
|
|
2748
|
+
# @!attribute [rw] max_records
|
|
2749
|
+
# The maximum number of records to include in the response. If more
|
|
2750
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2751
|
+
# token (marker) is included in the response so that the remaining
|
|
2752
|
+
# results can be retrieved.
|
|
2753
|
+
#
|
|
2754
|
+
# Default: 100
|
|
2755
|
+
#
|
|
2756
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2757
|
+
# @return [Integer]
|
|
2758
|
+
#
|
|
2759
|
+
# @!attribute [rw] marker
|
|
2760
|
+
# An optional pagination token provided by a previous request. If this
|
|
2761
|
+
# parameter is specified, the response includes only records beyond
|
|
2762
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2763
|
+
# @return [String]
|
|
2764
|
+
#
|
|
2765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventsMessage AWS API Documentation
|
|
2766
|
+
#
|
|
2767
|
+
class DescribeEventsMessage < Struct.new(
|
|
2768
|
+
:source_identifier,
|
|
2769
|
+
:source_type,
|
|
2770
|
+
:start_time,
|
|
2771
|
+
:end_time,
|
|
2772
|
+
:duration,
|
|
2773
|
+
:event_categories,
|
|
2774
|
+
:filters,
|
|
2775
|
+
:max_records,
|
|
2776
|
+
:marker)
|
|
2777
|
+
include Aws::Structure
|
|
2778
|
+
end
|
|
2779
|
+
|
|
2780
|
+
# Represents the input to DescribeOrderableDBInstanceOptions.
|
|
2781
|
+
#
|
|
2782
|
+
# @note When making an API call, you may pass DescribeOrderableDBInstanceOptionsMessage
|
|
2783
|
+
# data as a hash:
|
|
2784
|
+
#
|
|
2785
|
+
# {
|
|
2786
|
+
# engine: "String", # required
|
|
2787
|
+
# engine_version: "String",
|
|
2788
|
+
# db_instance_class: "String",
|
|
2789
|
+
# license_model: "String",
|
|
2790
|
+
# vpc: false,
|
|
2791
|
+
# filters: [
|
|
2792
|
+
# {
|
|
2793
|
+
# name: "String", # required
|
|
2794
|
+
# values: ["String"], # required
|
|
2795
|
+
# },
|
|
2796
|
+
# ],
|
|
2797
|
+
# max_records: 1,
|
|
2798
|
+
# marker: "String",
|
|
2799
|
+
# }
|
|
2800
|
+
#
|
|
2801
|
+
# @!attribute [rw] engine
|
|
2802
|
+
# The name of the engine to retrieve DB instance options for.
|
|
2803
|
+
# @return [String]
|
|
2804
|
+
#
|
|
2805
|
+
# @!attribute [rw] engine_version
|
|
2806
|
+
# The engine version filter value. Specify this parameter to show only
|
|
2807
|
+
# the available offerings that match the specified engine version.
|
|
2808
|
+
# @return [String]
|
|
2809
|
+
#
|
|
2810
|
+
# @!attribute [rw] db_instance_class
|
|
2811
|
+
# The DB instance class filter value. Specify this parameter to show
|
|
2812
|
+
# only the available offerings that match the specified DB instance
|
|
2813
|
+
# class.
|
|
2814
|
+
# @return [String]
|
|
2815
|
+
#
|
|
2816
|
+
# @!attribute [rw] license_model
|
|
2817
|
+
# The license model filter value. Specify this parameter to show only
|
|
2818
|
+
# the available offerings that match the specified license model.
|
|
2819
|
+
# @return [String]
|
|
2820
|
+
#
|
|
2821
|
+
# @!attribute [rw] vpc
|
|
2822
|
+
# The virtual private cloud (VPC) filter value. Specify this parameter
|
|
2823
|
+
# to show only the available VPC or non-VPC offerings.
|
|
2824
|
+
# @return [Boolean]
|
|
2825
|
+
#
|
|
2826
|
+
# @!attribute [rw] filters
|
|
2827
|
+
# This parameter is not currently supported.
|
|
2828
|
+
# @return [Array<Types::Filter>]
|
|
2829
|
+
#
|
|
2830
|
+
# @!attribute [rw] max_records
|
|
2831
|
+
# The maximum number of records to include in the response. If more
|
|
2832
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2833
|
+
# token (marker) is included in the response so that the remaining
|
|
2834
|
+
# results can be retrieved.
|
|
2835
|
+
#
|
|
2836
|
+
# Default: 100
|
|
2837
|
+
#
|
|
2838
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2839
|
+
# @return [Integer]
|
|
2840
|
+
#
|
|
2841
|
+
# @!attribute [rw] marker
|
|
2842
|
+
# An optional pagination token provided by a previous request. If this
|
|
2843
|
+
# parameter is specified, the response includes only records beyond
|
|
2844
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2845
|
+
# @return [String]
|
|
2846
|
+
#
|
|
2847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeOrderableDBInstanceOptionsMessage AWS API Documentation
|
|
2848
|
+
#
|
|
2849
|
+
class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
|
|
2850
|
+
:engine,
|
|
2851
|
+
:engine_version,
|
|
2852
|
+
:db_instance_class,
|
|
2853
|
+
:license_model,
|
|
2854
|
+
:vpc,
|
|
2855
|
+
:filters,
|
|
2856
|
+
:max_records,
|
|
2857
|
+
:marker)
|
|
2858
|
+
include Aws::Structure
|
|
2859
|
+
end
|
|
2860
|
+
|
|
2861
|
+
# Represents the input to DescribePendingMaintenanceActions.
|
|
2862
|
+
#
|
|
2863
|
+
# @note When making an API call, you may pass DescribePendingMaintenanceActionsMessage
|
|
2864
|
+
# data as a hash:
|
|
2865
|
+
#
|
|
2866
|
+
# {
|
|
2867
|
+
# resource_identifier: "String",
|
|
2868
|
+
# filters: [
|
|
2869
|
+
# {
|
|
2870
|
+
# name: "String", # required
|
|
2871
|
+
# values: ["String"], # required
|
|
2872
|
+
# },
|
|
2873
|
+
# ],
|
|
2874
|
+
# marker: "String",
|
|
2875
|
+
# max_records: 1,
|
|
2876
|
+
# }
|
|
2877
|
+
#
|
|
2878
|
+
# @!attribute [rw] resource_identifier
|
|
2879
|
+
# The ARN of a resource to return pending maintenance actions for.
|
|
2880
|
+
# @return [String]
|
|
2881
|
+
#
|
|
2882
|
+
# @!attribute [rw] filters
|
|
2883
|
+
# A filter that specifies one or more resources to return pending
|
|
2884
|
+
# maintenance actions for.
|
|
2885
|
+
#
|
|
2886
|
+
# Supported filters:
|
|
2887
|
+
#
|
|
2888
|
+
# * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
|
|
2889
|
+
# Amazon Resource Names (ARNs). The results list includes only
|
|
2890
|
+
# pending maintenance actions for the DB clusters identified by
|
|
2891
|
+
# these ARNs.
|
|
2892
|
+
#
|
|
2893
|
+
# * `db-instance-id` - Accepts DB instance identifiers and DB instance
|
|
2894
|
+
# ARNs. The results list includes only pending maintenance actions
|
|
2895
|
+
# for the DB instances identified by these ARNs.
|
|
2896
|
+
# @return [Array<Types::Filter>]
|
|
2897
|
+
#
|
|
2898
|
+
# @!attribute [rw] marker
|
|
2899
|
+
# An optional pagination token provided by a previous request. If this
|
|
2900
|
+
# parameter is specified, the response includes only records beyond
|
|
2901
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2902
|
+
# @return [String]
|
|
2903
|
+
#
|
|
2904
|
+
# @!attribute [rw] max_records
|
|
2905
|
+
# The maximum number of records to include in the response. If more
|
|
2906
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
|
2907
|
+
# token (marker) is included in the response so that the remaining
|
|
2908
|
+
# results can be retrieved.
|
|
2909
|
+
#
|
|
2910
|
+
# Default: 100
|
|
2911
|
+
#
|
|
2912
|
+
# Constraints: Minimum 20, maximum 100.
|
|
2913
|
+
# @return [Integer]
|
|
2914
|
+
#
|
|
2915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribePendingMaintenanceActionsMessage AWS API Documentation
|
|
2916
|
+
#
|
|
2917
|
+
class DescribePendingMaintenanceActionsMessage < Struct.new(
|
|
2918
|
+
:resource_identifier,
|
|
2919
|
+
:filters,
|
|
2920
|
+
:marker,
|
|
2921
|
+
:max_records)
|
|
2922
|
+
include Aws::Structure
|
|
2923
|
+
end
|
|
2924
|
+
|
|
2925
|
+
# Network information for accessing a DB cluster or DB instance. Client
|
|
2926
|
+
# programs must specify a valid endpoint to access these Amazon
|
|
2927
|
+
# DocumentDB resources.
|
|
2928
|
+
#
|
|
2929
|
+
# @!attribute [rw] address
|
|
2930
|
+
# Specifies the DNS address of the DB instance.
|
|
2931
|
+
# @return [String]
|
|
2932
|
+
#
|
|
2933
|
+
# @!attribute [rw] port
|
|
2934
|
+
# Specifies the port that the database engine is listening on.
|
|
2935
|
+
# @return [Integer]
|
|
2936
|
+
#
|
|
2937
|
+
# @!attribute [rw] hosted_zone_id
|
|
2938
|
+
# Specifies the ID that Amazon Route 53 assigns when you create a
|
|
2939
|
+
# hosted zone.
|
|
2940
|
+
# @return [String]
|
|
2941
|
+
#
|
|
2942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Endpoint AWS API Documentation
|
|
2943
|
+
#
|
|
2944
|
+
class Endpoint < Struct.new(
|
|
2945
|
+
:address,
|
|
2946
|
+
:port,
|
|
2947
|
+
:hosted_zone_id)
|
|
2948
|
+
include Aws::Structure
|
|
2949
|
+
end
|
|
2950
|
+
|
|
2951
|
+
# Contains the result of a successful invocation of the
|
|
2952
|
+
# `DescribeEngineDefaultClusterParameters` operation.
|
|
2953
|
+
#
|
|
2954
|
+
# @!attribute [rw] db_parameter_group_family
|
|
2955
|
+
# The name of the DB cluster parameter group family to return the
|
|
2956
|
+
# engine parameter information for.
|
|
2957
|
+
# @return [String]
|
|
2958
|
+
#
|
|
2959
|
+
# @!attribute [rw] marker
|
|
2960
|
+
# An optional pagination token provided by a previous request. If this
|
|
2961
|
+
# parameter is specified, the response includes only records beyond
|
|
2962
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
2963
|
+
# @return [String]
|
|
2964
|
+
#
|
|
2965
|
+
# @!attribute [rw] parameters
|
|
2966
|
+
# The parameters of a particular DB cluster parameter group family.
|
|
2967
|
+
# @return [Array<Types::Parameter>]
|
|
2968
|
+
#
|
|
2969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EngineDefaults AWS API Documentation
|
|
2970
|
+
#
|
|
2971
|
+
class EngineDefaults < Struct.new(
|
|
2972
|
+
:db_parameter_group_family,
|
|
2973
|
+
:marker,
|
|
2974
|
+
:parameters)
|
|
2975
|
+
include Aws::Structure
|
|
2976
|
+
end
|
|
2977
|
+
|
|
2978
|
+
# Detailed information about an event.
|
|
2979
|
+
#
|
|
2980
|
+
# @!attribute [rw] source_identifier
|
|
2981
|
+
# Provides the identifier for the source of the event.
|
|
2982
|
+
# @return [String]
|
|
2983
|
+
#
|
|
2984
|
+
# @!attribute [rw] source_type
|
|
2985
|
+
# Specifies the source type for this event.
|
|
2986
|
+
# @return [String]
|
|
2987
|
+
#
|
|
2988
|
+
# @!attribute [rw] message
|
|
2989
|
+
# Provides the text of this event.
|
|
2990
|
+
# @return [String]
|
|
2991
|
+
#
|
|
2992
|
+
# @!attribute [rw] event_categories
|
|
2993
|
+
# Specifies the category for the event.
|
|
2994
|
+
# @return [Array<String>]
|
|
2995
|
+
#
|
|
2996
|
+
# @!attribute [rw] date
|
|
2997
|
+
# Specifies the date and time of the event.
|
|
2998
|
+
# @return [Time]
|
|
2999
|
+
#
|
|
3000
|
+
# @!attribute [rw] source_arn
|
|
3001
|
+
# The Amazon Resource Name (ARN) for the event.
|
|
3002
|
+
# @return [String]
|
|
3003
|
+
#
|
|
3004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Event AWS API Documentation
|
|
3005
|
+
#
|
|
3006
|
+
class Event < Struct.new(
|
|
3007
|
+
:source_identifier,
|
|
3008
|
+
:source_type,
|
|
3009
|
+
:message,
|
|
3010
|
+
:event_categories,
|
|
3011
|
+
:date,
|
|
3012
|
+
:source_arn)
|
|
3013
|
+
include Aws::Structure
|
|
3014
|
+
end
|
|
3015
|
+
|
|
3016
|
+
# An event source type, accompanied by one or more event category names.
|
|
3017
|
+
#
|
|
3018
|
+
# @!attribute [rw] source_type
|
|
3019
|
+
# The source type that the returned categories belong to.
|
|
3020
|
+
# @return [String]
|
|
3021
|
+
#
|
|
3022
|
+
# @!attribute [rw] event_categories
|
|
3023
|
+
# The event categories for the specified source type.
|
|
3024
|
+
# @return [Array<String>]
|
|
3025
|
+
#
|
|
3026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventCategoriesMap AWS API Documentation
|
|
3027
|
+
#
|
|
3028
|
+
class EventCategoriesMap < Struct.new(
|
|
3029
|
+
:source_type,
|
|
3030
|
+
:event_categories)
|
|
3031
|
+
include Aws::Structure
|
|
3032
|
+
end
|
|
3033
|
+
|
|
3034
|
+
# Represents the output of DescribeEventCategories.
|
|
3035
|
+
#
|
|
3036
|
+
# @!attribute [rw] event_categories_map_list
|
|
3037
|
+
# A list of event category maps.
|
|
3038
|
+
# @return [Array<Types::EventCategoriesMap>]
|
|
3039
|
+
#
|
|
3040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventCategoriesMessage AWS API Documentation
|
|
3041
|
+
#
|
|
3042
|
+
class EventCategoriesMessage < Struct.new(
|
|
3043
|
+
:event_categories_map_list)
|
|
3044
|
+
include Aws::Structure
|
|
3045
|
+
end
|
|
3046
|
+
|
|
3047
|
+
# Represents the output of DescribeEvents.
|
|
3048
|
+
#
|
|
3049
|
+
# @!attribute [rw] marker
|
|
3050
|
+
# An optional pagination token provided by a previous request. If this
|
|
3051
|
+
# parameter is specified, the response includes only records beyond
|
|
3052
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
3053
|
+
# @return [String]
|
|
3054
|
+
#
|
|
3055
|
+
# @!attribute [rw] events
|
|
3056
|
+
# Detailed information about one or more events.
|
|
3057
|
+
# @return [Array<Types::Event>]
|
|
3058
|
+
#
|
|
3059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventsMessage AWS API Documentation
|
|
3060
|
+
#
|
|
3061
|
+
class EventsMessage < Struct.new(
|
|
3062
|
+
:marker,
|
|
3063
|
+
:events)
|
|
3064
|
+
include Aws::Structure
|
|
3065
|
+
end
|
|
3066
|
+
|
|
3067
|
+
# Represents the input to FailoverDBCluster.
|
|
3068
|
+
#
|
|
3069
|
+
# @note When making an API call, you may pass FailoverDBClusterMessage
|
|
3070
|
+
# data as a hash:
|
|
3071
|
+
#
|
|
3072
|
+
# {
|
|
3073
|
+
# db_cluster_identifier: "String",
|
|
3074
|
+
# target_db_instance_identifier: "String",
|
|
3075
|
+
# }
|
|
3076
|
+
#
|
|
3077
|
+
# @!attribute [rw] db_cluster_identifier
|
|
3078
|
+
# A DB cluster identifier to force a failover for. This parameter is
|
|
3079
|
+
# not case sensitive.
|
|
3080
|
+
#
|
|
3081
|
+
# Constraints:
|
|
3082
|
+
#
|
|
3083
|
+
# * Must match the identifier of an existing `DBCluster`.
|
|
3084
|
+
#
|
|
3085
|
+
# ^
|
|
3086
|
+
# @return [String]
|
|
3087
|
+
#
|
|
3088
|
+
# @!attribute [rw] target_db_instance_identifier
|
|
3089
|
+
# The name of the instance to promote to the primary instance.
|
|
3090
|
+
#
|
|
3091
|
+
# You must specify the instance identifier for an Amazon DocumentDB
|
|
3092
|
+
# replica in the DB cluster. For example, `mydbcluster-replica1`.
|
|
3093
|
+
# @return [String]
|
|
3094
|
+
#
|
|
3095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBClusterMessage AWS API Documentation
|
|
3096
|
+
#
|
|
3097
|
+
class FailoverDBClusterMessage < Struct.new(
|
|
3098
|
+
:db_cluster_identifier,
|
|
3099
|
+
:target_db_instance_identifier)
|
|
3100
|
+
include Aws::Structure
|
|
3101
|
+
end
|
|
3102
|
+
|
|
3103
|
+
# @!attribute [rw] db_cluster
|
|
3104
|
+
# Detailed information about a DB cluster.
|
|
3105
|
+
# @return [Types::DBCluster]
|
|
3106
|
+
#
|
|
3107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBClusterResult AWS API Documentation
|
|
3108
|
+
#
|
|
3109
|
+
class FailoverDBClusterResult < Struct.new(
|
|
3110
|
+
:db_cluster)
|
|
3111
|
+
include Aws::Structure
|
|
3112
|
+
end
|
|
3113
|
+
|
|
3114
|
+
# A named set of filter values, used to return a more specific list of
|
|
3115
|
+
# results. You can use a filter to match a set of resources by specific
|
|
3116
|
+
# criteria, such as IDs.
|
|
3117
|
+
#
|
|
3118
|
+
# Wildcards are not supported in filters.
|
|
3119
|
+
#
|
|
3120
|
+
# @note When making an API call, you may pass Filter
|
|
3121
|
+
# data as a hash:
|
|
3122
|
+
#
|
|
3123
|
+
# {
|
|
3124
|
+
# name: "String", # required
|
|
3125
|
+
# values: ["String"], # required
|
|
3126
|
+
# }
|
|
3127
|
+
#
|
|
3128
|
+
# @!attribute [rw] name
|
|
3129
|
+
# The name of the filter. Filter names are case sensitive.
|
|
3130
|
+
# @return [String]
|
|
3131
|
+
#
|
|
3132
|
+
# @!attribute [rw] values
|
|
3133
|
+
# One or more filter values. Filter values are case sensitive.
|
|
3134
|
+
# @return [Array<String>]
|
|
3135
|
+
#
|
|
3136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Filter AWS API Documentation
|
|
3137
|
+
#
|
|
3138
|
+
class Filter < Struct.new(
|
|
3139
|
+
:name,
|
|
3140
|
+
:values)
|
|
3141
|
+
include Aws::Structure
|
|
3142
|
+
end
|
|
3143
|
+
|
|
3144
|
+
# Represents the input to ListTagsForResource.
|
|
3145
|
+
#
|
|
3146
|
+
# @note When making an API call, you may pass ListTagsForResourceMessage
|
|
3147
|
+
# data as a hash:
|
|
3148
|
+
#
|
|
3149
|
+
# {
|
|
3150
|
+
# resource_name: "String", # required
|
|
3151
|
+
# filters: [
|
|
3152
|
+
# {
|
|
3153
|
+
# name: "String", # required
|
|
3154
|
+
# values: ["String"], # required
|
|
3155
|
+
# },
|
|
3156
|
+
# ],
|
|
3157
|
+
# }
|
|
3158
|
+
#
|
|
3159
|
+
# @!attribute [rw] resource_name
|
|
3160
|
+
# The Amazon DocumentDB resource with tags to be listed. This value is
|
|
3161
|
+
# an Amazon Resource Name (ARN).
|
|
3162
|
+
# @return [String]
|
|
3163
|
+
#
|
|
3164
|
+
# @!attribute [rw] filters
|
|
3165
|
+
# This parameter is not currently supported.
|
|
3166
|
+
# @return [Array<Types::Filter>]
|
|
3167
|
+
#
|
|
3168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ListTagsForResourceMessage AWS API Documentation
|
|
3169
|
+
#
|
|
3170
|
+
class ListTagsForResourceMessage < Struct.new(
|
|
3171
|
+
:resource_name,
|
|
3172
|
+
:filters)
|
|
3173
|
+
include Aws::Structure
|
|
3174
|
+
end
|
|
3175
|
+
|
|
3176
|
+
# Represents the input to ModifyDBCluster.
|
|
3177
|
+
#
|
|
3178
|
+
# @note When making an API call, you may pass ModifyDBClusterMessage
|
|
3179
|
+
# data as a hash:
|
|
3180
|
+
#
|
|
3181
|
+
# {
|
|
3182
|
+
# db_cluster_identifier: "String", # required
|
|
3183
|
+
# new_db_cluster_identifier: "String",
|
|
3184
|
+
# apply_immediately: false,
|
|
3185
|
+
# backup_retention_period: 1,
|
|
3186
|
+
# db_cluster_parameter_group_name: "String",
|
|
3187
|
+
# vpc_security_group_ids: ["String"],
|
|
3188
|
+
# port: 1,
|
|
3189
|
+
# master_user_password: "String",
|
|
3190
|
+
# preferred_backup_window: "String",
|
|
3191
|
+
# preferred_maintenance_window: "String",
|
|
3192
|
+
# cloudwatch_logs_export_configuration: {
|
|
3193
|
+
# enable_log_types: ["String"],
|
|
3194
|
+
# disable_log_types: ["String"],
|
|
3195
|
+
# },
|
|
3196
|
+
# engine_version: "String",
|
|
3197
|
+
# }
|
|
3198
|
+
#
|
|
3199
|
+
# @!attribute [rw] db_cluster_identifier
|
|
3200
|
+
# The DB cluster identifier for the cluster that is being modified.
|
|
3201
|
+
# This parameter is not case sensitive.
|
|
3202
|
+
#
|
|
3203
|
+
# Constraints:
|
|
3204
|
+
#
|
|
3205
|
+
# * Must match the identifier of an existing `DBCluster`.
|
|
3206
|
+
#
|
|
3207
|
+
# ^
|
|
3208
|
+
# @return [String]
|
|
3209
|
+
#
|
|
3210
|
+
# @!attribute [rw] new_db_cluster_identifier
|
|
3211
|
+
# The new DB cluster identifier for the DB cluster when renaming a DB
|
|
3212
|
+
# cluster. This value is stored as a lowercase string.
|
|
3213
|
+
#
|
|
3214
|
+
# Constraints:
|
|
3215
|
+
#
|
|
3216
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
3217
|
+
#
|
|
3218
|
+
# * The first character must be a letter.
|
|
3219
|
+
#
|
|
3220
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
3221
|
+
#
|
|
3222
|
+
# Example: `my-cluster2`
|
|
3223
|
+
# @return [String]
|
|
3224
|
+
#
|
|
3225
|
+
# @!attribute [rw] apply_immediately
|
|
3226
|
+
# A value that specifies whether the changes in this request and any
|
|
3227
|
+
# pending changes are asynchronously applied as soon as possible,
|
|
3228
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
|
3229
|
+
# cluster. If this parameter is set to `false`, changes to the DB
|
|
3230
|
+
# cluster are applied during the next maintenance window.
|
|
3231
|
+
#
|
|
3232
|
+
# The `ApplyImmediately` parameter affects only the
|
|
3233
|
+
# `NewDBClusterIdentifier` and `MasterUserPassword` values. If you set
|
|
3234
|
+
# this parameter value to `false`, the changes to the
|
|
3235
|
+
# `NewDBClusterIdentifier` and `MasterUserPassword` values are applied
|
|
3236
|
+
# during the next maintenance window. All other changes are applied
|
|
3237
|
+
# immediately, regardless of the value of the `ApplyImmediately`
|
|
3238
|
+
# parameter.
|
|
3239
|
+
#
|
|
3240
|
+
# Default: `false`
|
|
3241
|
+
# @return [Boolean]
|
|
3242
|
+
#
|
|
3243
|
+
# @!attribute [rw] backup_retention_period
|
|
3244
|
+
# The number of days for which automated backups are retained. You
|
|
3245
|
+
# must specify a minimum value of 1.
|
|
3246
|
+
#
|
|
3247
|
+
# Default: 1
|
|
3248
|
+
#
|
|
3249
|
+
# Constraints:
|
|
3250
|
+
#
|
|
3251
|
+
# * Must be a value from 1 to 35.
|
|
3252
|
+
#
|
|
3253
|
+
# ^
|
|
3254
|
+
# @return [Integer]
|
|
3255
|
+
#
|
|
3256
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
3257
|
+
# The name of the DB cluster parameter group to use for the DB
|
|
3258
|
+
# cluster.
|
|
3259
|
+
# @return [String]
|
|
3260
|
+
#
|
|
3261
|
+
# @!attribute [rw] vpc_security_group_ids
|
|
3262
|
+
# A list of virtual private cloud (VPC) security groups that the DB
|
|
3263
|
+
# cluster will belong to.
|
|
3264
|
+
# @return [Array<String>]
|
|
3265
|
+
#
|
|
3266
|
+
# @!attribute [rw] port
|
|
3267
|
+
# The port number on which the DB cluster accepts connections.
|
|
3268
|
+
#
|
|
3269
|
+
# Constraints: Must be a value from `1150` to `65535`.
|
|
3270
|
+
#
|
|
3271
|
+
# Default: The same port as the original DB cluster.
|
|
3272
|
+
# @return [Integer]
|
|
3273
|
+
#
|
|
3274
|
+
# @!attribute [rw] master_user_password
|
|
3275
|
+
# The new password for the master database user. This password can
|
|
3276
|
+
# contain any printable ASCII character except "`/`", "`"`", or
|
|
3277
|
+
# "`@`".
|
|
3278
|
+
#
|
|
3279
|
+
# Constraints: Must contain from 8 to 41 characters.
|
|
3280
|
+
# @return [String]
|
|
3281
|
+
#
|
|
3282
|
+
# @!attribute [rw] preferred_backup_window
|
|
3283
|
+
# The daily time range during which automated backups are created if
|
|
3284
|
+
# automated backups are enabled, using the `BackupRetentionPeriod`
|
|
3285
|
+
# parameter.
|
|
3286
|
+
#
|
|
3287
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
|
3288
|
+
# block of time for each AWS Region.
|
|
3289
|
+
#
|
|
3290
|
+
# Constraints:
|
|
3291
|
+
#
|
|
3292
|
+
# * Must be in the format `hh24:mi-hh24:mi`.
|
|
3293
|
+
#
|
|
3294
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
3295
|
+
#
|
|
3296
|
+
# * Must not conflict with the preferred maintenance window.
|
|
3297
|
+
#
|
|
3298
|
+
# * Must be at least 30 minutes.
|
|
3299
|
+
# @return [String]
|
|
3300
|
+
#
|
|
3301
|
+
# @!attribute [rw] preferred_maintenance_window
|
|
3302
|
+
# The weekly time range during which system maintenance can occur, in
|
|
3303
|
+
# Universal Coordinated Time (UTC).
|
|
3304
|
+
#
|
|
3305
|
+
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
|
3306
|
+
#
|
|
3307
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
|
3308
|
+
# block of time for each AWS Region, occurring on a random day of the
|
|
3309
|
+
# week.
|
|
3310
|
+
#
|
|
3311
|
+
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
|
3312
|
+
#
|
|
3313
|
+
# Constraints: Minimum 30-minute window.
|
|
3314
|
+
# @return [String]
|
|
3315
|
+
#
|
|
3316
|
+
# @!attribute [rw] cloudwatch_logs_export_configuration
|
|
3317
|
+
# The configuration setting for the log types to be enabled for export
|
|
3318
|
+
# to Amazon CloudWatch Logs for a specific DB instance or DB cluster.
|
|
3319
|
+
# The `EnableLogTypes` and `DisableLogTypes` arrays determine which
|
|
3320
|
+
# logs are exported (or not exported) to CloudWatch Logs.
|
|
3321
|
+
# @return [Types::CloudwatchLogsExportConfiguration]
|
|
3322
|
+
#
|
|
3323
|
+
# @!attribute [rw] engine_version
|
|
3324
|
+
# The version number of the database engine to which you want to
|
|
3325
|
+
# upgrade. Changing this parameter results in an outage. The change is
|
|
3326
|
+
# applied during the next maintenance window unless the
|
|
3327
|
+
# `ApplyImmediately` parameter is set to `true`.
|
|
3328
|
+
# @return [String]
|
|
3329
|
+
#
|
|
3330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterMessage AWS API Documentation
|
|
3331
|
+
#
|
|
3332
|
+
class ModifyDBClusterMessage < Struct.new(
|
|
3333
|
+
:db_cluster_identifier,
|
|
3334
|
+
:new_db_cluster_identifier,
|
|
3335
|
+
:apply_immediately,
|
|
3336
|
+
:backup_retention_period,
|
|
3337
|
+
:db_cluster_parameter_group_name,
|
|
3338
|
+
:vpc_security_group_ids,
|
|
3339
|
+
:port,
|
|
3340
|
+
:master_user_password,
|
|
3341
|
+
:preferred_backup_window,
|
|
3342
|
+
:preferred_maintenance_window,
|
|
3343
|
+
:cloudwatch_logs_export_configuration,
|
|
3344
|
+
:engine_version)
|
|
3345
|
+
include Aws::Structure
|
|
3346
|
+
end
|
|
3347
|
+
|
|
3348
|
+
# Represents the input to ModifyDBClusterParameterGroup.
|
|
3349
|
+
#
|
|
3350
|
+
# @note When making an API call, you may pass ModifyDBClusterParameterGroupMessage
|
|
3351
|
+
# data as a hash:
|
|
3352
|
+
#
|
|
3353
|
+
# {
|
|
3354
|
+
# db_cluster_parameter_group_name: "String", # required
|
|
3355
|
+
# parameters: [ # required
|
|
3356
|
+
# {
|
|
3357
|
+
# parameter_name: "String",
|
|
3358
|
+
# parameter_value: "String",
|
|
3359
|
+
# description: "String",
|
|
3360
|
+
# source: "String",
|
|
3361
|
+
# apply_type: "String",
|
|
3362
|
+
# data_type: "String",
|
|
3363
|
+
# allowed_values: "String",
|
|
3364
|
+
# is_modifiable: false,
|
|
3365
|
+
# minimum_engine_version: "String",
|
|
3366
|
+
# apply_method: "immediate", # accepts immediate, pending-reboot
|
|
3367
|
+
# },
|
|
3368
|
+
# ],
|
|
3369
|
+
# }
|
|
3370
|
+
#
|
|
3371
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
3372
|
+
# The name of the DB cluster parameter group to modify.
|
|
3373
|
+
# @return [String]
|
|
3374
|
+
#
|
|
3375
|
+
# @!attribute [rw] parameters
|
|
3376
|
+
# A list of parameters in the DB cluster parameter group to modify.
|
|
3377
|
+
# @return [Array<Types::Parameter>]
|
|
3378
|
+
#
|
|
3379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterParameterGroupMessage AWS API Documentation
|
|
3380
|
+
#
|
|
3381
|
+
class ModifyDBClusterParameterGroupMessage < Struct.new(
|
|
3382
|
+
:db_cluster_parameter_group_name,
|
|
3383
|
+
:parameters)
|
|
3384
|
+
include Aws::Structure
|
|
3385
|
+
end
|
|
3386
|
+
|
|
3387
|
+
# @!attribute [rw] db_cluster
|
|
3388
|
+
# Detailed information about a DB cluster.
|
|
3389
|
+
# @return [Types::DBCluster]
|
|
3390
|
+
#
|
|
3391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterResult AWS API Documentation
|
|
3392
|
+
#
|
|
3393
|
+
class ModifyDBClusterResult < Struct.new(
|
|
3394
|
+
:db_cluster)
|
|
3395
|
+
include Aws::Structure
|
|
3396
|
+
end
|
|
3397
|
+
|
|
3398
|
+
# Represents the input to ModifyDBClusterSnapshotAttribute.
|
|
3399
|
+
#
|
|
3400
|
+
# @note When making an API call, you may pass ModifyDBClusterSnapshotAttributeMessage
|
|
3401
|
+
# data as a hash:
|
|
3402
|
+
#
|
|
3403
|
+
# {
|
|
3404
|
+
# db_cluster_snapshot_identifier: "String", # required
|
|
3405
|
+
# attribute_name: "String", # required
|
|
3406
|
+
# values_to_add: ["String"],
|
|
3407
|
+
# values_to_remove: ["String"],
|
|
3408
|
+
# }
|
|
3409
|
+
#
|
|
3410
|
+
# @!attribute [rw] db_cluster_snapshot_identifier
|
|
3411
|
+
# The identifier for the DB cluster snapshot to modify the attributes
|
|
3412
|
+
# for.
|
|
3413
|
+
# @return [String]
|
|
3414
|
+
#
|
|
3415
|
+
# @!attribute [rw] attribute_name
|
|
3416
|
+
# The name of the DB cluster snapshot attribute to modify.
|
|
3417
|
+
#
|
|
3418
|
+
# To manage authorization for other AWS accounts to copy or restore a
|
|
3419
|
+
# manual DB cluster snapshot, set this value to `restore`.
|
|
3420
|
+
# @return [String]
|
|
3421
|
+
#
|
|
3422
|
+
# @!attribute [rw] values_to_add
|
|
3423
|
+
# A list of DB cluster snapshot attributes to add to the attribute
|
|
3424
|
+
# specified by `AttributeName`.
|
|
3425
|
+
#
|
|
3426
|
+
# To authorize other AWS accounts to copy or restore a manual DB
|
|
3427
|
+
# cluster snapshot, set this list to include one or more AWS account
|
|
3428
|
+
# IDs. To make the manual DB cluster snapshot restorable by any AWS
|
|
3429
|
+
# account, set it to `all`. Do not add the `all` value for any manual
|
|
3430
|
+
# DB cluster snapshots that contain private information that you
|
|
3431
|
+
# don't want to be available to all AWS accounts.
|
|
3432
|
+
# @return [Array<String>]
|
|
3433
|
+
#
|
|
3434
|
+
# @!attribute [rw] values_to_remove
|
|
3435
|
+
# A list of DB cluster snapshot attributes to remove from the
|
|
3436
|
+
# attribute specified by `AttributeName`.
|
|
3437
|
+
#
|
|
3438
|
+
# To remove authorization for other AWS accounts to copy or restore a
|
|
3439
|
+
# manual DB cluster snapshot, set this list to include one or more AWS
|
|
3440
|
+
# account identifiers. To remove authorization for any AWS account to
|
|
3441
|
+
# copy or restore the DB cluster snapshot, set it to `all` . If you
|
|
3442
|
+
# specify `all`, an AWS account whose account ID is explicitly added
|
|
3443
|
+
# to the `restore` attribute can still copy or restore a manual DB
|
|
3444
|
+
# cluster snapshot.
|
|
3445
|
+
# @return [Array<String>]
|
|
3446
|
+
#
|
|
3447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttributeMessage AWS API Documentation
|
|
3448
|
+
#
|
|
3449
|
+
class ModifyDBClusterSnapshotAttributeMessage < Struct.new(
|
|
3450
|
+
:db_cluster_snapshot_identifier,
|
|
3451
|
+
:attribute_name,
|
|
3452
|
+
:values_to_add,
|
|
3453
|
+
:values_to_remove)
|
|
3454
|
+
include Aws::Structure
|
|
3455
|
+
end
|
|
3456
|
+
|
|
3457
|
+
# @!attribute [rw] db_cluster_snapshot_attributes_result
|
|
3458
|
+
# Detailed information about the attributes that are associated with a
|
|
3459
|
+
# DB cluster snapshot.
|
|
3460
|
+
# @return [Types::DBClusterSnapshotAttributesResult]
|
|
3461
|
+
#
|
|
3462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttributeResult AWS API Documentation
|
|
3463
|
+
#
|
|
3464
|
+
class ModifyDBClusterSnapshotAttributeResult < Struct.new(
|
|
3465
|
+
:db_cluster_snapshot_attributes_result)
|
|
3466
|
+
include Aws::Structure
|
|
3467
|
+
end
|
|
3468
|
+
|
|
3469
|
+
# Represents the input to ModifyDBInstance.
|
|
3470
|
+
#
|
|
3471
|
+
# @note When making an API call, you may pass ModifyDBInstanceMessage
|
|
3472
|
+
# data as a hash:
|
|
3473
|
+
#
|
|
3474
|
+
# {
|
|
3475
|
+
# db_instance_identifier: "String", # required
|
|
3476
|
+
# db_instance_class: "String",
|
|
3477
|
+
# apply_immediately: false,
|
|
3478
|
+
# preferred_maintenance_window: "String",
|
|
3479
|
+
# auto_minor_version_upgrade: false,
|
|
3480
|
+
# new_db_instance_identifier: "String",
|
|
3481
|
+
# promotion_tier: 1,
|
|
3482
|
+
# }
|
|
3483
|
+
#
|
|
3484
|
+
# @!attribute [rw] db_instance_identifier
|
|
3485
|
+
# The DB instance identifier. This value is stored as a lowercase
|
|
3486
|
+
# string.
|
|
3487
|
+
#
|
|
3488
|
+
# Constraints:
|
|
3489
|
+
#
|
|
3490
|
+
# * Must match the identifier of an existing `DBInstance`.
|
|
3491
|
+
#
|
|
3492
|
+
# ^
|
|
3493
|
+
# @return [String]
|
|
3494
|
+
#
|
|
3495
|
+
# @!attribute [rw] db_instance_class
|
|
3496
|
+
# The new compute and memory capacity of the DB instance; for example,
|
|
3497
|
+
# `db.m4.large`. Not all DB instance classes are available in all AWS
|
|
3498
|
+
# Regions.
|
|
3499
|
+
#
|
|
3500
|
+
# If you modify the DB instance class, an outage occurs during the
|
|
3501
|
+
# change. The change is applied during the next maintenance window,
|
|
3502
|
+
# unless `ApplyImmediately` is specified as `true` for this request.
|
|
3503
|
+
#
|
|
3504
|
+
# Default: Uses existing setting.
|
|
3505
|
+
# @return [String]
|
|
3506
|
+
#
|
|
3507
|
+
# @!attribute [rw] apply_immediately
|
|
3508
|
+
# Specifies whether the modifications in this request and any pending
|
|
3509
|
+
# modifications are asynchronously applied as soon as possible,
|
|
3510
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
|
3511
|
+
# instance.
|
|
3512
|
+
#
|
|
3513
|
+
# If this parameter is set to `false`, changes to the DB instance are
|
|
3514
|
+
# applied during the next maintenance window. Some parameter changes
|
|
3515
|
+
# can cause an outage and are applied on the next reboot.
|
|
3516
|
+
#
|
|
3517
|
+
# Default: `false`
|
|
3518
|
+
# @return [Boolean]
|
|
3519
|
+
#
|
|
3520
|
+
# @!attribute [rw] preferred_maintenance_window
|
|
3521
|
+
# The weekly time range (in UTC) during which system maintenance can
|
|
3522
|
+
# occur, which might result in an outage. Changing this parameter
|
|
3523
|
+
# doesn't result in an outage except in the following situation, and
|
|
3524
|
+
# the change is asynchronously applied as soon as possible. If there
|
|
3525
|
+
# are pending actions that cause a reboot, and the maintenance window
|
|
3526
|
+
# is changed to include the current time, changing this parameter
|
|
3527
|
+
# causes a reboot of the DB instance. If you are moving this window to
|
|
3528
|
+
# the current time, there must be at least 30 minutes between the
|
|
3529
|
+
# current time and end of the window to ensure that pending changes
|
|
3530
|
+
# are applied.
|
|
3531
|
+
#
|
|
3532
|
+
# Default: Uses existing setting.
|
|
3533
|
+
#
|
|
3534
|
+
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
|
3535
|
+
#
|
|
3536
|
+
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
|
3537
|
+
#
|
|
3538
|
+
# Constraints: Must be at least 30 minutes.
|
|
3539
|
+
# @return [String]
|
|
3540
|
+
#
|
|
3541
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
|
3542
|
+
# Indicates that minor version upgrades are applied automatically to
|
|
3543
|
+
# the DB instance during the maintenance window. Changing this
|
|
3544
|
+
# parameter doesn't result in an outage except in the following case,
|
|
3545
|
+
# and the change is asynchronously applied as soon as possible. An
|
|
3546
|
+
# outage results if this parameter is set to `true` during the
|
|
3547
|
+
# maintenance window, and a newer minor version is available, and
|
|
3548
|
+
# Amazon DocumentDB has enabled automatic patching for that engine
|
|
3549
|
+
# version.
|
|
3550
|
+
# @return [Boolean]
|
|
3551
|
+
#
|
|
3552
|
+
# @!attribute [rw] new_db_instance_identifier
|
|
3553
|
+
# The new DB instance identifier for the DB instance when renaming a
|
|
3554
|
+
# DB instance. When you change the DB instance identifier, an instance
|
|
3555
|
+
# reboot occurs immediately if you set `Apply Immediately` to `true`.
|
|
3556
|
+
# It occurs during the next maintenance window if you set `Apply
|
|
3557
|
+
# Immediately` to `false`. This value is stored as a lowercase string.
|
|
3558
|
+
#
|
|
3559
|
+
# Constraints:
|
|
3560
|
+
#
|
|
3561
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
3562
|
+
#
|
|
3563
|
+
# * The first character must be a letter.
|
|
3564
|
+
#
|
|
3565
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
3566
|
+
#
|
|
3567
|
+
# Example: `mydbinstance`
|
|
3568
|
+
# @return [String]
|
|
3569
|
+
#
|
|
3570
|
+
# @!attribute [rw] promotion_tier
|
|
3571
|
+
# A value that specifies the order in which an Amazon DocumentDB
|
|
3572
|
+
# replica is promoted to the primary instance after a failure of the
|
|
3573
|
+
# existing primary instance.
|
|
3574
|
+
#
|
|
3575
|
+
# Default: 1
|
|
3576
|
+
#
|
|
3577
|
+
# Valid values: 0-15
|
|
3578
|
+
# @return [Integer]
|
|
3579
|
+
#
|
|
3580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
|
3581
|
+
#
|
|
3582
|
+
class ModifyDBInstanceMessage < Struct.new(
|
|
3583
|
+
:db_instance_identifier,
|
|
3584
|
+
:db_instance_class,
|
|
3585
|
+
:apply_immediately,
|
|
3586
|
+
:preferred_maintenance_window,
|
|
3587
|
+
:auto_minor_version_upgrade,
|
|
3588
|
+
:new_db_instance_identifier,
|
|
3589
|
+
:promotion_tier)
|
|
3590
|
+
include Aws::Structure
|
|
3591
|
+
end
|
|
3592
|
+
|
|
3593
|
+
# @!attribute [rw] db_instance
|
|
3594
|
+
# Detailed information about a DB instance.
|
|
3595
|
+
# @return [Types::DBInstance]
|
|
3596
|
+
#
|
|
3597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceResult AWS API Documentation
|
|
3598
|
+
#
|
|
3599
|
+
class ModifyDBInstanceResult < Struct.new(
|
|
3600
|
+
:db_instance)
|
|
3601
|
+
include Aws::Structure
|
|
3602
|
+
end
|
|
3603
|
+
|
|
3604
|
+
# Represents the input to ModifyDBSubnetGroup.
|
|
3605
|
+
#
|
|
3606
|
+
# @note When making an API call, you may pass ModifyDBSubnetGroupMessage
|
|
3607
|
+
# data as a hash:
|
|
3608
|
+
#
|
|
3609
|
+
# {
|
|
3610
|
+
# db_subnet_group_name: "String", # required
|
|
3611
|
+
# db_subnet_group_description: "String",
|
|
3612
|
+
# subnet_ids: ["String"], # required
|
|
3613
|
+
# }
|
|
3614
|
+
#
|
|
3615
|
+
# @!attribute [rw] db_subnet_group_name
|
|
3616
|
+
# The name for the DB subnet group. This value is stored as a
|
|
3617
|
+
# lowercase string. You can't modify the default subnet group.
|
|
3618
|
+
#
|
|
3619
|
+
# Constraints: Must match the name of an existing `DBSubnetGroup`.
|
|
3620
|
+
# Must not be default.
|
|
3621
|
+
#
|
|
3622
|
+
# Example: `mySubnetgroup`
|
|
3623
|
+
# @return [String]
|
|
3624
|
+
#
|
|
3625
|
+
# @!attribute [rw] db_subnet_group_description
|
|
3626
|
+
# The description for the DB subnet group.
|
|
3627
|
+
# @return [String]
|
|
3628
|
+
#
|
|
3629
|
+
# @!attribute [rw] subnet_ids
|
|
3630
|
+
# The Amazon EC2 subnet IDs for the DB subnet group.
|
|
3631
|
+
# @return [Array<String>]
|
|
3632
|
+
#
|
|
3633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroupMessage AWS API Documentation
|
|
3634
|
+
#
|
|
3635
|
+
class ModifyDBSubnetGroupMessage < Struct.new(
|
|
3636
|
+
:db_subnet_group_name,
|
|
3637
|
+
:db_subnet_group_description,
|
|
3638
|
+
:subnet_ids)
|
|
3639
|
+
include Aws::Structure
|
|
3640
|
+
end
|
|
3641
|
+
|
|
3642
|
+
# @!attribute [rw] db_subnet_group
|
|
3643
|
+
# Detailed information about a DB subnet group.
|
|
3644
|
+
# @return [Types::DBSubnetGroup]
|
|
3645
|
+
#
|
|
3646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroupResult AWS API Documentation
|
|
3647
|
+
#
|
|
3648
|
+
class ModifyDBSubnetGroupResult < Struct.new(
|
|
3649
|
+
:db_subnet_group)
|
|
3650
|
+
include Aws::Structure
|
|
3651
|
+
end
|
|
3652
|
+
|
|
3653
|
+
# The options that are available for a DB instance.
|
|
3654
|
+
#
|
|
3655
|
+
# @!attribute [rw] engine
|
|
3656
|
+
# The engine type of a DB instance.
|
|
3657
|
+
# @return [String]
|
|
3658
|
+
#
|
|
3659
|
+
# @!attribute [rw] engine_version
|
|
3660
|
+
# The engine version of a DB instance.
|
|
3661
|
+
# @return [String]
|
|
3662
|
+
#
|
|
3663
|
+
# @!attribute [rw] db_instance_class
|
|
3664
|
+
# The DB instance class for a DB instance.
|
|
3665
|
+
# @return [String]
|
|
3666
|
+
#
|
|
3667
|
+
# @!attribute [rw] license_model
|
|
3668
|
+
# The license model for a DB instance.
|
|
3669
|
+
# @return [String]
|
|
3670
|
+
#
|
|
3671
|
+
# @!attribute [rw] availability_zones
|
|
3672
|
+
# A list of Availability Zones for a DB instance.
|
|
3673
|
+
# @return [Array<Types::AvailabilityZone>]
|
|
3674
|
+
#
|
|
3675
|
+
# @!attribute [rw] vpc
|
|
3676
|
+
# Indicates whether a DB instance is in a virtual private cloud (VPC).
|
|
3677
|
+
# @return [Boolean]
|
|
3678
|
+
#
|
|
3679
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/OrderableDBInstanceOption AWS API Documentation
|
|
3680
|
+
#
|
|
3681
|
+
class OrderableDBInstanceOption < Struct.new(
|
|
3682
|
+
:engine,
|
|
3683
|
+
:engine_version,
|
|
3684
|
+
:db_instance_class,
|
|
3685
|
+
:license_model,
|
|
3686
|
+
:availability_zones,
|
|
3687
|
+
:vpc)
|
|
3688
|
+
include Aws::Structure
|
|
3689
|
+
end
|
|
3690
|
+
|
|
3691
|
+
# Represents the output of DescribeOrderableDBInstanceOptions.
|
|
3692
|
+
#
|
|
3693
|
+
# @!attribute [rw] orderable_db_instance_options
|
|
3694
|
+
# The options that are available for a particular orderable DB
|
|
3695
|
+
# instance.
|
|
3696
|
+
# @return [Array<Types::OrderableDBInstanceOption>]
|
|
3697
|
+
#
|
|
3698
|
+
# @!attribute [rw] marker
|
|
3699
|
+
# An optional pagination token provided by a previous request. If this
|
|
3700
|
+
# parameter is specified, the response includes only records beyond
|
|
3701
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
3702
|
+
# @return [String]
|
|
3703
|
+
#
|
|
3704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/OrderableDBInstanceOptionsMessage AWS API Documentation
|
|
3705
|
+
#
|
|
3706
|
+
class OrderableDBInstanceOptionsMessage < Struct.new(
|
|
3707
|
+
:orderable_db_instance_options,
|
|
3708
|
+
:marker)
|
|
3709
|
+
include Aws::Structure
|
|
3710
|
+
end
|
|
3711
|
+
|
|
3712
|
+
# Detailed information about an individual parameter.
|
|
3713
|
+
#
|
|
3714
|
+
# @note When making an API call, you may pass Parameter
|
|
3715
|
+
# data as a hash:
|
|
3716
|
+
#
|
|
3717
|
+
# {
|
|
3718
|
+
# parameter_name: "String",
|
|
3719
|
+
# parameter_value: "String",
|
|
3720
|
+
# description: "String",
|
|
3721
|
+
# source: "String",
|
|
3722
|
+
# apply_type: "String",
|
|
3723
|
+
# data_type: "String",
|
|
3724
|
+
# allowed_values: "String",
|
|
3725
|
+
# is_modifiable: false,
|
|
3726
|
+
# minimum_engine_version: "String",
|
|
3727
|
+
# apply_method: "immediate", # accepts immediate, pending-reboot
|
|
3728
|
+
# }
|
|
3729
|
+
#
|
|
3730
|
+
# @!attribute [rw] parameter_name
|
|
3731
|
+
# Specifies the name of the parameter.
|
|
3732
|
+
# @return [String]
|
|
3733
|
+
#
|
|
3734
|
+
# @!attribute [rw] parameter_value
|
|
3735
|
+
# Specifies the value of the parameter.
|
|
3736
|
+
# @return [String]
|
|
3737
|
+
#
|
|
3738
|
+
# @!attribute [rw] description
|
|
3739
|
+
# Provides a description of the parameter.
|
|
3740
|
+
# @return [String]
|
|
3741
|
+
#
|
|
3742
|
+
# @!attribute [rw] source
|
|
3743
|
+
# Indicates the source of the parameter value.
|
|
3744
|
+
# @return [String]
|
|
3745
|
+
#
|
|
3746
|
+
# @!attribute [rw] apply_type
|
|
3747
|
+
# Specifies the engine-specific parameters type.
|
|
3748
|
+
# @return [String]
|
|
3749
|
+
#
|
|
3750
|
+
# @!attribute [rw] data_type
|
|
3751
|
+
# Specifies the valid data type for the parameter.
|
|
3752
|
+
# @return [String]
|
|
3753
|
+
#
|
|
3754
|
+
# @!attribute [rw] allowed_values
|
|
3755
|
+
# Specifies the valid range of values for the parameter.
|
|
3756
|
+
# @return [String]
|
|
3757
|
+
#
|
|
3758
|
+
# @!attribute [rw] is_modifiable
|
|
3759
|
+
# Indicates whether (`true`) or not (`false`) the parameter can be
|
|
3760
|
+
# modified. Some parameters have security or operational implications
|
|
3761
|
+
# that prevent them from being changed.
|
|
3762
|
+
# @return [Boolean]
|
|
3763
|
+
#
|
|
3764
|
+
# @!attribute [rw] minimum_engine_version
|
|
3765
|
+
# The earliest engine version to which the parameter can apply.
|
|
3766
|
+
# @return [String]
|
|
3767
|
+
#
|
|
3768
|
+
# @!attribute [rw] apply_method
|
|
3769
|
+
# Indicates when to apply parameter updates.
|
|
3770
|
+
# @return [String]
|
|
3771
|
+
#
|
|
3772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Parameter AWS API Documentation
|
|
3773
|
+
#
|
|
3774
|
+
class Parameter < Struct.new(
|
|
3775
|
+
:parameter_name,
|
|
3776
|
+
:parameter_value,
|
|
3777
|
+
:description,
|
|
3778
|
+
:source,
|
|
3779
|
+
:apply_type,
|
|
3780
|
+
:data_type,
|
|
3781
|
+
:allowed_values,
|
|
3782
|
+
:is_modifiable,
|
|
3783
|
+
:minimum_engine_version,
|
|
3784
|
+
:apply_method)
|
|
3785
|
+
include Aws::Structure
|
|
3786
|
+
end
|
|
3787
|
+
|
|
3788
|
+
# A list of the log types whose configuration is still pending. These
|
|
3789
|
+
# log types are in the process of being activated or deactivated.
|
|
3790
|
+
#
|
|
3791
|
+
# @!attribute [rw] log_types_to_enable
|
|
3792
|
+
# Log types that are in the process of being deactivated. After they
|
|
3793
|
+
# are deactivated, these log types aren't exported to CloudWatch
|
|
3794
|
+
# Logs.
|
|
3795
|
+
# @return [Array<String>]
|
|
3796
|
+
#
|
|
3797
|
+
# @!attribute [rw] log_types_to_disable
|
|
3798
|
+
# Log types that are in the process of being enabled. After they are
|
|
3799
|
+
# enabled, these log types are exported to Amazon CloudWatch Logs.
|
|
3800
|
+
# @return [Array<String>]
|
|
3801
|
+
#
|
|
3802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingCloudwatchLogsExports AWS API Documentation
|
|
3803
|
+
#
|
|
3804
|
+
class PendingCloudwatchLogsExports < Struct.new(
|
|
3805
|
+
:log_types_to_enable,
|
|
3806
|
+
:log_types_to_disable)
|
|
3807
|
+
include Aws::Structure
|
|
3808
|
+
end
|
|
3809
|
+
|
|
3810
|
+
# Provides information about a pending maintenance action for a
|
|
3811
|
+
# resource.
|
|
3812
|
+
#
|
|
3813
|
+
# @!attribute [rw] action
|
|
3814
|
+
# The type of pending maintenance action that is available for the
|
|
3815
|
+
# resource.
|
|
3816
|
+
# @return [String]
|
|
3817
|
+
#
|
|
3818
|
+
# @!attribute [rw] auto_applied_after_date
|
|
3819
|
+
# The date of the maintenance window when the action is applied. The
|
|
3820
|
+
# maintenance action is applied to the resource during its first
|
|
3821
|
+
# maintenance window after this date. If this date is specified, any
|
|
3822
|
+
# `next-maintenance` opt-in requests are ignored.
|
|
3823
|
+
# @return [Time]
|
|
3824
|
+
#
|
|
3825
|
+
# @!attribute [rw] forced_apply_date
|
|
3826
|
+
# The date when the maintenance action is automatically applied. The
|
|
3827
|
+
# maintenance action is applied to the resource on this date
|
|
3828
|
+
# regardless of the maintenance window for the resource. If this date
|
|
3829
|
+
# is specified, any `immediate` opt-in requests are ignored.
|
|
3830
|
+
# @return [Time]
|
|
3831
|
+
#
|
|
3832
|
+
# @!attribute [rw] opt_in_status
|
|
3833
|
+
# Indicates the type of opt-in request that has been received for the
|
|
3834
|
+
# resource.
|
|
3835
|
+
# @return [String]
|
|
3836
|
+
#
|
|
3837
|
+
# @!attribute [rw] current_apply_date
|
|
3838
|
+
# The effective date when the pending maintenance action is applied to
|
|
3839
|
+
# the resource.
|
|
3840
|
+
# @return [Time]
|
|
3841
|
+
#
|
|
3842
|
+
# @!attribute [rw] description
|
|
3843
|
+
# A description providing more detail about the maintenance action.
|
|
3844
|
+
# @return [String]
|
|
3845
|
+
#
|
|
3846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingMaintenanceAction AWS API Documentation
|
|
3847
|
+
#
|
|
3848
|
+
class PendingMaintenanceAction < Struct.new(
|
|
3849
|
+
:action,
|
|
3850
|
+
:auto_applied_after_date,
|
|
3851
|
+
:forced_apply_date,
|
|
3852
|
+
:opt_in_status,
|
|
3853
|
+
:current_apply_date,
|
|
3854
|
+
:description)
|
|
3855
|
+
include Aws::Structure
|
|
3856
|
+
end
|
|
3857
|
+
|
|
3858
|
+
# Represents the output of DescribePendingMaintenanceActions.
|
|
3859
|
+
#
|
|
3860
|
+
# @!attribute [rw] pending_maintenance_actions
|
|
3861
|
+
# The maintenance actions to be applied.
|
|
3862
|
+
# @return [Array<Types::ResourcePendingMaintenanceActions>]
|
|
3863
|
+
#
|
|
3864
|
+
# @!attribute [rw] marker
|
|
3865
|
+
# An optional pagination token provided by a previous request. If this
|
|
3866
|
+
# parameter is specified, the response includes only records beyond
|
|
3867
|
+
# the marker, up to the value specified by `MaxRecords`.
|
|
3868
|
+
# @return [String]
|
|
3869
|
+
#
|
|
3870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingMaintenanceActionsMessage AWS API Documentation
|
|
3871
|
+
#
|
|
3872
|
+
class PendingMaintenanceActionsMessage < Struct.new(
|
|
3873
|
+
:pending_maintenance_actions,
|
|
3874
|
+
:marker)
|
|
3875
|
+
include Aws::Structure
|
|
3876
|
+
end
|
|
3877
|
+
|
|
3878
|
+
# One or more modified settings for a DB instance. These modified
|
|
3879
|
+
# settings have been requested, but haven't been applied yet.
|
|
3880
|
+
#
|
|
3881
|
+
# @!attribute [rw] db_instance_class
|
|
3882
|
+
# Contains the new `DBInstanceClass` for the DB instance that will be
|
|
3883
|
+
# applied or is currently being applied.
|
|
3884
|
+
# @return [String]
|
|
3885
|
+
#
|
|
3886
|
+
# @!attribute [rw] allocated_storage
|
|
3887
|
+
# Contains the new `AllocatedStorage` size for the DB instance that
|
|
3888
|
+
# will be applied or is currently being applied.
|
|
3889
|
+
# @return [Integer]
|
|
3890
|
+
#
|
|
3891
|
+
# @!attribute [rw] master_user_password
|
|
3892
|
+
# Contains the pending or currently in-progress change of the master
|
|
3893
|
+
# credentials for the DB instance.
|
|
3894
|
+
# @return [String]
|
|
3895
|
+
#
|
|
3896
|
+
# @!attribute [rw] port
|
|
3897
|
+
# Specifies the pending port for the DB instance.
|
|
3898
|
+
# @return [Integer]
|
|
3899
|
+
#
|
|
3900
|
+
# @!attribute [rw] backup_retention_period
|
|
3901
|
+
# Specifies the pending number of days for which automated backups are
|
|
3902
|
+
# retained.
|
|
3903
|
+
# @return [Integer]
|
|
3904
|
+
#
|
|
3905
|
+
# @!attribute [rw] multi_az
|
|
3906
|
+
# Indicates that the Single-AZ DB instance is to change to a Multi-AZ
|
|
3907
|
+
# deployment.
|
|
3908
|
+
# @return [Boolean]
|
|
3909
|
+
#
|
|
3910
|
+
# @!attribute [rw] engine_version
|
|
3911
|
+
# Indicates the database engine version.
|
|
3912
|
+
# @return [String]
|
|
3913
|
+
#
|
|
3914
|
+
# @!attribute [rw] license_model
|
|
3915
|
+
# The license model for the DB instance.
|
|
3916
|
+
#
|
|
3917
|
+
# Valid values: `license-included`, `bring-your-own-license`,
|
|
3918
|
+
# `general-public-license`
|
|
3919
|
+
# @return [String]
|
|
3920
|
+
#
|
|
3921
|
+
# @!attribute [rw] iops
|
|
3922
|
+
# Specifies the new Provisioned IOPS value for the DB instance that
|
|
3923
|
+
# will be applied or is currently being applied.
|
|
3924
|
+
# @return [Integer]
|
|
3925
|
+
#
|
|
3926
|
+
# @!attribute [rw] db_instance_identifier
|
|
3927
|
+
# Contains the new `DBInstanceIdentifier` for the DB instance that
|
|
3928
|
+
# will be applied or is currently being applied.
|
|
3929
|
+
# @return [String]
|
|
3930
|
+
#
|
|
3931
|
+
# @!attribute [rw] storage_type
|
|
3932
|
+
# Specifies the storage type to be associated with the DB instance.
|
|
3933
|
+
# @return [String]
|
|
3934
|
+
#
|
|
3935
|
+
# @!attribute [rw] ca_certificate_identifier
|
|
3936
|
+
# Specifies the identifier of the certificate authority (CA)
|
|
3937
|
+
# certificate for the DB instance.
|
|
3938
|
+
# @return [String]
|
|
3939
|
+
#
|
|
3940
|
+
# @!attribute [rw] db_subnet_group_name
|
|
3941
|
+
# The new DB subnet group for the DB instance.
|
|
3942
|
+
# @return [String]
|
|
3943
|
+
#
|
|
3944
|
+
# @!attribute [rw] pending_cloudwatch_logs_exports
|
|
3945
|
+
# A list of the log types whose configuration is still pending. These
|
|
3946
|
+
# log types are in the process of being activated or deactivated.
|
|
3947
|
+
# @return [Types::PendingCloudwatchLogsExports]
|
|
3948
|
+
#
|
|
3949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingModifiedValues AWS API Documentation
|
|
3950
|
+
#
|
|
3951
|
+
class PendingModifiedValues < Struct.new(
|
|
3952
|
+
:db_instance_class,
|
|
3953
|
+
:allocated_storage,
|
|
3954
|
+
:master_user_password,
|
|
3955
|
+
:port,
|
|
3956
|
+
:backup_retention_period,
|
|
3957
|
+
:multi_az,
|
|
3958
|
+
:engine_version,
|
|
3959
|
+
:license_model,
|
|
3960
|
+
:iops,
|
|
3961
|
+
:db_instance_identifier,
|
|
3962
|
+
:storage_type,
|
|
3963
|
+
:ca_certificate_identifier,
|
|
3964
|
+
:db_subnet_group_name,
|
|
3965
|
+
:pending_cloudwatch_logs_exports)
|
|
3966
|
+
include Aws::Structure
|
|
3967
|
+
end
|
|
3968
|
+
|
|
3969
|
+
# Represents the input to RebootDBInstance.
|
|
3970
|
+
#
|
|
3971
|
+
# @note When making an API call, you may pass RebootDBInstanceMessage
|
|
3972
|
+
# data as a hash:
|
|
3973
|
+
#
|
|
3974
|
+
# {
|
|
3975
|
+
# db_instance_identifier: "String", # required
|
|
3976
|
+
# force_failover: false,
|
|
3977
|
+
# }
|
|
3978
|
+
#
|
|
3979
|
+
# @!attribute [rw] db_instance_identifier
|
|
3980
|
+
# The DB instance identifier. This parameter is stored as a lowercase
|
|
3981
|
+
# string.
|
|
3982
|
+
#
|
|
3983
|
+
# Constraints:
|
|
3984
|
+
#
|
|
3985
|
+
# * Must match the identifier of an existing `DBInstance`.
|
|
3986
|
+
#
|
|
3987
|
+
# ^
|
|
3988
|
+
# @return [String]
|
|
3989
|
+
#
|
|
3990
|
+
# @!attribute [rw] force_failover
|
|
3991
|
+
# When `true`, the reboot is conducted through a Multi-AZ failover.
|
|
3992
|
+
#
|
|
3993
|
+
# Constraint: You can't specify `true` if the instance is not
|
|
3994
|
+
# configured for Multi-AZ.
|
|
3995
|
+
# @return [Boolean]
|
|
3996
|
+
#
|
|
3997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstanceMessage AWS API Documentation
|
|
3998
|
+
#
|
|
3999
|
+
class RebootDBInstanceMessage < Struct.new(
|
|
4000
|
+
:db_instance_identifier,
|
|
4001
|
+
:force_failover)
|
|
4002
|
+
include Aws::Structure
|
|
4003
|
+
end
|
|
4004
|
+
|
|
4005
|
+
# @!attribute [rw] db_instance
|
|
4006
|
+
# Detailed information about a DB instance.
|
|
4007
|
+
# @return [Types::DBInstance]
|
|
4008
|
+
#
|
|
4009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstanceResult AWS API Documentation
|
|
4010
|
+
#
|
|
4011
|
+
class RebootDBInstanceResult < Struct.new(
|
|
4012
|
+
:db_instance)
|
|
4013
|
+
include Aws::Structure
|
|
4014
|
+
end
|
|
4015
|
+
|
|
4016
|
+
# Represents the input to RemoveTagsFromResource.
|
|
4017
|
+
#
|
|
4018
|
+
# @note When making an API call, you may pass RemoveTagsFromResourceMessage
|
|
4019
|
+
# data as a hash:
|
|
4020
|
+
#
|
|
4021
|
+
# {
|
|
4022
|
+
# resource_name: "String", # required
|
|
4023
|
+
# tag_keys: ["String"], # required
|
|
4024
|
+
# }
|
|
4025
|
+
#
|
|
4026
|
+
# @!attribute [rw] resource_name
|
|
4027
|
+
# The Amazon DocumentDB resource that the tags are removed from. This
|
|
4028
|
+
# value is an Amazon Resource Name (ARN).
|
|
4029
|
+
# @return [String]
|
|
4030
|
+
#
|
|
4031
|
+
# @!attribute [rw] tag_keys
|
|
4032
|
+
# The tag key (name) of the tag to be removed.
|
|
4033
|
+
# @return [Array<String>]
|
|
4034
|
+
#
|
|
4035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveTagsFromResourceMessage AWS API Documentation
|
|
4036
|
+
#
|
|
4037
|
+
class RemoveTagsFromResourceMessage < Struct.new(
|
|
4038
|
+
:resource_name,
|
|
4039
|
+
:tag_keys)
|
|
4040
|
+
include Aws::Structure
|
|
4041
|
+
end
|
|
4042
|
+
|
|
4043
|
+
# Represents the input to ResetDBClusterParameterGroup.
|
|
4044
|
+
#
|
|
4045
|
+
# @note When making an API call, you may pass ResetDBClusterParameterGroupMessage
|
|
4046
|
+
# data as a hash:
|
|
4047
|
+
#
|
|
4048
|
+
# {
|
|
4049
|
+
# db_cluster_parameter_group_name: "String", # required
|
|
4050
|
+
# reset_all_parameters: false,
|
|
4051
|
+
# parameters: [
|
|
4052
|
+
# {
|
|
4053
|
+
# parameter_name: "String",
|
|
4054
|
+
# parameter_value: "String",
|
|
4055
|
+
# description: "String",
|
|
4056
|
+
# source: "String",
|
|
4057
|
+
# apply_type: "String",
|
|
4058
|
+
# data_type: "String",
|
|
4059
|
+
# allowed_values: "String",
|
|
4060
|
+
# is_modifiable: false,
|
|
4061
|
+
# minimum_engine_version: "String",
|
|
4062
|
+
# apply_method: "immediate", # accepts immediate, pending-reboot
|
|
4063
|
+
# },
|
|
4064
|
+
# ],
|
|
4065
|
+
# }
|
|
4066
|
+
#
|
|
4067
|
+
# @!attribute [rw] db_cluster_parameter_group_name
|
|
4068
|
+
# The name of the DB cluster parameter group to reset.
|
|
4069
|
+
# @return [String]
|
|
4070
|
+
#
|
|
4071
|
+
# @!attribute [rw] reset_all_parameters
|
|
4072
|
+
# A value that is set to `true` to reset all parameters in the DB
|
|
4073
|
+
# cluster parameter group to their default values, and `false`
|
|
4074
|
+
# otherwise. You can't use this parameter if there is a list of
|
|
4075
|
+
# parameter names specified for the `Parameters` parameter.
|
|
4076
|
+
# @return [Boolean]
|
|
4077
|
+
#
|
|
4078
|
+
# @!attribute [rw] parameters
|
|
4079
|
+
# A list of parameter names in the DB cluster parameter group to reset
|
|
4080
|
+
# to the default values. You can't use this parameter if the
|
|
4081
|
+
# `ResetAllParameters` parameter is set to `true`.
|
|
4082
|
+
# @return [Array<Types::Parameter>]
|
|
4083
|
+
#
|
|
4084
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResetDBClusterParameterGroupMessage AWS API Documentation
|
|
4085
|
+
#
|
|
4086
|
+
class ResetDBClusterParameterGroupMessage < Struct.new(
|
|
4087
|
+
:db_cluster_parameter_group_name,
|
|
4088
|
+
:reset_all_parameters,
|
|
4089
|
+
:parameters)
|
|
4090
|
+
include Aws::Structure
|
|
4091
|
+
end
|
|
4092
|
+
|
|
4093
|
+
# Represents the output of ApplyPendingMaintenanceAction.
|
|
4094
|
+
#
|
|
4095
|
+
# @!attribute [rw] resource_identifier
|
|
4096
|
+
# The Amazon Resource Name (ARN) of the resource that has pending
|
|
4097
|
+
# maintenance actions.
|
|
4098
|
+
# @return [String]
|
|
4099
|
+
#
|
|
4100
|
+
# @!attribute [rw] pending_maintenance_action_details
|
|
4101
|
+
# A list that provides details about the pending maintenance actions
|
|
4102
|
+
# for the resource.
|
|
4103
|
+
# @return [Array<Types::PendingMaintenanceAction>]
|
|
4104
|
+
#
|
|
4105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResourcePendingMaintenanceActions AWS API Documentation
|
|
4106
|
+
#
|
|
4107
|
+
class ResourcePendingMaintenanceActions < Struct.new(
|
|
4108
|
+
:resource_identifier,
|
|
4109
|
+
:pending_maintenance_action_details)
|
|
4110
|
+
include Aws::Structure
|
|
4111
|
+
end
|
|
4112
|
+
|
|
4113
|
+
# Represents the input to RestoreDBClusterFromSnapshot.
|
|
4114
|
+
#
|
|
4115
|
+
# @note When making an API call, you may pass RestoreDBClusterFromSnapshotMessage
|
|
4116
|
+
# data as a hash:
|
|
4117
|
+
#
|
|
4118
|
+
# {
|
|
4119
|
+
# availability_zones: ["String"],
|
|
4120
|
+
# db_cluster_identifier: "String", # required
|
|
4121
|
+
# snapshot_identifier: "String", # required
|
|
4122
|
+
# engine: "String", # required
|
|
4123
|
+
# engine_version: "String",
|
|
4124
|
+
# port: 1,
|
|
4125
|
+
# db_subnet_group_name: "String",
|
|
4126
|
+
# vpc_security_group_ids: ["String"],
|
|
4127
|
+
# tags: [
|
|
4128
|
+
# {
|
|
4129
|
+
# key: "String",
|
|
4130
|
+
# value: "String",
|
|
4131
|
+
# },
|
|
4132
|
+
# ],
|
|
4133
|
+
# kms_key_id: "String",
|
|
4134
|
+
# enable_cloudwatch_logs_exports: ["String"],
|
|
4135
|
+
# }
|
|
4136
|
+
#
|
|
4137
|
+
# @!attribute [rw] availability_zones
|
|
4138
|
+
# Provides the list of Amazon EC2 Availability Zones that instances in
|
|
4139
|
+
# the restored DB cluster can be created in.
|
|
4140
|
+
# @return [Array<String>]
|
|
4141
|
+
#
|
|
4142
|
+
# @!attribute [rw] db_cluster_identifier
|
|
4143
|
+
# The name of the DB cluster to create from the DB snapshot or DB
|
|
4144
|
+
# cluster snapshot. This parameter isn't case sensitive.
|
|
4145
|
+
#
|
|
4146
|
+
# Constraints:
|
|
4147
|
+
#
|
|
4148
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
4149
|
+
#
|
|
4150
|
+
# * The first character must be a letter.
|
|
4151
|
+
#
|
|
4152
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
4153
|
+
#
|
|
4154
|
+
# Example: `my-snapshot-id`
|
|
4155
|
+
# @return [String]
|
|
4156
|
+
#
|
|
4157
|
+
# @!attribute [rw] snapshot_identifier
|
|
4158
|
+
# The identifier for the DB snapshot or DB cluster snapshot to restore
|
|
4159
|
+
# from.
|
|
4160
|
+
#
|
|
4161
|
+
# You can use either the name or the Amazon Resource Name (ARN) to
|
|
4162
|
+
# specify a DB cluster snapshot. However, you can use only the ARN to
|
|
4163
|
+
# specify a DB snapshot.
|
|
4164
|
+
#
|
|
4165
|
+
# Constraints:
|
|
4166
|
+
#
|
|
4167
|
+
# * Must match the identifier of an existing snapshot.
|
|
4168
|
+
#
|
|
4169
|
+
# ^
|
|
4170
|
+
# @return [String]
|
|
4171
|
+
#
|
|
4172
|
+
# @!attribute [rw] engine
|
|
4173
|
+
# The database engine to use for the new DB cluster.
|
|
4174
|
+
#
|
|
4175
|
+
# Default: The same as source.
|
|
4176
|
+
#
|
|
4177
|
+
# Constraint: Must be compatible with the engine of the source.
|
|
4178
|
+
# @return [String]
|
|
4179
|
+
#
|
|
4180
|
+
# @!attribute [rw] engine_version
|
|
4181
|
+
# The version of the database engine to use for the new DB cluster.
|
|
4182
|
+
# @return [String]
|
|
4183
|
+
#
|
|
4184
|
+
# @!attribute [rw] port
|
|
4185
|
+
# The port number on which the new DB cluster accepts connections.
|
|
4186
|
+
#
|
|
4187
|
+
# Constraints: Must be a value from `1150` to `65535`.
|
|
4188
|
+
#
|
|
4189
|
+
# Default: The same port as the original DB cluster.
|
|
4190
|
+
# @return [Integer]
|
|
4191
|
+
#
|
|
4192
|
+
# @!attribute [rw] db_subnet_group_name
|
|
4193
|
+
# The name of the DB subnet group to use for the new DB cluster.
|
|
4194
|
+
#
|
|
4195
|
+
# Constraints: If provided, must match the name of an existing
|
|
4196
|
+
# `DBSubnetGroup`.
|
|
4197
|
+
#
|
|
4198
|
+
# Example: `mySubnetgroup`
|
|
4199
|
+
# @return [String]
|
|
4200
|
+
#
|
|
4201
|
+
# @!attribute [rw] vpc_security_group_ids
|
|
4202
|
+
# A list of virtual private cloud (VPC) security groups that the new
|
|
4203
|
+
# DB cluster will belong to.
|
|
4204
|
+
# @return [Array<String>]
|
|
4205
|
+
#
|
|
4206
|
+
# @!attribute [rw] tags
|
|
4207
|
+
# The tags to be assigned to the restored DB cluster.
|
|
4208
|
+
# @return [Array<Types::Tag>]
|
|
4209
|
+
#
|
|
4210
|
+
# @!attribute [rw] kms_key_id
|
|
4211
|
+
# The AWS KMS key identifier to use when restoring an encrypted DB
|
|
4212
|
+
# cluster from a DB snapshot or DB cluster snapshot.
|
|
4213
|
+
#
|
|
4214
|
+
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
|
4215
|
+
# AWS KMS encryption key. If you are restoring a DB cluster with the
|
|
4216
|
+
# same AWS account that owns the AWS KMS encryption key used to
|
|
4217
|
+
# encrypt the new DB cluster, then you can use the AWS KMS key alias
|
|
4218
|
+
# instead of the ARN for the AWS KMS encryption key.
|
|
4219
|
+
#
|
|
4220
|
+
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
|
4221
|
+
# following occurs:
|
|
4222
|
+
#
|
|
4223
|
+
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
|
4224
|
+
# is encrypted, then the restored DB cluster is encrypted using the
|
|
4225
|
+
# AWS KMS key that was used to encrypt the DB snapshot or the DB
|
|
4226
|
+
# cluster snapshot.
|
|
4227
|
+
#
|
|
4228
|
+
# * If the DB snapshot or the DB cluster snapshot in
|
|
4229
|
+
# `SnapshotIdentifier` is not encrypted, then the restored DB
|
|
4230
|
+
# cluster is not encrypted.
|
|
4231
|
+
# @return [String]
|
|
4232
|
+
#
|
|
4233
|
+
# @!attribute [rw] enable_cloudwatch_logs_exports
|
|
4234
|
+
# A list of log types that must be enabled for exporting to Amazon
|
|
4235
|
+
# CloudWatch Logs.
|
|
4236
|
+
# @return [Array<String>]
|
|
4237
|
+
#
|
|
4238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshotMessage AWS API Documentation
|
|
4239
|
+
#
|
|
4240
|
+
class RestoreDBClusterFromSnapshotMessage < Struct.new(
|
|
4241
|
+
:availability_zones,
|
|
4242
|
+
:db_cluster_identifier,
|
|
4243
|
+
:snapshot_identifier,
|
|
4244
|
+
:engine,
|
|
4245
|
+
:engine_version,
|
|
4246
|
+
:port,
|
|
4247
|
+
:db_subnet_group_name,
|
|
4248
|
+
:vpc_security_group_ids,
|
|
4249
|
+
:tags,
|
|
4250
|
+
:kms_key_id,
|
|
4251
|
+
:enable_cloudwatch_logs_exports)
|
|
4252
|
+
include Aws::Structure
|
|
4253
|
+
end
|
|
4254
|
+
|
|
4255
|
+
# @!attribute [rw] db_cluster
|
|
4256
|
+
# Detailed information about a DB cluster.
|
|
4257
|
+
# @return [Types::DBCluster]
|
|
4258
|
+
#
|
|
4259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshotResult AWS API Documentation
|
|
4260
|
+
#
|
|
4261
|
+
class RestoreDBClusterFromSnapshotResult < Struct.new(
|
|
4262
|
+
:db_cluster)
|
|
4263
|
+
include Aws::Structure
|
|
4264
|
+
end
|
|
4265
|
+
|
|
4266
|
+
# Represents the input to RestoreDBClusterToPointInTime.
|
|
4267
|
+
#
|
|
4268
|
+
# @note When making an API call, you may pass RestoreDBClusterToPointInTimeMessage
|
|
4269
|
+
# data as a hash:
|
|
4270
|
+
#
|
|
4271
|
+
# {
|
|
4272
|
+
# db_cluster_identifier: "String", # required
|
|
4273
|
+
# source_db_cluster_identifier: "String", # required
|
|
4274
|
+
# restore_to_time: Time.now,
|
|
4275
|
+
# use_latest_restorable_time: false,
|
|
4276
|
+
# port: 1,
|
|
4277
|
+
# db_subnet_group_name: "String",
|
|
4278
|
+
# vpc_security_group_ids: ["String"],
|
|
4279
|
+
# tags: [
|
|
4280
|
+
# {
|
|
4281
|
+
# key: "String",
|
|
4282
|
+
# value: "String",
|
|
4283
|
+
# },
|
|
4284
|
+
# ],
|
|
4285
|
+
# kms_key_id: "String",
|
|
4286
|
+
# enable_cloudwatch_logs_exports: ["String"],
|
|
4287
|
+
# }
|
|
4288
|
+
#
|
|
4289
|
+
# @!attribute [rw] db_cluster_identifier
|
|
4290
|
+
# The name of the new DB cluster to be created.
|
|
4291
|
+
#
|
|
4292
|
+
# Constraints:
|
|
4293
|
+
#
|
|
4294
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
4295
|
+
#
|
|
4296
|
+
# * The first character must be a letter.
|
|
4297
|
+
#
|
|
4298
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
4299
|
+
# @return [String]
|
|
4300
|
+
#
|
|
4301
|
+
# @!attribute [rw] source_db_cluster_identifier
|
|
4302
|
+
# The identifier of the source DB cluster from which to restore.
|
|
4303
|
+
#
|
|
4304
|
+
# Constraints:
|
|
4305
|
+
#
|
|
4306
|
+
# * Must match the identifier of an existing `DBCluster`.
|
|
4307
|
+
#
|
|
4308
|
+
# ^
|
|
4309
|
+
# @return [String]
|
|
4310
|
+
#
|
|
4311
|
+
# @!attribute [rw] restore_to_time
|
|
4312
|
+
# The date and time to restore the DB cluster to.
|
|
4313
|
+
#
|
|
4314
|
+
# Valid values: A time in Universal Coordinated Time (UTC) format.
|
|
4315
|
+
#
|
|
4316
|
+
# Constraints:
|
|
4317
|
+
#
|
|
4318
|
+
# * Must be before the latest restorable time for the DB instance.
|
|
4319
|
+
#
|
|
4320
|
+
# * Must be specified if the `UseLatestRestorableTime` parameter is
|
|
4321
|
+
# not provided.
|
|
4322
|
+
#
|
|
4323
|
+
# * Cannot be specified if the `UseLatestRestorableTime` parameter is
|
|
4324
|
+
# `true`.
|
|
4325
|
+
#
|
|
4326
|
+
# * Cannot be specified if the `RestoreType` parameter is
|
|
4327
|
+
# `copy-on-write`.
|
|
4328
|
+
#
|
|
4329
|
+
# Example: `2015-03-07T23:45:00Z`
|
|
4330
|
+
# @return [Time]
|
|
4331
|
+
#
|
|
4332
|
+
# @!attribute [rw] use_latest_restorable_time
|
|
4333
|
+
# A value that is set to `true` to restore the DB cluster to the
|
|
4334
|
+
# latest restorable backup time, and `false` otherwise.
|
|
4335
|
+
#
|
|
4336
|
+
# Default: `false`
|
|
4337
|
+
#
|
|
4338
|
+
# Constraints: Cannot be specified if the `RestoreToTime` parameter is
|
|
4339
|
+
# provided.
|
|
4340
|
+
# @return [Boolean]
|
|
4341
|
+
#
|
|
4342
|
+
# @!attribute [rw] port
|
|
4343
|
+
# The port number on which the new DB cluster accepts connections.
|
|
4344
|
+
#
|
|
4345
|
+
# Constraints: Must be a value from `1150` to `65535`.
|
|
4346
|
+
#
|
|
4347
|
+
# Default: The default port for the engine.
|
|
4348
|
+
# @return [Integer]
|
|
4349
|
+
#
|
|
4350
|
+
# @!attribute [rw] db_subnet_group_name
|
|
4351
|
+
# The DB subnet group name to use for the new DB cluster.
|
|
4352
|
+
#
|
|
4353
|
+
# Constraints: If provided, must match the name of an existing
|
|
4354
|
+
# `DBSubnetGroup`.
|
|
4355
|
+
#
|
|
4356
|
+
# Example: `mySubnetgroup`
|
|
4357
|
+
# @return [String]
|
|
4358
|
+
#
|
|
4359
|
+
# @!attribute [rw] vpc_security_group_ids
|
|
4360
|
+
# A list of VPC security groups that the new DB cluster belongs to.
|
|
4361
|
+
# @return [Array<String>]
|
|
4362
|
+
#
|
|
4363
|
+
# @!attribute [rw] tags
|
|
4364
|
+
# The tags to be assigned to the restored DB cluster.
|
|
4365
|
+
# @return [Array<Types::Tag>]
|
|
4366
|
+
#
|
|
4367
|
+
# @!attribute [rw] kms_key_id
|
|
4368
|
+
# The AWS KMS key identifier to use when restoring an encrypted DB
|
|
4369
|
+
# cluster from an encrypted DB cluster.
|
|
4370
|
+
#
|
|
4371
|
+
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
|
4372
|
+
# AWS KMS encryption key. If you are restoring a DB cluster with the
|
|
4373
|
+
# same AWS account that owns the AWS KMS encryption key used to
|
|
4374
|
+
# encrypt the new DB cluster, then you can use the AWS KMS key alias
|
|
4375
|
+
# instead of the ARN for the AWS KMS encryption key.
|
|
4376
|
+
#
|
|
4377
|
+
# You can restore to a new DB cluster and encrypt the new DB cluster
|
|
4378
|
+
# with an AWS KMS key that is different from the AWS KMS key used to
|
|
4379
|
+
# encrypt the source DB cluster. The new DB cluster is encrypted with
|
|
4380
|
+
# the AWS KMS key identified by the `KmsKeyId` parameter.
|
|
4381
|
+
#
|
|
4382
|
+
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
|
4383
|
+
# following occurs:
|
|
4384
|
+
#
|
|
4385
|
+
# * If the DB cluster is encrypted, then the restored DB cluster is
|
|
4386
|
+
# encrypted using the AWS KMS key that was used to encrypt the
|
|
4387
|
+
# source DB cluster.
|
|
4388
|
+
#
|
|
4389
|
+
# * If the DB cluster is not encrypted, then the restored DB cluster
|
|
4390
|
+
# is not encrypted.
|
|
4391
|
+
#
|
|
4392
|
+
# If `DBClusterIdentifier` refers to a DB cluster that is not
|
|
4393
|
+
# encrypted, then the restore request is rejected.
|
|
4394
|
+
# @return [String]
|
|
4395
|
+
#
|
|
4396
|
+
# @!attribute [rw] enable_cloudwatch_logs_exports
|
|
4397
|
+
# A list of log types that must be enabled for exporting to Amazon
|
|
4398
|
+
# CloudWatch Logs.
|
|
4399
|
+
# @return [Array<String>]
|
|
4400
|
+
#
|
|
4401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTimeMessage AWS API Documentation
|
|
4402
|
+
#
|
|
4403
|
+
class RestoreDBClusterToPointInTimeMessage < Struct.new(
|
|
4404
|
+
:db_cluster_identifier,
|
|
4405
|
+
:source_db_cluster_identifier,
|
|
4406
|
+
:restore_to_time,
|
|
4407
|
+
:use_latest_restorable_time,
|
|
4408
|
+
:port,
|
|
4409
|
+
:db_subnet_group_name,
|
|
4410
|
+
:vpc_security_group_ids,
|
|
4411
|
+
:tags,
|
|
4412
|
+
:kms_key_id,
|
|
4413
|
+
:enable_cloudwatch_logs_exports)
|
|
4414
|
+
include Aws::Structure
|
|
4415
|
+
end
|
|
4416
|
+
|
|
4417
|
+
# @!attribute [rw] db_cluster
|
|
4418
|
+
# Detailed information about a DB cluster.
|
|
4419
|
+
# @return [Types::DBCluster]
|
|
4420
|
+
#
|
|
4421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTimeResult AWS API Documentation
|
|
4422
|
+
#
|
|
4423
|
+
class RestoreDBClusterToPointInTimeResult < Struct.new(
|
|
4424
|
+
:db_cluster)
|
|
4425
|
+
include Aws::Structure
|
|
4426
|
+
end
|
|
4427
|
+
|
|
4428
|
+
# Detailed information about a subnet.
|
|
4429
|
+
#
|
|
4430
|
+
# @!attribute [rw] subnet_identifier
|
|
4431
|
+
# Specifies the identifier of the subnet.
|
|
4432
|
+
# @return [String]
|
|
4433
|
+
#
|
|
4434
|
+
# @!attribute [rw] subnet_availability_zone
|
|
4435
|
+
# Specifies the Availability Zone for the subnet.
|
|
4436
|
+
# @return [Types::AvailabilityZone]
|
|
4437
|
+
#
|
|
4438
|
+
# @!attribute [rw] subnet_status
|
|
4439
|
+
# Specifies the status of the subnet.
|
|
4440
|
+
# @return [String]
|
|
4441
|
+
#
|
|
4442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Subnet AWS API Documentation
|
|
4443
|
+
#
|
|
4444
|
+
class Subnet < Struct.new(
|
|
4445
|
+
:subnet_identifier,
|
|
4446
|
+
:subnet_availability_zone,
|
|
4447
|
+
:subnet_status)
|
|
4448
|
+
include Aws::Structure
|
|
4449
|
+
end
|
|
4450
|
+
|
|
4451
|
+
# Metadata assigned to an Amazon DocumentDB resource consisting of a
|
|
4452
|
+
# key-value pair.
|
|
4453
|
+
#
|
|
4454
|
+
# @note When making an API call, you may pass Tag
|
|
4455
|
+
# data as a hash:
|
|
4456
|
+
#
|
|
4457
|
+
# {
|
|
4458
|
+
# key: "String",
|
|
4459
|
+
# value: "String",
|
|
4460
|
+
# }
|
|
4461
|
+
#
|
|
4462
|
+
# @!attribute [rw] key
|
|
4463
|
+
# The required name of the tag. The string value can be from 1 to 128
|
|
4464
|
+
# Unicode characters in length and can't be prefixed with "aws:" or
|
|
4465
|
+
# "rds:". The string can contain only the set of Unicode letters,
|
|
4466
|
+
# digits, white space, '\_', '.', '/', '=', '+', '-' (Java
|
|
4467
|
+
# regex:
|
|
4468
|
+
# "^(\[\\\\p\\\{L\\}\\\\p\\\{Z\\}\\\\p\\\{N\\}\_.:/=+\\\\-\]*)$").
|
|
4469
|
+
# @return [String]
|
|
4470
|
+
#
|
|
4471
|
+
# @!attribute [rw] value
|
|
4472
|
+
# The optional value of the tag. The string value can be from 1 to 256
|
|
4473
|
+
# Unicode characters in length and can't be prefixed with "aws:" or
|
|
4474
|
+
# "rds:". The string can contain only the set of Unicode letters,
|
|
4475
|
+
# digits, white space, '\_', '.', '/', '=', '+', '-' (Java
|
|
4476
|
+
# regex:
|
|
4477
|
+
# "^(\[\\\\p\\\{L\\}\\\\p\\\{Z\\}\\\\p\\\{N\\}\_.:/=+\\\\-\]*)$").
|
|
4478
|
+
# @return [String]
|
|
4479
|
+
#
|
|
4480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Tag AWS API Documentation
|
|
4481
|
+
#
|
|
4482
|
+
class Tag < Struct.new(
|
|
4483
|
+
:key,
|
|
4484
|
+
:value)
|
|
4485
|
+
include Aws::Structure
|
|
4486
|
+
end
|
|
4487
|
+
|
|
4488
|
+
# Represents the output of ListTagsForResource.
|
|
4489
|
+
#
|
|
4490
|
+
# @!attribute [rw] tag_list
|
|
4491
|
+
# A list of one or more tags.
|
|
4492
|
+
# @return [Array<Types::Tag>]
|
|
4493
|
+
#
|
|
4494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/TagListMessage AWS API Documentation
|
|
4495
|
+
#
|
|
4496
|
+
class TagListMessage < Struct.new(
|
|
4497
|
+
:tag_list)
|
|
4498
|
+
include Aws::Structure
|
|
4499
|
+
end
|
|
4500
|
+
|
|
4501
|
+
# The version of the database engine that a DB instance can be upgraded
|
|
4502
|
+
# to.
|
|
4503
|
+
#
|
|
4504
|
+
# @!attribute [rw] engine
|
|
4505
|
+
# The name of the upgrade target database engine.
|
|
4506
|
+
# @return [String]
|
|
4507
|
+
#
|
|
4508
|
+
# @!attribute [rw] engine_version
|
|
4509
|
+
# The version number of the upgrade target database engine.
|
|
4510
|
+
# @return [String]
|
|
4511
|
+
#
|
|
4512
|
+
# @!attribute [rw] description
|
|
4513
|
+
# The version of the database engine that a DB instance can be
|
|
4514
|
+
# upgraded to.
|
|
4515
|
+
# @return [String]
|
|
4516
|
+
#
|
|
4517
|
+
# @!attribute [rw] auto_upgrade
|
|
4518
|
+
# A value that indicates whether the target version is applied to any
|
|
4519
|
+
# source DB instances that have `AutoMinorVersionUpgrade` set to
|
|
4520
|
+
# `true`.
|
|
4521
|
+
# @return [Boolean]
|
|
4522
|
+
#
|
|
4523
|
+
# @!attribute [rw] is_major_version_upgrade
|
|
4524
|
+
# A value that indicates whether a database engine is upgraded to a
|
|
4525
|
+
# major version.
|
|
4526
|
+
# @return [Boolean]
|
|
4527
|
+
#
|
|
4528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/UpgradeTarget AWS API Documentation
|
|
4529
|
+
#
|
|
4530
|
+
class UpgradeTarget < Struct.new(
|
|
4531
|
+
:engine,
|
|
4532
|
+
:engine_version,
|
|
4533
|
+
:description,
|
|
4534
|
+
:auto_upgrade,
|
|
4535
|
+
:is_major_version_upgrade)
|
|
4536
|
+
include Aws::Structure
|
|
4537
|
+
end
|
|
4538
|
+
|
|
4539
|
+
# Used as a response element for queries on virtual private cloud (VPC)
|
|
4540
|
+
# security group membership.
|
|
4541
|
+
#
|
|
4542
|
+
# @!attribute [rw] vpc_security_group_id
|
|
4543
|
+
# The name of the VPC security group.
|
|
4544
|
+
# @return [String]
|
|
4545
|
+
#
|
|
4546
|
+
# @!attribute [rw] status
|
|
4547
|
+
# The status of the VPC security group.
|
|
4548
|
+
# @return [String]
|
|
4549
|
+
#
|
|
4550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/VpcSecurityGroupMembership AWS API Documentation
|
|
4551
|
+
#
|
|
4552
|
+
class VpcSecurityGroupMembership < Struct.new(
|
|
4553
|
+
:vpc_security_group_id,
|
|
4554
|
+
:status)
|
|
4555
|
+
include Aws::Structure
|
|
4556
|
+
end
|
|
4557
|
+
|
|
4558
|
+
end
|
|
4559
|
+
end
|