aws-sdk-rds 1.0.0.rc2 → 1.0.0.rc3

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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/lib/aws-sdk-rds.rb +2 -2
  3. data/lib/aws-sdk-rds/account_quota.rb +79 -81
  4. data/lib/aws-sdk-rds/certificate.rb +99 -101
  5. data/lib/aws-sdk-rds/client.rb +10575 -9119
  6. data/lib/aws-sdk-rds/client_api.rb +3049 -3023
  7. data/lib/aws-sdk-rds/db_cluster.rb +1005 -1007
  8. data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +204 -206
  9. data/lib/aws-sdk-rds/db_cluster_snapshot.rb +430 -432
  10. data/lib/aws-sdk-rds/db_engine.rb +208 -210
  11. data/lib/aws-sdk-rds/db_engine_version.rb +218 -219
  12. data/lib/aws-sdk-rds/db_instance.rb +2747 -2567
  13. data/lib/aws-sdk-rds/db_log_file.rb +145 -147
  14. data/lib/aws-sdk-rds/db_parameter_group.rb +411 -413
  15. data/lib/aws-sdk-rds/db_parameter_group_family.rb +135 -137
  16. data/lib/aws-sdk-rds/db_security_group.rb +316 -318
  17. data/lib/aws-sdk-rds/db_snapshot.rb +705 -650
  18. data/lib/aws-sdk-rds/db_snapshot_attribute.rb +137 -139
  19. data/lib/aws-sdk-rds/db_subnet_group.rb +161 -163
  20. data/lib/aws-sdk-rds/errors.rb +4 -13
  21. data/lib/aws-sdk-rds/event.rb +108 -110
  22. data/lib/aws-sdk-rds/event_category_map.rb +73 -75
  23. data/lib/aws-sdk-rds/event_subscription.rb +313 -315
  24. data/lib/aws-sdk-rds/option_group.rb +247 -249
  25. data/lib/aws-sdk-rds/option_group_option.rb +135 -137
  26. data/lib/aws-sdk-rds/parameter.rb +116 -118
  27. data/lib/aws-sdk-rds/pending_maintenance_action.rb +182 -184
  28. data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +64 -0
  29. data/lib/aws-sdk-rds/reserved_db_instance.rb +156 -158
  30. data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +154 -156
  31. data/lib/aws-sdk-rds/resource.rb +2395 -2288
  32. data/lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb +89 -91
  33. data/lib/aws-sdk-rds/types.rb +12091 -10977
  34. data/lib/aws-sdk-rds/waiters.rb +127 -128
  35. metadata +3 -2
@@ -1,2398 +1,2505 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module RDS
10
- class Resource
8
+ module Aws::RDS
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
17
16
 
18
- # @return [Client]
19
- def client
20
- @client
21
- end
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
22
21
 
23
- # @!group Actions
22
+ # @!group Actions
24
23
 
25
- # @example Request syntax with placeholder values
26
- #
27
- # dbcluster = rds.create_db_cluster({
28
- # availability_zones: ["String"],
29
- # backup_retention_period: 1,
30
- # character_set_name: "String",
31
- # database_name: "String",
32
- # db_cluster_identifier: "String", # required
33
- # db_cluster_parameter_group_name: "String",
34
- # vpc_security_group_ids: ["String"],
35
- # db_subnet_group_name: "String",
36
- # engine: "String", # required
37
- # engine_version: "String",
38
- # port: 1,
39
- # master_username: "String",
40
- # master_user_password: "String",
41
- # option_group_name: "String",
42
- # preferred_backup_window: "String",
43
- # preferred_maintenance_window: "String",
44
- # replication_source_identifier: "String",
45
- # tags: [
46
- # {
47
- # key: "String",
48
- # value: "String",
49
- # },
50
- # ],
51
- # storage_encrypted: false,
52
- # kms_key_id: "String",
53
- # })
54
- # @param [Hash] options ({})
55
- # @option options [Array<String>] :availability_zones
56
- # A list of EC2 Availability Zones that instances in the DB cluster can
57
- # be created in. For information on regions and Availability Zones, see
58
- # [Regions and Availability Zones][1].
59
- #
60
- #
61
- #
62
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
63
- # @option options [Integer] :backup_retention_period
64
- # The number of days for which automated backups are retained. You must
65
- # specify a minimum value of 1.
66
- #
67
- # Default: 1
68
- #
69
- # Constraints:
70
- #
71
- # * Must be a value from 1 to 35
72
- #
73
- # ^
74
- # @option options [String] :character_set_name
75
- # A value that indicates that the DB cluster should be associated with
76
- # the specified CharacterSet.
77
- # @option options [String] :database_name
78
- # The name for your database of up to 8 alpha-numeric characters. If you
79
- # do not provide a name, Amazon RDS will not create a database in the DB
80
- # cluster you are creating.
81
- # @option options [required, String] :db_cluster_identifier
82
- # The DB cluster identifier. This parameter is stored as a lowercase
83
- # string.
84
- #
85
- # Constraints:
86
- #
87
- # * Must contain from 1 to 63 alphanumeric characters or hyphens.
88
- #
89
- # * First character must be a letter.
90
- #
91
- # * Cannot end with a hyphen or contain two consecutive hyphens.
92
- #
93
- # Example: `my-cluster1`
94
- # @option options [String] :db_cluster_parameter_group_name
95
- # The name of the DB cluster parameter group to associate with this DB
96
- # cluster. If this argument is omitted, `default.aurora5.6` will be
97
- # used.
98
- #
99
- # Constraints:
100
- #
101
- # * Must be 1 to 255 alphanumeric characters
102
- #
103
- # * First character must be a letter
104
- #
105
- # * Cannot end with a hyphen or contain two consecutive hyphens
106
- # @option options [Array<String>] :vpc_security_group_ids
107
- # A list of EC2 VPC security groups to associate with this DB cluster.
108
- # @option options [String] :db_subnet_group_name
109
- # A DB subnet group to associate with this DB cluster.
110
- #
111
- # Constraints: Must contain no more than 255 alphanumeric characters,
112
- # periods, underscores, spaces, or hyphens. Must not be default.
113
- #
114
- # Example: `mySubnetgroup`
115
- # @option options [required, String] :engine
116
- # The name of the database engine to be used for this DB cluster.
117
- #
118
- # Valid Values: `aurora`
119
- # @option options [String] :engine_version
120
- # The version number of the database engine to use.
121
- #
122
- # **Aurora**
123
- #
124
- # Example: `5.6.10a`
125
- # @option options [Integer] :port
126
- # The port number on which the instances in the DB cluster accept
127
- # connections.
128
- #
129
- # Default: `3306`
130
- # @option options [String] :master_username
131
- # The name of the master user for the DB cluster.
132
- #
133
- # Constraints:
134
- #
135
- # * Must be 1 to 16 alphanumeric characters.
136
- #
137
- # * First character must be a letter.
138
- #
139
- # * Cannot be a reserved word for the chosen database engine.
140
- # @option options [String] :master_user_password
141
- # The password for the master database user. This password can contain
142
- # any printable ASCII character except "/", """, or "@".
143
- #
144
- # Constraints: Must contain from 8 to 41 characters.
145
- # @option options [String] :option_group_name
146
- # A value that indicates that the DB cluster should be associated with
147
- # the specified option group.
148
- #
149
- # Permanent options cannot be removed from an option group. The option
150
- # group cannot be removed from a DB cluster once it is associated with a
151
- # DB cluster.
152
- # @option options [String] :preferred_backup_window
153
- # The daily time range during which automated backups are created if
154
- # automated backups are enabled using the `BackupRetentionPeriod`
155
- # parameter.
156
- #
157
- # Default: A 30-minute window selected at random from an 8-hour block of
158
- # time per region. To see the time blocks available, see [ Adjusting the
159
- # Preferred Maintenance Window][1] in the *Amazon RDS User Guide.*
160
- #
161
- # Constraints:
162
- #
163
- # * Must be in the format `hh24:mi-hh24:mi`.
164
- #
165
- # * Times should be in Universal Coordinated Time (UTC).
166
- #
167
- # * Must not conflict with the preferred maintenance window.
168
- #
169
- # * Must be at least 30 minutes.
170
- #
171
- #
172
- #
173
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
174
- # @option options [String] :preferred_maintenance_window
175
- # The weekly time range during which system maintenance can occur, in
176
- # Universal Coordinated Time (UTC).
177
- #
178
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
179
- #
180
- # Default: A 30-minute window selected at random from an 8-hour block of
181
- # time per region, occurring on a random day of the week. To see the
182
- # time blocks available, see [ Adjusting the Preferred Maintenance
183
- # Window][1] in the *Amazon RDS User Guide.*
184
- #
185
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
186
- #
187
- # Constraints: Minimum 30-minute window.
188
- #
189
- #
190
- #
191
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
192
- # @option options [String] :replication_source_identifier
193
- # The Amazon Resource Name (ARN) of the source DB cluster if this DB
194
- # cluster is created as a Read Replica.
195
- # @option options [Array<Types::Tag>] :tags
196
- # A list of tags.
197
- # @option options [Boolean] :storage_encrypted
198
- # Specifies whether the DB cluster is encrypted.
199
- # @option options [String] :kms_key_id
200
- # The KMS key identifier for an encrypted DB cluster.
201
- #
202
- # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
203
- # encryption key. If you are creating a DB cluster with the same AWS
204
- # account that owns the KMS encryption key used to encrypt the new DB
205
- # cluster, then you can use the KMS key alias instead of the ARN for the
206
- # KM encryption key.
207
- #
208
- # If the `StorageEncrypted` parameter is true, and you do not specify a
209
- # value for the `KmsKeyId` parameter, then Amazon RDS will use your
210
- # default encryption key. AWS KMS creates the default encryption key for
211
- # your AWS account. Your AWS account has a different default encryption
212
- # key for each AWS region.
213
- # @return [DBCluster]
214
- def create_db_cluster(options = {})
215
- resp = @client.create_db_cluster(options)
216
- DBCluster.new(
217
- id: options[:db_cluster][:db_cluster_identifier],
218
- data: resp.data.db_cluster,
219
- client: @client
220
- )
221
- end
24
+ # @example Request syntax with placeholder values
25
+ #
26
+ # dbcluster = rds.create_db_cluster({
27
+ # availability_zones: ["String"],
28
+ # backup_retention_period: 1,
29
+ # character_set_name: "String",
30
+ # database_name: "String",
31
+ # db_cluster_identifier: "String", # required
32
+ # db_cluster_parameter_group_name: "String",
33
+ # vpc_security_group_ids: ["String"],
34
+ # db_subnet_group_name: "String",
35
+ # engine: "String", # required
36
+ # engine_version: "String",
37
+ # port: 1,
38
+ # master_username: "String",
39
+ # master_user_password: "String",
40
+ # option_group_name: "String",
41
+ # preferred_backup_window: "String",
42
+ # preferred_maintenance_window: "String",
43
+ # replication_source_identifier: "String",
44
+ # tags: [
45
+ # {
46
+ # key: "String",
47
+ # value: "String",
48
+ # },
49
+ # ],
50
+ # storage_encrypted: false,
51
+ # kms_key_id: "String",
52
+ # })
53
+ # @param [Hash] options ({})
54
+ # @option options [Array<String>] :availability_zones
55
+ # A list of EC2 Availability Zones that instances in the DB cluster can
56
+ # be created in. For information on regions and Availability Zones, see
57
+ # [Regions and Availability Zones][1].
58
+ #
59
+ #
60
+ #
61
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
62
+ # @option options [Integer] :backup_retention_period
63
+ # The number of days for which automated backups are retained. You must
64
+ # specify a minimum value of 1.
65
+ #
66
+ # Default: 1
67
+ #
68
+ # Constraints:
69
+ #
70
+ # * Must be a value from 1 to 35
71
+ #
72
+ # ^
73
+ # @option options [String] :character_set_name
74
+ # A value that indicates that the DB cluster should be associated with
75
+ # the specified CharacterSet.
76
+ # @option options [String] :database_name
77
+ # The name for your database of up to 8 alpha-numeric characters. If you
78
+ # do not provide a name, Amazon RDS will not create a database in the DB
79
+ # cluster you are creating.
80
+ # @option options [required, String] :db_cluster_identifier
81
+ # The DB cluster identifier. This parameter is stored as a lowercase
82
+ # string.
83
+ #
84
+ # Constraints:
85
+ #
86
+ # * Must contain from 1 to 63 alphanumeric characters or hyphens.
87
+ #
88
+ # * First character must be a letter.
89
+ #
90
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
91
+ #
92
+ # Example: `my-cluster1`
93
+ # @option options [String] :db_cluster_parameter_group_name
94
+ # The name of the DB cluster parameter group to associate with this DB
95
+ # cluster. If this argument is omitted, `default.aurora5.6` will be
96
+ # used.
97
+ #
98
+ # Constraints:
99
+ #
100
+ # * Must be 1 to 255 alphanumeric characters
101
+ #
102
+ # * First character must be a letter
103
+ #
104
+ # * Cannot end with a hyphen or contain two consecutive hyphens
105
+ # @option options [Array<String>] :vpc_security_group_ids
106
+ # A list of EC2 VPC security groups to associate with this DB cluster.
107
+ # @option options [String] :db_subnet_group_name
108
+ # A DB subnet group to associate with this DB cluster.
109
+ #
110
+ # Constraints: Must contain no more than 255 alphanumeric characters,
111
+ # periods, underscores, spaces, or hyphens. Must not be default.
112
+ #
113
+ # Example: `mySubnetgroup`
114
+ # @option options [required, String] :engine
115
+ # The name of the database engine to be used for this DB cluster.
116
+ #
117
+ # Valid Values: `aurora`
118
+ # @option options [String] :engine_version
119
+ # The version number of the database engine to use.
120
+ #
121
+ # **Aurora**
122
+ #
123
+ # Example: `5.6.10a`
124
+ # @option options [Integer] :port
125
+ # The port number on which the instances in the DB cluster accept
126
+ # connections.
127
+ #
128
+ # Default: `3306`
129
+ # @option options [String] :master_username
130
+ # The name of the master user for the DB cluster.
131
+ #
132
+ # Constraints:
133
+ #
134
+ # * Must be 1 to 16 alphanumeric characters.
135
+ #
136
+ # * First character must be a letter.
137
+ #
138
+ # * Cannot be a reserved word for the chosen database engine.
139
+ # @option options [String] :master_user_password
140
+ # The password for the master database user. This password can contain
141
+ # any printable ASCII character except "/", """, or "@".
142
+ #
143
+ # Constraints: Must contain from 8 to 41 characters.
144
+ # @option options [String] :option_group_name
145
+ # A value that indicates that the DB cluster should be associated with
146
+ # the specified option group.
147
+ #
148
+ # Permanent options cannot be removed from an option group. The option
149
+ # group cannot be removed from a DB cluster once it is associated with a
150
+ # DB cluster.
151
+ # @option options [String] :preferred_backup_window
152
+ # The daily time range during which automated backups are created if
153
+ # automated backups are enabled using the `BackupRetentionPeriod`
154
+ # parameter.
155
+ #
156
+ # Default: A 30-minute window selected at random from an 8-hour block of
157
+ # time per region. To see the time blocks available, see [ Adjusting the
158
+ # Preferred Maintenance Window][1] in the *Amazon RDS User Guide.*
159
+ #
160
+ # Constraints:
161
+ #
162
+ # * Must be in the format `hh24:mi-hh24:mi`.
163
+ #
164
+ # * Times should be in Universal Coordinated Time (UTC).
165
+ #
166
+ # * Must not conflict with the preferred maintenance window.
167
+ #
168
+ # * Must be at least 30 minutes.
169
+ #
170
+ #
171
+ #
172
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
173
+ # @option options [String] :preferred_maintenance_window
174
+ # The weekly time range during which system maintenance can occur, in
175
+ # Universal Coordinated Time (UTC).
176
+ #
177
+ # Format: `ddd:hh24:mi-ddd:hh24:mi`
178
+ #
179
+ # Default: A 30-minute window selected at random from an 8-hour block of
180
+ # time per region, occurring on a random day of the week. To see the
181
+ # time blocks available, see [ Adjusting the Preferred Maintenance
182
+ # Window][1] in the *Amazon RDS User Guide.*
183
+ #
184
+ # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
185
+ #
186
+ # Constraints: Minimum 30-minute window.
187
+ #
188
+ #
189
+ #
190
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
191
+ # @option options [String] :replication_source_identifier
192
+ # The Amazon Resource Name (ARN) of the source DB instance or DB cluster
193
+ # if this DB cluster is created as a Read Replica.
194
+ # @option options [Array<Types::Tag>] :tags
195
+ # A list of tags.
196
+ # @option options [Boolean] :storage_encrypted
197
+ # Specifies whether the DB cluster is encrypted.
198
+ # @option options [String] :kms_key_id
199
+ # The KMS key identifier for an encrypted DB cluster.
200
+ #
201
+ # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
202
+ # encryption key. If you are creating a DB cluster with the same AWS
203
+ # account that owns the KMS encryption key used to encrypt the new DB
204
+ # cluster, then you can use the KMS key alias instead of the ARN for the
205
+ # KM encryption key.
206
+ #
207
+ # If the `StorageEncrypted` parameter is true, and you do not specify a
208
+ # value for the `KmsKeyId` parameter, then Amazon RDS will use your
209
+ # default encryption key. AWS KMS creates the default encryption key for
210
+ # your AWS account. Your AWS account has a different default encryption
211
+ # key for each AWS region.
212
+ # @return [DBCluster]
213
+ def create_db_cluster(options = {})
214
+ resp = @client.create_db_cluster(options)
215
+ DBCluster.new(
216
+ id: options[:db_cluster][:db_cluster_identifier],
217
+ data: resp.data.db_cluster,
218
+ client: @client
219
+ )
220
+ end
222
221
 
223
- # @example Request syntax with placeholder values
224
- #
225
- # dbclusterparametergroup = rds.create_db_cluster_parameter_group({
226
- # db_cluster_parameter_group_name: "String", # required
227
- # db_parameter_group_family: "String", # required
228
- # description: "String", # required
229
- # tags: [
230
- # {
231
- # key: "String",
232
- # value: "String",
233
- # },
234
- # ],
235
- # })
236
- # @param [Hash] options ({})
237
- # @option options [required, String] :db_cluster_parameter_group_name
238
- # The name of the DB cluster parameter group.
239
- #
240
- # Constraints:
241
- #
242
- # * Must be 1 to 255 alphanumeric characters
243
- #
244
- # * First character must be a letter
245
- #
246
- # * Cannot end with a hyphen or contain two consecutive hyphens
247
- #
248
- # <note markdown="1"> This value is stored as a lowercase string.
249
- #
250
- # </note>
251
- # @option options [required, String] :db_parameter_group_family
252
- # The DB cluster parameter group family name. A DB cluster parameter
253
- # group can be associated with one and only one DB cluster parameter
254
- # group family, and can be applied only to a DB cluster running a
255
- # database engine and engine version compatible with that DB cluster
256
- # parameter group family.
257
- # @option options [required, String] :description
258
- # The description for the DB cluster parameter group.
259
- # @option options [Array<Types::Tag>] :tags
260
- # A list of tags.
261
- # @return [DBClusterParameterGroup]
262
- def create_db_cluster_parameter_group(options = {})
263
- resp = @client.create_db_cluster_parameter_group(options)
264
- DBClusterParameterGroup.new(
265
- name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name,
266
- data: resp.data.db_cluster_parameter_group,
267
- client: @client
268
- )
269
- end
222
+ # @example Request syntax with placeholder values
223
+ #
224
+ # dbclusterparametergroup = rds.create_db_cluster_parameter_group({
225
+ # db_cluster_parameter_group_name: "String", # required
226
+ # db_parameter_group_family: "String", # required
227
+ # description: "String", # required
228
+ # tags: [
229
+ # {
230
+ # key: "String",
231
+ # value: "String",
232
+ # },
233
+ # ],
234
+ # })
235
+ # @param [Hash] options ({})
236
+ # @option options [required, String] :db_cluster_parameter_group_name
237
+ # The name of the DB cluster parameter group.
238
+ #
239
+ # Constraints:
240
+ #
241
+ # * Must be 1 to 255 alphanumeric characters
242
+ #
243
+ # * First character must be a letter
244
+ #
245
+ # * Cannot end with a hyphen or contain two consecutive hyphens
246
+ #
247
+ # <note markdown="1"> This value is stored as a lowercase string.
248
+ #
249
+ # </note>
250
+ # @option options [required, String] :db_parameter_group_family
251
+ # The DB cluster parameter group family name. A DB cluster parameter
252
+ # group can be associated with one and only one DB cluster parameter
253
+ # group family, and can be applied only to a DB cluster running a
254
+ # database engine and engine version compatible with that DB cluster
255
+ # parameter group family.
256
+ # @option options [required, String] :description
257
+ # The description for the DB cluster parameter group.
258
+ # @option options [Array<Types::Tag>] :tags
259
+ # A list of tags.
260
+ # @return [DBClusterParameterGroup]
261
+ def create_db_cluster_parameter_group(options = {})
262
+ resp = @client.create_db_cluster_parameter_group(options)
263
+ DBClusterParameterGroup.new(
264
+ name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name,
265
+ data: resp.data.db_cluster_parameter_group,
266
+ client: @client
267
+ )
268
+ end
270
269
 
271
- # @example Request syntax with placeholder values
272
- #
273
- # dbinstance = rds.create_db_instance({
274
- # db_name: "String",
275
- # db_instance_identifier: "String", # required
276
- # allocated_storage: 1,
277
- # db_instance_class: "String", # required
278
- # engine: "String", # required
279
- # master_username: "String",
280
- # master_user_password: "String",
281
- # db_security_groups: ["String"],
282
- # vpc_security_group_ids: ["String"],
283
- # availability_zone: "String",
284
- # db_subnet_group_name: "String",
285
- # preferred_maintenance_window: "String",
286
- # db_parameter_group_name: "String",
287
- # backup_retention_period: 1,
288
- # preferred_backup_window: "String",
289
- # port: 1,
290
- # multi_az: false,
291
- # engine_version: "String",
292
- # auto_minor_version_upgrade: false,
293
- # license_model: "String",
294
- # iops: 1,
295
- # option_group_name: "String",
296
- # character_set_name: "String",
297
- # publicly_accessible: false,
298
- # tags: [
299
- # {
300
- # key: "String",
301
- # value: "String",
302
- # },
303
- # ],
304
- # db_cluster_identifier: "String",
305
- # storage_type: "String",
306
- # tde_credential_arn: "String",
307
- # tde_credential_password: "String",
308
- # storage_encrypted: false,
309
- # kms_key_id: "String",
310
- # domain: "String",
311
- # copy_tags_to_snapshot: false,
312
- # monitoring_interval: 1,
313
- # monitoring_role_arn: "String",
314
- # domain_iam_role_name: "String",
315
- # promotion_tier: 1,
316
- # timezone: "String",
317
- # })
318
- # @param [Hash] options ({})
319
- # @option options [String] :db_name
320
- # The meaning of this parameter differs according to the database engine
321
- # you use.
322
- #
323
- # Type: String
324
- #
325
- # **MySQL**
326
- #
327
- # The name of the database to create when the DB instance is created. If
328
- # this parameter is not specified, no database is created in the DB
329
- # instance.
330
- #
331
- # Constraints:
332
- #
333
- # * Must contain 1 to 64 alphanumeric characters
334
- #
335
- # * Cannot be a word reserved by the specified database engine
336
- #
337
- # **MariaDB**
338
- #
339
- # The name of the database to create when the DB instance is created. If
340
- # this parameter is not specified, no database is created in the DB
341
- # instance.
342
- #
343
- # Constraints:
344
- #
345
- # * Must contain 1 to 64 alphanumeric characters
346
- #
347
- # * Cannot be a word reserved by the specified database engine
348
- #
349
- # **PostgreSQL**
350
- #
351
- # The name of the database to create when the DB instance is created. If
352
- # this parameter is not specified, the default "postgres" database is
353
- # created in the DB instance.
354
- #
355
- # Constraints:
356
- #
357
- # * Must contain 1 to 63 alphanumeric characters
358
- #
359
- # * Must begin with a letter or an underscore. Subsequent characters can
360
- # be letters, underscores, or digits (0-9).
361
- #
362
- # * Cannot be a word reserved by the specified database engine
363
- #
364
- # **Oracle**
365
- #
366
- # The Oracle System ID (SID) of the created DB instance.
367
- #
368
- # Default: `ORCL`
369
- #
370
- # Constraints:
371
- #
372
- # * Cannot be longer than 8 characters
373
- #
374
- # ^
375
- #
376
- # **SQL Server**
377
- #
378
- # Not applicable. Must be null.
379
- #
380
- # **Amazon Aurora**
381
- #
382
- # The name of the database to create when the primary instance of the DB
383
- # cluster is created. If this parameter is not specified, no database is
384
- # created in the DB instance.
385
- #
386
- # Constraints:
387
- #
388
- # * Must contain 1 to 64 alphanumeric characters
389
- #
390
- # * Cannot be a word reserved by the specified database engine
391
- # @option options [required, String] :db_instance_identifier
392
- # The DB instance identifier. This parameter is stored as a lowercase
393
- # string.
394
- #
395
- # Constraints:
396
- #
397
- # * Must contain from 1 to 63 alphanumeric characters or hyphens (1 to
398
- # 15 for SQL Server).
399
- #
400
- # * First character must be a letter.
401
- #
402
- # * Cannot end with a hyphen or contain two consecutive hyphens.
403
- #
404
- # Example: `mydbinstance`
405
- # @option options [Integer] :allocated_storage
406
- # The amount of storage (in gigabytes) to be initially allocated for the
407
- # database instance.
408
- #
409
- # Type: Integer
410
- #
411
- # **MySQL**
412
- #
413
- # Constraints: Must be an integer from 5 to 6144.
414
- #
415
- # **MariaDB**
416
- #
417
- # Constraints: Must be an integer from 5 to 6144.
418
- #
419
- # **PostgreSQL**
420
- #
421
- # Constraints: Must be an integer from 5 to 6144.
422
- #
423
- # **Oracle**
424
- #
425
- # Constraints: Must be an integer from 10 to 6144.
426
- #
427
- # **SQL Server**
428
- #
429
- # Constraints: Must be an integer from 200 to 4096 (Standard Edition and
430
- # Enterprise Edition) or from 20 to 4096 (Express Edition and Web
431
- # Edition)
432
- # @option options [required, String] :db_instance_class
433
- # The compute and memory capacity of the DB instance.
434
- #
435
- # Valid Values: `db.t1.micro | db.m1.small | db.m1.medium | db.m1.large
436
- # | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge |
437
- # db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
438
- # db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
439
- # db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |
440
- # db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |
441
- # db.t2.medium | db.t2.large`
442
- # @option options [required, String] :engine
443
- # The name of the database engine to be used for this instance.
444
- #
445
- # Valid Values: `mysql` \| `mariadb` \| `oracle-se1` \| `oracle-se2` \|
446
- # `oracle-se` \| `oracle-ee` \| `sqlserver-ee` \| `sqlserver-se` \|
447
- # `sqlserver-ex` \| `sqlserver-web` \| `postgres` \| `aurora`
448
- #
449
- # Not every database engine is available for every AWS region.
450
- # @option options [String] :master_username
451
- # The name of master user for the client DB instance.
452
- #
453
- # **MySQL**
454
- #
455
- # Constraints:
456
- #
457
- # * Must be 1 to 16 alphanumeric characters.
458
- #
459
- # * First character must be a letter.
460
- #
461
- # * Cannot be a reserved word for the chosen database engine.
462
- #
463
- # **MariaDB**
464
- #
465
- # Constraints:
466
- #
467
- # * Must be 1 to 16 alphanumeric characters.
468
- #
469
- # * Cannot be a reserved word for the chosen database engine.
470
- #
471
- # Type: String
472
- #
473
- # **Oracle**
474
- #
475
- # Constraints:
476
- #
477
- # * Must be 1 to 30 alphanumeric characters.
478
- #
479
- # * First character must be a letter.
480
- #
481
- # * Cannot be a reserved word for the chosen database engine.
482
- #
483
- # **SQL Server**
484
- #
485
- # Constraints:
486
- #
487
- # * Must be 1 to 128 alphanumeric characters.
488
- #
489
- # * First character must be a letter.
490
- #
491
- # * Cannot be a reserved word for the chosen database engine.
492
- #
493
- # **PostgreSQL**
494
- #
495
- # Constraints:
496
- #
497
- # * Must be 1 to 63 alphanumeric characters.
498
- #
499
- # * First character must be a letter.
500
- #
501
- # * Cannot be a reserved word for the chosen database engine.
502
- # @option options [String] :master_user_password
503
- # The password for the master database user. Can be any printable ASCII
504
- # character except "/", """, or "@".
505
- #
506
- # Type: String
507
- #
508
- # **MySQL**
509
- #
510
- # Constraints: Must contain from 8 to 41 characters.
511
- #
512
- # **MariaDB**
513
- #
514
- # Constraints: Must contain from 8 to 41 characters.
515
- #
516
- # **Oracle**
517
- #
518
- # Constraints: Must contain from 8 to 30 characters.
519
- #
520
- # **SQL Server**
521
- #
522
- # Constraints: Must contain from 8 to 128 characters.
523
- #
524
- # **PostgreSQL**
525
- #
526
- # Constraints: Must contain from 8 to 128 characters.
527
- #
528
- # **Amazon Aurora**
529
- #
530
- # Constraints: Must contain from 8 to 41 characters.
531
- # @option options [Array<String>] :db_security_groups
532
- # A list of DB security groups to associate with this DB instance.
533
- #
534
- # Default: The default DB security group for the database engine.
535
- # @option options [Array<String>] :vpc_security_group_ids
536
- # A list of EC2 VPC security groups to associate with this DB instance.
537
- #
538
- # Default: The default EC2 VPC security group for the DB subnet group's
539
- # VPC.
540
- # @option options [String] :availability_zone
541
- # The EC2 Availability Zone that the database instance will be created
542
- # in. For information on regions and Availability Zones, see [Regions
543
- # and Availability Zones][1].
544
- #
545
- # Default: A random, system-chosen Availability Zone in the endpoint's
546
- # region.
547
- #
548
- # Example: `us-east-1d`
549
- #
550
- # Constraint: The AvailabilityZone parameter cannot be specified if the
551
- # MultiAZ parameter is set to `true`. The specified Availability Zone
552
- # must be in the same region as the current endpoint.
553
- #
554
- #
555
- #
556
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
557
- # @option options [String] :db_subnet_group_name
558
- # A DB subnet group to associate with this DB instance.
559
- #
560
- # If there is no DB subnet group, then it is a non-VPC DB instance.
561
- # @option options [String] :preferred_maintenance_window
562
- # The weekly time range during which system maintenance can occur, in
563
- # Universal Coordinated Time (UTC). For more information, see [DB
564
- # Instance Maintenance][1].
565
- #
566
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
567
- #
568
- # Default: A 30-minute window selected at random from an 8-hour block of
569
- # time per region, occurring on a random day of the week. To see the
570
- # time blocks available, see [ Adjusting the Preferred Maintenance
571
- # Window][2] in the *Amazon RDS User Guide.*
572
- #
573
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
574
- #
575
- # Constraints: Minimum 30-minute window.
576
- #
577
- #
578
- #
579
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance.html
580
- # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
581
- # @option options [String] :db_parameter_group_name
582
- # The name of the DB parameter group to associate with this DB instance.
583
- # If this argument is omitted, the default DBParameterGroup for the
584
- # specified engine will be used.
585
- #
586
- # Constraints:
587
- #
588
- # * Must be 1 to 255 alphanumeric characters
589
- #
590
- # * First character must be a letter
591
- #
592
- # * Cannot end with a hyphen or contain two consecutive hyphens
593
- # @option options [Integer] :backup_retention_period
594
- # The number of days for which automated backups are retained. Setting
595
- # this parameter to a positive number enables backups. Setting this
596
- # parameter to 0 disables automated backups.
597
- #
598
- # Default: 1
599
- #
600
- # Constraints:
601
- #
602
- # * Must be a value from 0 to 35
603
- #
604
- # * Cannot be set to 0 if the DB instance is a source to Read Replicas
605
- # @option options [String] :preferred_backup_window
606
- # The daily time range during which automated backups are created if
607
- # automated backups are enabled, using the `BackupRetentionPeriod`
608
- # parameter. For more information, see [DB Instance Backups][1].
609
- #
610
- # Default: A 30-minute window selected at random from an 8-hour block of
611
- # time per region. To see the time blocks available, see [ Adjusting the
612
- # Preferred Maintenance Window][2] in the *Amazon RDS User Guide.*
613
- #
614
- # Constraints:
615
- #
616
- # * Must be in the format `hh24:mi-hh24:mi`.
617
- #
618
- # * Times should be in Universal Coordinated Time (UTC).
619
- #
620
- # * Must not conflict with the preferred maintenance window.
621
- #
622
- # * Must be at least 30 minutes.
623
- #
624
- #
625
- #
626
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.BackingUpAndRestoringAmazonRDSInstances.html
627
- # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
628
- # @option options [Integer] :port
629
- # The port number on which the database accepts connections.
630
- #
631
- # **MySQL**
632
- #
633
- # Default: `3306`
634
- #
635
- # Valid Values: `1150-65535`
636
- #
637
- # Type: Integer
638
- #
639
- # **MariaDB**
640
- #
641
- # Default: `3306`
642
- #
643
- # Valid Values: `1150-65535`
644
- #
645
- # Type: Integer
646
- #
647
- # **PostgreSQL**
648
- #
649
- # Default: `5432`
650
- #
651
- # Valid Values: `1150-65535`
652
- #
653
- # Type: Integer
654
- #
655
- # **Oracle**
656
- #
657
- # Default: `1521`
658
- #
659
- # Valid Values: `1150-65535`
660
- #
661
- # **SQL Server**
662
- #
663
- # Default: `1433`
664
- #
665
- # Valid Values: `1150-65535` except for `1434`, `3389`, `47001`,
666
- # `49152`, and `49152` through `49156`.
667
- #
668
- # **Amazon Aurora**
669
- #
670
- # Default: `3306`
671
- #
672
- # Valid Values: `1150-65535`
673
- #
674
- # Type: Integer
675
- # @option options [Boolean] :multi_az
676
- # Specifies if the DB instance is a Multi-AZ deployment. You cannot set
677
- # the AvailabilityZone parameter if the MultiAZ parameter is set to
678
- # true.
679
- # @option options [String] :engine_version
680
- # The version number of the database engine to use.
681
- #
682
- # The following are the database engines and major and minor versions
683
- # that are available with Amazon RDS. Not every database engine is
684
- # available for every AWS region.
685
- #
686
- # **Amazon Aurora**
687
- #
688
- # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
689
- # ap-northeast-2, ap-south-1, ap-southeast-2, eu-west-1, us-east-1,
690
- # us-east-2, us-west-2):** ` 5.6.10a`
691
- #
692
- # ^
693
- #
694
- # **MariaDB**
695
- #
696
- # * **Version 10.1 (available in these AWS regions: us-east-2):** `
697
- # 10.1.16`
698
- #
699
- # * **Version 10.1 (available in these AWS regions: ap-northeast-1,
700
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
701
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1,
702
- # us-west-2):** ` 10.1.14`
703
- #
704
- # * **Version 10.0 (available in all AWS regions):** ` 10.0.24`
705
- #
706
- # * **Version 10.0 (available in these AWS regions: ap-northeast-1,
707
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
708
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
709
- # us-west-1, us-west-2):** ` 10.0.17`
710
- #
711
- # **Microsoft SQL Server 2016**
712
- #
713
- # * `13.00.2164.0.v1` (supported for all editions, and all AWS regions
714
- # except sa-east-1)
715
- #
716
- # ^
717
- #
718
- # **Microsoft SQL Server 2014**
719
- #
720
- # * `12.00.5000.0.v1` (supported for all editions, and all AWS regions)
721
- #
722
- # * `12.00.4422.0.v1` (supported for all editions except Enterprise
723
- # Edition, and all AWS regions except us-east-2)
724
- #
725
- # **Microsoft SQL Server 2012**
726
- #
727
- # * `11.00.6020.0.v1` (supported for all editions, and all AWS regions)
728
- #
729
- # * `11.00.5058.0.v1` (supported for all editions, and all AWS regions
730
- # except us-east-2)
731
- #
732
- # * `11.00.2100.60.v1` (supported for all editions, and all AWS regions
733
- # except us-east-2)
734
- #
735
- # **Microsoft SQL Server 2008 R2**
736
- #
737
- # * `10.50.6529.0.v1` (supported for all editions, and all AWS regions
738
- # except us-east-2)
739
- #
740
- # * `10.50.6000.34.v1` (supported for all editions, and all AWS regions
741
- # except us-east-2)
742
- #
743
- # * `10.50.2789.0.v1` (supported for all editions, and all AWS regions
744
- # except us-east-2)
745
- #
746
- # **MySQL**
747
- #
748
- # * **Version 5.7 (available in all AWS regions):** ` 5.7.11`
749
- #
750
- # * **Version 5.7 (available in these AWS regions: ap-northeast-1,
751
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
752
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
753
- # us-west-1, us-west-2):** ` 5.7.10`
754
- #
755
- # * **Version 5.6 (available in all AWS regions):** ` 5.6.29`
756
- #
757
- # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
758
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
759
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
760
- # us-west-1, us-west-2):** ` 5.6.27`
761
- #
762
- # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
763
- # ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1,
764
- # eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1,
765
- # us-west-2):** ` 5.6.23`
766
- #
767
- # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
768
- # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
769
- # us-east-1, us-gov-west-1, us-west-1, us-west-2):** ` 5.6.19a |
770
- # 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22`
771
- #
772
- # * **Version 5.5 (available in all AWS regions):** ` 5.5.46`
773
- #
774
- # * **Version 5.5 (available in these AWS regions: ap-northeast-1,
775
- # ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1,
776
- # eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1,
777
- # us-west-2):** ` 5.5.42`
778
- #
779
- # * **Version 5.5 (available in these AWS regions: ap-northeast-1,
780
- # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
781
- # us-east-1, us-gov-west-1, us-west-1, us-west-2):** ` 5.5.40b |
782
- # 5.5.41`
783
- #
784
- # * **Version 5.5 (available in these AWS regions: ap-northeast-1,
785
- # ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1,
786
- # us-gov-west-1, us-west-1, us-west-2):** ` 5.5.40 | 5.5.40a`
787
- #
788
- #
789
- #
790
- # **Oracle 12c**
791
- #
792
- # * `12.1.0.2.v5` (supported for EE in all AWS regions, and SE2 in all
793
- # AWS regions except us-gov-west-1)
794
- #
795
- # * `12.1.0.2.v4` (supported for EE in all AWS regions, and SE2 in all
796
- # AWS regions except us-gov-west-1)
797
- #
798
- # * `12.1.0.2.v3` (supported for EE in all AWS regions, and SE2 in all
799
- # AWS regions except us-gov-west-1)
800
- #
801
- # * `12.1.0.2.v2` (supported for EE in all AWS regions, and SE2 in all
802
- # AWS regions except us-gov-west-1)
803
- #
804
- # * `12.1.0.2.v1` (supported for EE in all AWS regions, and SE2 in all
805
- # AWS regions except us-gov-west-1)
806
- #
807
- #
808
- #
809
- # * `12.1.0.1.v6` (supported for EE, SE1, and SE, in all AWS regions
810
- # except ap-south-1, ap-northeast-2)
811
- #
812
- # * `12.1.0.1.v5` (supported for EE, SE1, and SE, in all AWS regions
813
- # except ap-south-1, ap-northeast-2)
814
- #
815
- # * `12.1.0.1.v4` (supported for EE, SE1, and SE, in all AWS regions
816
- # except ap-south-1, ap-northeast-2)
817
- #
818
- # * `12.1.0.1.v3` (supported for EE, SE1, and SE, in all AWS regions
819
- # except ap-south-1, ap-northeast-2)
820
- #
821
- # * `12.1.0.1.v2` (supported for EE, SE1, and SE, in all AWS regions
822
- # except ap-south-1, ap-northeast-2)
823
- #
824
- # * `12.1.0.1.v1` (supported for EE, SE1, and SE, in all AWS regions
825
- # except ap-south-1, ap-northeast-2)
826
- #
827
- # **Oracle 11g**
828
- #
829
- # * `11.2.0.4.v9` (supported for EE, SE1, and SE, in all AWS regions)
830
- #
831
- # * `11.2.0.4.v8` (supported for EE, SE1, and SE, in all AWS regions)
832
- #
833
- # * `11.2.0.4.v7` (supported for EE, SE1, and SE, in all AWS regions)
834
- #
835
- # * `11.2.0.4.v6` (supported for EE, SE1, and SE, in all AWS regions)
836
- #
837
- # * `11.2.0.4.v5` (supported for EE, SE1, and SE, in all AWS regions)
838
- #
839
- # * `11.2.0.4.v4` (supported for EE, SE1, and SE, in all AWS regions)
840
- #
841
- # * `11.2.0.4.v3` (supported for EE, SE1, and SE, in all AWS regions)
842
- #
843
- # * `11.2.0.4.v1` (supported for EE, SE1, and SE, in all AWS regions)
844
- #
845
- # **PostgreSQL**
846
- #
847
- # * **Version 9.5 (available in these AWS regions: ap-northeast-1,
848
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
849
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1,
850
- # us-west-2):** ` 9.5.4`
851
- #
852
- # * **Version 9.5 (available in these AWS regions: ap-northeast-1,
853
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
854
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1,
855
- # us-west-2):** ` 9.5.2`
856
- #
857
- # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
858
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
859
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1,
860
- # us-west-2):** ` 9.4.9`
861
- #
862
- # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
863
- # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
864
- # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1,
865
- # us-west-2):** ` 9.4.7`
866
- #
867
- # * **Version 9.4 (available in all AWS regions):** ` 9.4.5`
868
- #
869
- # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
870
- # ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1,
871
- # eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1,
872
- # us-west-2):** ` 9.4.4`
873
- #
874
- # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
875
- # ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1,
876
- # eu-west-1, sa-east-1, us-east-1, us-east-2, us-gov-west-1,
877
- # us-west-1, us-west-2):** ` 9.4.1`
878
- #
879
- # * **Version 9.3 (available in these AWS regions: ap-northeast-1,
880
- # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
881
- # us-east-1, us-gov-west-1, us-west-1, us-west-2):** ` 9.3.10 | 9.3.3
882
- # | 9.3.5 | 9.3.6 | 9.3.9`
883
- #
884
- # * **Version 9.3 (available in these AWS regions: ap-northeast-1,
885
- # ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1,
886
- # us-gov-west-1, us-west-1, us-west-2):** ` 9.3.1 | 9.3.2`
887
- #
888
- # * **Version 9.3 (available in these AWS regions: ap-northeast-1,
889
- # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
890
- # us-east-1, us-west-1, us-west-2):** ` 9.3.12 | 9.3.14`
891
- # @option options [Boolean] :auto_minor_version_upgrade
892
- # Indicates that minor engine upgrades will be applied automatically to
893
- # the DB instance during the maintenance window.
894
- #
895
- # Default: `true`
896
- # @option options [String] :license_model
897
- # License model information for this DB instance.
898
- #
899
- # Valid values: `license-included` \| `bring-your-own-license` \|
900
- # `general-public-license`
901
- # @option options [Integer] :iops
902
- # The amount of Provisioned IOPS (input/output operations per second) to
903
- # be initially allocated for the DB instance.
904
- #
905
- # Constraints: Must be a multiple between 3 and 10 of the storage amount
906
- # for the DB instance. Must also be an integer multiple of 1000. For
907
- # example, if the size of your DB instance is 500 GB, then your `Iops`
908
- # value can be 2000, 3000, 4000, or 5000.
909
- # @option options [String] :option_group_name
910
- # Indicates that the DB instance should be associated with the specified
911
- # option group.
912
- #
913
- # Permanent options, such as the TDE option for Oracle Advanced Security
914
- # TDE, cannot be removed from an option group, and that option group
915
- # cannot be removed from a DB instance once it is associated with a DB
916
- # instance
917
- # @option options [String] :character_set_name
918
- # For supported engines, indicates that the DB instance should be
919
- # associated with the specified CharacterSet.
920
- # @option options [Boolean] :publicly_accessible
921
- # Specifies the accessibility options for the DB instance. A value of
922
- # true specifies an Internet-facing instance with a publicly resolvable
923
- # DNS name, which resolves to a public IP address. A value of false
924
- # specifies an internal instance with a DNS name that resolves to a
925
- # private IP address.
926
- #
927
- # Default: The default behavior varies depending on whether a VPC has
928
- # been requested or not. The following list shows the default behavior
929
- # in each case.
930
- #
931
- # * **Default VPC:** true
932
- #
933
- # * **VPC:** false
934
- #
935
- # If no DB subnet group has been specified as part of the request and
936
- # the PubliclyAccessible value has not been set, the DB instance will be
937
- # publicly accessible. If a specific DB subnet group has been specified
938
- # as part of the request and the PubliclyAccessible value has not been
939
- # set, the DB instance will be private.
940
- # @option options [Array<Types::Tag>] :tags
941
- # A list of tags.
942
- # @option options [String] :db_cluster_identifier
943
- # The identifier of the DB cluster that the instance will belong to.
944
- #
945
- # For information on creating a DB cluster, see CreateDBCluster.
946
- #
947
- # Type: String
948
- # @option options [String] :storage_type
949
- # Specifies the storage type to be associated with the DB instance.
950
- #
951
- # Valid values: `standard | gp2 | io1`
952
- #
953
- # If you specify `io1`, you must also include a value for the `Iops`
954
- # parameter.
955
- #
956
- # Default: `io1` if the `Iops` parameter is specified; otherwise
957
- # `standard`
958
- # @option options [String] :tde_credential_arn
959
- # The ARN from the Key Store with which to associate the instance for
960
- # TDE encryption.
961
- # @option options [String] :tde_credential_password
962
- # The password for the given ARN from the Key Store in order to access
963
- # the device.
964
- # @option options [Boolean] :storage_encrypted
965
- # Specifies whether the DB instance is encrypted.
966
- #
967
- # Default: false
968
- # @option options [String] :kms_key_id
969
- # The KMS key identifier for an encrypted DB instance.
970
- #
971
- # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
972
- # encryption key. If you are creating a DB instance with the same AWS
973
- # account that owns the KMS encryption key used to encrypt the new DB
974
- # instance, then you can use the KMS key alias instead of the ARN for
975
- # the KM encryption key.
976
- #
977
- # If the `StorageEncrypted` parameter is true, and you do not specify a
978
- # value for the `KmsKeyId` parameter, then Amazon RDS will use your
979
- # default encryption key. AWS KMS creates the default encryption key for
980
- # your AWS account. Your AWS account has a different default encryption
981
- # key for each AWS region.
982
- # @option options [String] :domain
983
- # Specify the Active Directory Domain to create the instance in.
984
- # @option options [Boolean] :copy_tags_to_snapshot
985
- # True to copy all tags from the DB instance to snapshots of the DB
986
- # instance; otherwise false. The default is false.
987
- # @option options [Integer] :monitoring_interval
988
- # The interval, in seconds, between points when Enhanced Monitoring
989
- # metrics are collected for the DB instance. To disable collecting
990
- # Enhanced Monitoring metrics, specify 0. The default is 0.
991
- #
992
- # If `MonitoringRoleArn` is specified, then you must also set
993
- # `MonitoringInterval` to a value other than 0.
994
- #
995
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
996
- # @option options [String] :monitoring_role_arn
997
- # The ARN for the IAM role that permits RDS to send enhanced monitoring
998
- # metrics to CloudWatch Logs. For example,
999
- # `arn:aws:iam:123456789012:role/emaccess`. For information on creating
1000
- # a monitoring role, go to [To create an IAM role for Amazon RDS
1001
- # Enhanced Monitoring][1].
1002
- #
1003
- # If `MonitoringInterval` is set to a value other than 0, then you must
1004
- # supply a `MonitoringRoleArn` value.
1005
- #
1006
- #
1007
- #
1008
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
1009
- # @option options [String] :domain_iam_role_name
1010
- # Specify the name of the IAM role to be used when making API calls to
1011
- # the Directory Service.
1012
- # @option options [Integer] :promotion_tier
1013
- # A value that specifies the order in which an Aurora Replica is
1014
- # promoted to the primary instance after a failure of the existing
1015
- # primary instance. For more information, see [ Fault Tolerance for an
1016
- # Aurora DB Cluster][1].
1017
- #
1018
- # Default: 1
1019
- #
1020
- # Valid Values: 0 - 15
1021
- #
1022
- #
1023
- #
1024
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance
1025
- # @option options [String] :timezone
1026
- # The time zone of the DB instance. The time zone parameter is currently
1027
- # supported only by [Microsoft SQL Server][1].
1028
- #
1029
- #
1030
- #
1031
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
1032
- # @return [DBInstance]
1033
- def create_db_instance(options = {})
1034
- resp = @client.create_db_instance(options)
1035
- DBInstance.new(
1036
- id: resp.data.db_instance.db_instance_identifier,
1037
- data: resp.data.db_instance,
1038
- client: @client
1039
- )
1040
- end
270
+ # @example Request syntax with placeholder values
271
+ #
272
+ # dbinstance = rds.create_db_instance({
273
+ # db_name: "String",
274
+ # db_instance_identifier: "String", # required
275
+ # allocated_storage: 1,
276
+ # db_instance_class: "String", # required
277
+ # engine: "String", # required
278
+ # master_username: "String",
279
+ # master_user_password: "String",
280
+ # db_security_groups: ["String"],
281
+ # vpc_security_group_ids: ["String"],
282
+ # availability_zone: "String",
283
+ # db_subnet_group_name: "String",
284
+ # preferred_maintenance_window: "String",
285
+ # db_parameter_group_name: "String",
286
+ # backup_retention_period: 1,
287
+ # preferred_backup_window: "String",
288
+ # port: 1,
289
+ # multi_az: false,
290
+ # engine_version: "String",
291
+ # auto_minor_version_upgrade: false,
292
+ # license_model: "String",
293
+ # iops: 1,
294
+ # option_group_name: "String",
295
+ # character_set_name: "String",
296
+ # publicly_accessible: false,
297
+ # tags: [
298
+ # {
299
+ # key: "String",
300
+ # value: "String",
301
+ # },
302
+ # ],
303
+ # db_cluster_identifier: "String",
304
+ # storage_type: "String",
305
+ # tde_credential_arn: "String",
306
+ # tde_credential_password: "String",
307
+ # storage_encrypted: false,
308
+ # kms_key_id: "String",
309
+ # domain: "String",
310
+ # copy_tags_to_snapshot: false,
311
+ # monitoring_interval: 1,
312
+ # monitoring_role_arn: "String",
313
+ # domain_iam_role_name: "String",
314
+ # promotion_tier: 1,
315
+ # timezone: "String",
316
+ # })
317
+ # @param [Hash] options ({})
318
+ # @option options [String] :db_name
319
+ # The meaning of this parameter differs according to the database engine
320
+ # you use.
321
+ #
322
+ # Type: String
323
+ #
324
+ # **MySQL**
325
+ #
326
+ # The name of the database to create when the DB instance is created. If
327
+ # this parameter is not specified, no database is created in the DB
328
+ # instance.
329
+ #
330
+ # Constraints:
331
+ #
332
+ # * Must contain 1 to 64 alphanumeric characters
333
+ #
334
+ # * Cannot be a word reserved by the specified database engine
335
+ #
336
+ # **MariaDB**
337
+ #
338
+ # The name of the database to create when the DB instance is created. If
339
+ # this parameter is not specified, no database is created in the DB
340
+ # instance.
341
+ #
342
+ # Constraints:
343
+ #
344
+ # * Must contain 1 to 64 alphanumeric characters
345
+ #
346
+ # * Cannot be a word reserved by the specified database engine
347
+ #
348
+ # **PostgreSQL**
349
+ #
350
+ # The name of the database to create when the DB instance is created. If
351
+ # this parameter is not specified, the default "postgres" database is
352
+ # created in the DB instance.
353
+ #
354
+ # Constraints:
355
+ #
356
+ # * Must contain 1 to 63 alphanumeric characters
357
+ #
358
+ # * Must begin with a letter or an underscore. Subsequent characters can
359
+ # be letters, underscores, or digits (0-9).
360
+ #
361
+ # * Cannot be a word reserved by the specified database engine
362
+ #
363
+ # **Oracle**
364
+ #
365
+ # The Oracle System ID (SID) of the created DB instance.
366
+ #
367
+ # Default: `ORCL`
368
+ #
369
+ # Constraints:
370
+ #
371
+ # * Cannot be longer than 8 characters
372
+ #
373
+ # ^
374
+ #
375
+ # **SQL Server**
376
+ #
377
+ # Not applicable. Must be null.
378
+ #
379
+ # **Amazon Aurora**
380
+ #
381
+ # The name of the database to create when the primary instance of the DB
382
+ # cluster is created. If this parameter is not specified, no database is
383
+ # created in the DB instance.
384
+ #
385
+ # Constraints:
386
+ #
387
+ # * Must contain 1 to 64 alphanumeric characters
388
+ #
389
+ # * Cannot be a word reserved by the specified database engine
390
+ # @option options [required, String] :db_instance_identifier
391
+ # The DB instance identifier. This parameter is stored as a lowercase
392
+ # string.
393
+ #
394
+ # Constraints:
395
+ #
396
+ # * Must contain from 1 to 63 alphanumeric characters or hyphens (1 to
397
+ # 15 for SQL Server).
398
+ #
399
+ # * First character must be a letter.
400
+ #
401
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
402
+ #
403
+ # Example: `mydbinstance`
404
+ # @option options [Integer] :allocated_storage
405
+ # The amount of storage (in gigabytes) to be initially allocated for the
406
+ # database instance.
407
+ #
408
+ # Type: Integer
409
+ #
410
+ # **MySQL**
411
+ #
412
+ # Constraints: Must be an integer from 5 to 6144.
413
+ #
414
+ # **MariaDB**
415
+ #
416
+ # Constraints: Must be an integer from 5 to 6144.
417
+ #
418
+ # **PostgreSQL**
419
+ #
420
+ # Constraints: Must be an integer from 5 to 6144.
421
+ #
422
+ # **Oracle**
423
+ #
424
+ # Constraints: Must be an integer from 10 to 6144.
425
+ #
426
+ # **SQL Server**
427
+ #
428
+ # Constraints: Must be an integer from 200 to 4096 (Standard Edition and
429
+ # Enterprise Edition) or from 20 to 4096 (Express Edition and Web
430
+ # Edition)
431
+ # @option options [required, String] :db_instance_class
432
+ # The compute and memory capacity of the DB instance. Note that not all
433
+ # instance classes are available in all regions for all DB engines.
434
+ #
435
+ # Valid Values: `db.t1.micro | db.m1.small | db.m1.medium | db.m1.large
436
+ # | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge |
437
+ # db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
438
+ # db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
439
+ # db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |
440
+ # db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |
441
+ # db.t2.medium | db.t2.large`
442
+ # @option options [required, String] :engine
443
+ # The name of the database engine to be used for this instance.
444
+ #
445
+ # Valid Values: `mysql` \| `mariadb` \| `oracle-se1` \| `oracle-se2` \|
446
+ # `oracle-se` \| `oracle-ee` \| `sqlserver-ee` \| `sqlserver-se` \|
447
+ # `sqlserver-ex` \| `sqlserver-web` \| `postgres` \| `aurora`
448
+ #
449
+ # Not every database engine is available for every AWS region.
450
+ # @option options [String] :master_username
451
+ # The name of master user for the client DB instance.
452
+ #
453
+ # **MySQL**
454
+ #
455
+ # Constraints:
456
+ #
457
+ # * Must be 1 to 16 alphanumeric characters.
458
+ #
459
+ # * First character must be a letter.
460
+ #
461
+ # * Cannot be a reserved word for the chosen database engine.
462
+ #
463
+ # **MariaDB**
464
+ #
465
+ # Constraints:
466
+ #
467
+ # * Must be 1 to 16 alphanumeric characters.
468
+ #
469
+ # * Cannot be a reserved word for the chosen database engine.
470
+ #
471
+ # Type: String
472
+ #
473
+ # **Oracle**
474
+ #
475
+ # Constraints:
476
+ #
477
+ # * Must be 1 to 30 alphanumeric characters.
478
+ #
479
+ # * First character must be a letter.
480
+ #
481
+ # * Cannot be a reserved word for the chosen database engine.
482
+ #
483
+ # **SQL Server**
484
+ #
485
+ # Constraints:
486
+ #
487
+ # * Must be 1 to 128 alphanumeric characters.
488
+ #
489
+ # * First character must be a letter.
490
+ #
491
+ # * Cannot be a reserved word for the chosen database engine.
492
+ #
493
+ # **PostgreSQL**
494
+ #
495
+ # Constraints:
496
+ #
497
+ # * Must be 1 to 63 alphanumeric characters.
498
+ #
499
+ # * First character must be a letter.
500
+ #
501
+ # * Cannot be a reserved word for the chosen database engine.
502
+ # @option options [String] :master_user_password
503
+ # The password for the master database user. Can be any printable ASCII
504
+ # character except "/", """, or "@".
505
+ #
506
+ # Type: String
507
+ #
508
+ # **MySQL**
509
+ #
510
+ # Constraints: Must contain from 8 to 41 characters.
511
+ #
512
+ # **MariaDB**
513
+ #
514
+ # Constraints: Must contain from 8 to 41 characters.
515
+ #
516
+ # **Oracle**
517
+ #
518
+ # Constraints: Must contain from 8 to 30 characters.
519
+ #
520
+ # **SQL Server**
521
+ #
522
+ # Constraints: Must contain from 8 to 128 characters.
523
+ #
524
+ # **PostgreSQL**
525
+ #
526
+ # Constraints: Must contain from 8 to 128 characters.
527
+ #
528
+ # **Amazon Aurora**
529
+ #
530
+ # Constraints: Must contain from 8 to 41 characters.
531
+ # @option options [Array<String>] :db_security_groups
532
+ # A list of DB security groups to associate with this DB instance.
533
+ #
534
+ # Default: The default DB security group for the database engine.
535
+ # @option options [Array<String>] :vpc_security_group_ids
536
+ # A list of EC2 VPC security groups to associate with this DB instance.
537
+ #
538
+ # Default: The default EC2 VPC security group for the DB subnet group's
539
+ # VPC.
540
+ # @option options [String] :availability_zone
541
+ # The EC2 Availability Zone that the database instance will be created
542
+ # in. For information on regions and Availability Zones, see [Regions
543
+ # and Availability Zones][1].
544
+ #
545
+ # Default: A random, system-chosen Availability Zone in the endpoint's
546
+ # region.
547
+ #
548
+ # Example: `us-east-1d`
549
+ #
550
+ # Constraint: The AvailabilityZone parameter cannot be specified if the
551
+ # MultiAZ parameter is set to `true`. The specified Availability Zone
552
+ # must be in the same region as the current endpoint.
553
+ #
554
+ #
555
+ #
556
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
557
+ # @option options [String] :db_subnet_group_name
558
+ # A DB subnet group to associate with this DB instance.
559
+ #
560
+ # If there is no DB subnet group, then it is a non-VPC DB instance.
561
+ # @option options [String] :preferred_maintenance_window
562
+ # The weekly time range during which system maintenance can occur, in
563
+ # Universal Coordinated Time (UTC). For more information, see [DB
564
+ # Instance Maintenance][1].
565
+ #
566
+ # Format: `ddd:hh24:mi-ddd:hh24:mi`
567
+ #
568
+ # Default: A 30-minute window selected at random from an 8-hour block of
569
+ # time per region, occurring on a random day of the week. To see the
570
+ # time blocks available, see [ Adjusting the Preferred Maintenance
571
+ # Window][2] in the *Amazon RDS User Guide.*
572
+ #
573
+ # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
574
+ #
575
+ # Constraints: Minimum 30-minute window.
576
+ #
577
+ #
578
+ #
579
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance.html
580
+ # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
581
+ # @option options [String] :db_parameter_group_name
582
+ # The name of the DB parameter group to associate with this DB instance.
583
+ # If this argument is omitted, the default DBParameterGroup for the
584
+ # specified engine will be used.
585
+ #
586
+ # Constraints:
587
+ #
588
+ # * Must be 1 to 255 alphanumeric characters
589
+ #
590
+ # * First character must be a letter
591
+ #
592
+ # * Cannot end with a hyphen or contain two consecutive hyphens
593
+ # @option options [Integer] :backup_retention_period
594
+ # The number of days for which automated backups are retained. Setting
595
+ # this parameter to a positive number enables backups. Setting this
596
+ # parameter to 0 disables automated backups.
597
+ #
598
+ # Default: 1
599
+ #
600
+ # Constraints:
601
+ #
602
+ # * Must be a value from 0 to 35
603
+ #
604
+ # * Cannot be set to 0 if the DB instance is a source to Read Replicas
605
+ # @option options [String] :preferred_backup_window
606
+ # The daily time range during which automated backups are created if
607
+ # automated backups are enabled, using the `BackupRetentionPeriod`
608
+ # parameter. For more information, see [DB Instance Backups][1].
609
+ #
610
+ # Default: A 30-minute window selected at random from an 8-hour block of
611
+ # time per region. To see the time blocks available, see [ Adjusting the
612
+ # Preferred Maintenance Window][2] in the *Amazon RDS User Guide.*
613
+ #
614
+ # Constraints:
615
+ #
616
+ # * Must be in the format `hh24:mi-hh24:mi`.
617
+ #
618
+ # * Times should be in Universal Coordinated Time (UTC).
619
+ #
620
+ # * Must not conflict with the preferred maintenance window.
621
+ #
622
+ # * Must be at least 30 minutes.
623
+ #
624
+ #
625
+ #
626
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.BackingUpAndRestoringAmazonRDSInstances.html
627
+ # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
628
+ # @option options [Integer] :port
629
+ # The port number on which the database accepts connections.
630
+ #
631
+ # **MySQL**
632
+ #
633
+ # Default: `3306`
634
+ #
635
+ # Valid Values: `1150-65535`
636
+ #
637
+ # Type: Integer
638
+ #
639
+ # **MariaDB**
640
+ #
641
+ # Default: `3306`
642
+ #
643
+ # Valid Values: `1150-65535`
644
+ #
645
+ # Type: Integer
646
+ #
647
+ # **PostgreSQL**
648
+ #
649
+ # Default: `5432`
650
+ #
651
+ # Valid Values: `1150-65535`
652
+ #
653
+ # Type: Integer
654
+ #
655
+ # **Oracle**
656
+ #
657
+ # Default: `1521`
658
+ #
659
+ # Valid Values: `1150-65535`
660
+ #
661
+ # **SQL Server**
662
+ #
663
+ # Default: `1433`
664
+ #
665
+ # Valid Values: `1150-65535` except for `1434`, `3389`, `47001`,
666
+ # `49152`, and `49152` through `49156`.
667
+ #
668
+ # **Amazon Aurora**
669
+ #
670
+ # Default: `3306`
671
+ #
672
+ # Valid Values: `1150-65535`
673
+ #
674
+ # Type: Integer
675
+ # @option options [Boolean] :multi_az
676
+ # Specifies if the DB instance is a Multi-AZ deployment. You cannot set
677
+ # the AvailabilityZone parameter if the MultiAZ parameter is set to
678
+ # true.
679
+ # @option options [String] :engine_version
680
+ # The version number of the database engine to use.
681
+ #
682
+ # The following are the database engines and major and minor versions
683
+ # that are available with Amazon RDS. Not every database engine is
684
+ # available for every AWS region.
685
+ #
686
+ # **Amazon Aurora**
687
+ #
688
+ # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
689
+ # ap-northeast-2, ap-south-1, ap-southeast-2, eu-west-1, us-east-1,
690
+ # us-east-2, us-west-2):** ` 5.6.10a`
691
+ #
692
+ # ^
693
+ #
694
+ # **MariaDB**
695
+ #
696
+ # * **Version 10.1 (available in these AWS regions: us-east-2):** `
697
+ # 10.1.16`
698
+ #
699
+ # * **Version 10.1 (available in these AWS regions: ap-northeast-1,
700
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
701
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1,
702
+ # us-west-2):** ` 10.1.14`
703
+ #
704
+ # * **Version 10.0 (available in all AWS regions):** ` 10.0.24`
705
+ #
706
+ # * **Version 10.0 (available in these AWS regions: ap-northeast-1,
707
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
708
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
709
+ # us-west-1, us-west-2):** ` 10.0.17`
710
+ #
711
+ # **Microsoft SQL Server 2016**
712
+ #
713
+ # * `13.00.2164.0.v1` (supported for all editions, and all AWS regions
714
+ # except sa-east-1)
715
+ #
716
+ # ^
717
+ #
718
+ # **Microsoft SQL Server 2014**
719
+ #
720
+ # * `12.00.5000.0.v1` (supported for all editions, and all AWS regions)
721
+ #
722
+ # * `12.00.4422.0.v1` (supported for all editions except Enterprise
723
+ # Edition, and all AWS regions except us-east-2)
724
+ #
725
+ # **Microsoft SQL Server 2012**
726
+ #
727
+ # * `11.00.6020.0.v1` (supported for all editions, and all AWS regions)
728
+ #
729
+ # * `11.00.5058.0.v1` (supported for all editions, and all AWS regions
730
+ # except us-east-2)
731
+ #
732
+ # * `11.00.2100.60.v1` (supported for all editions, and all AWS regions
733
+ # except us-east-2)
734
+ #
735
+ # **Microsoft SQL Server 2008 R2**
736
+ #
737
+ # * `10.50.6529.0.v1` (supported for all editions, and all AWS regions
738
+ # except us-east-2)
739
+ #
740
+ # * `10.50.6000.34.v1` (supported for all editions, and all AWS regions
741
+ # except us-east-2)
742
+ #
743
+ # * `10.50.2789.0.v1` (supported for all editions, and all AWS regions
744
+ # except us-east-2)
745
+ #
746
+ # **MySQL**
747
+ #
748
+ # * **Version 5.7 (available in all AWS regions):** ` 5.7.11`
749
+ #
750
+ # * **Version 5.7 (available in these AWS regions: ap-northeast-1,
751
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
752
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
753
+ # us-west-1, us-west-2):** ` 5.7.10`
754
+ #
755
+ # * **Version 5.6 (available in all AWS regions):** ` 5.6.29`
756
+ #
757
+ # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
758
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
759
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
760
+ # us-west-1, us-west-2):** ` 5.6.27`
761
+ #
762
+ # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
763
+ # ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1,
764
+ # eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1,
765
+ # us-west-2):** ` 5.6.23`
766
+ #
767
+ # * **Version 5.6 (available in these AWS regions: ap-northeast-1,
768
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
769
+ # us-east-1, us-gov-west-1, us-west-1, us-west-2):** ` 5.6.19a |
770
+ # 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22`
771
+ #
772
+ # * **Version 5.5 (available in all AWS regions):** ` 5.5.46`
773
+ #
774
+ # * **Version 5.1 (only available in AWS regions ap-northeast-1,
775
+ # ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1,
776
+ # us-gov-west-1, us-west-1, us-west-2):** ` 5.1.73a | 5.1.73b`
777
+ #
778
+ # **Oracle Database Enterprise Edition (oracle-ee)**
779
+ #
780
+ # * **Version 12.1 (available in all AWS regions except ap-south-1,
781
+ # ap-northeast-2):** ` 12.1.0.1.v1 | 12.1.0.1.v2`
782
+ #
783
+ # * **Version 12.1 (only available in AWS regions ap-northeast-1,
784
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
785
+ # us-east-1, us-west-1, us-west-2):** ` 12.1.0.1.v3 | 12.1.0.1.v4 |
786
+ # 12.1.0.1.v5`
787
+ #
788
+ # * **Version 12.1 (available in all AWS regions):** ` 12.1.0.2.v1`
789
+ #
790
+ # * **Version 12.1 (available in all AWS regions except
791
+ # us-gov-west-1):** ` 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4`
792
+ #
793
+ # * **Version 11.2 (only available in AWS regions ap-northeast-1,
794
+ # ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1,
795
+ # us-gov-west-1, us-west-1, us-west-2):** ` 11.2.0.2.v3 | 11.2.0.2.v4
796
+ # | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7`
797
+ #
798
+ # * **Version 11.2 (available in all AWS regions except ap-south-1,
799
+ # ap-northeast-2):** ` 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3`
800
+ #
801
+ # * **Version 11.2 (only available in AWS regions ap-northeast-1,
802
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
803
+ # us-east-1, us-west-1, us-west-2):** ` 11.2.0.3.v4`
804
+ #
805
+ # * **Version 11.2 (available in all AWS regions):** ` 11.2.0.4.v1 |
806
+ # 11.2.0.4.v3 | 11.2.0.4.v4`
807
+ #
808
+ # * **Version 11.2 (available in all AWS regions except
809
+ # us-gov-west-1):** ` 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 |
810
+ # 11.2.0.4.v8`
811
+ #
812
+ # **Oracle Database Standard Edition (oracle-se)**
813
+ #
814
+ # * **Version 12.1 (available in all AWS regions except ap-south-1,
815
+ # ap-northeast-2):** ` 12.1.0.1.v1 | 12.1.0.1.v2`
816
+ #
817
+ # * **Version 12.1 (only available in AWS regions ap-northeast-1,
818
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
819
+ # us-east-1, us-west-1, us-west-2):** ` 12.1.0.1.v3 | 12.1.0.1.v4 |
820
+ # 12.1.0.1.v5`
821
+ #
822
+ # * **Version 11.2 (only available in AWS regions ap-northeast-1,
823
+ # ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1,
824
+ # us-gov-west-1, us-west-1, us-west-2):** ` 11.2.0.2.v3 | 11.2.0.2.v4
825
+ # | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7`
826
+ #
827
+ # * **Version 11.2 (available in all AWS regions except ap-south-1,
828
+ # ap-northeast-2):** ` 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3`
829
+ #
830
+ # * **Version 11.2 (only available in AWS regions ap-northeast-1,
831
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
832
+ # us-east-1, us-west-1, us-west-2):** ` 11.2.0.3.v4`
833
+ #
834
+ # * **Version 11.2 (available in all AWS regions):** ` 11.2.0.4.v1 |
835
+ # 11.2.0.4.v3 | 11.2.0.4.v4`
836
+ #
837
+ # * **Version 11.2 (available in all AWS regions except
838
+ # us-gov-west-1):** ` 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 |
839
+ # 11.2.0.4.v8`
840
+ #
841
+ # **Oracle Database Standard Edition One (oracle-se1)**
842
+ #
843
+ # * **Version 12.1 (available in all AWS regions except ap-south-1,
844
+ # ap-northeast-2):** ` 12.1.0.1.v1 | 12.1.0.1.v2`
845
+ #
846
+ # * **Version 12.1 (only available in AWS regions ap-northeast-1,
847
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
848
+ # us-east-1, us-west-1, us-west-2):** ` 12.1.0.1.v3 | 12.1.0.1.v4 |
849
+ # 12.1.0.1.v5`
850
+ #
851
+ # * **Version 11.2 (only available in AWS regions ap-northeast-1,
852
+ # ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1,
853
+ # us-gov-west-1, us-west-1, us-west-2):** ` 11.2.0.2.v3 | 11.2.0.2.v4
854
+ # | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7`
855
+ #
856
+ # * **Version 11.2 (available in all AWS regions except ap-south-1,
857
+ # ap-northeast-2):** ` 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3`
858
+ #
859
+ # * **Version 11.2 (only available in AWS regions ap-northeast-1,
860
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
861
+ # us-east-1, us-west-1, us-west-2):** ` 11.2.0.3.v4`
862
+ #
863
+ # * **Version 11.2 (available in all AWS regions):** ` 11.2.0.4.v1 |
864
+ # 11.2.0.4.v3 | 11.2.0.4.v4`
865
+ #
866
+ # * **Version 11.2 (available in all AWS regions except
867
+ # us-gov-west-1):** ` 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 |
868
+ # 11.2.0.4.v8`
869
+ #
870
+ # **Oracle Database Standard Edition Two (oracle-se2)**
871
+ #
872
+ # * **Version 12.1 (available in all AWS regions except
873
+ # us-gov-west-1):** ` 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4`
874
+ #
875
+ # ^
876
+ #
877
+ # **PostgreSQL**
878
+ #
879
+ # * **Version 9.6:** ` 9.6.1`
880
+ #
881
+ # * **Version 9.5:** `9.5.4 | 9.5.2`
882
+ #
883
+ # * **Version 9.4:** ` 9.4.9 | 9.4.7 | 9.4.5 | 9.4.4 | 9.4.1`
884
+ #
885
+ # * **Version 9.3:** ` 9.3.14 | 9.3.12 | 9.3.10 | 9.3.9 | 9.3.6 | 9.3.5
886
+ # | 9.3.3 | 9.3.2 | 9.3.1`
887
+ #
888
+ #
889
+ #
890
+ # **Oracle 12c**
891
+ #
892
+ # * `12.1.0.2.v6` (supported for EE in all AWS regions, and SE2 in all
893
+ # AWS regions except us-gov-west-1)
894
+ #
895
+ # * `12.1.0.2.v5` (supported for EE in all AWS regions, and SE2 in all
896
+ # AWS regions except us-gov-west-1)
897
+ #
898
+ # * `12.1.0.2.v4` (supported for EE in all AWS regions, and SE2 in all
899
+ # AWS regions except us-gov-west-1)
900
+ #
901
+ # * `12.1.0.2.v3` (supported for EE in all AWS regions, and SE2 in all
902
+ # AWS regions except us-gov-west-1)
903
+ #
904
+ # * `12.1.0.2.v2` (supported for EE in all AWS regions, and SE2 in all
905
+ # AWS regions except us-gov-west-1)
906
+ #
907
+ # * `12.1.0.2.v1` (supported for EE in all AWS regions, and SE2 in all
908
+ # AWS regions except us-gov-west-1)
909
+ #
910
+ #
911
+ #
912
+ # * `12.1.0.1.v6` (supported for EE, SE1, and SE, in all AWS regions
913
+ # except ap-south-1, ap-northeast-2)
914
+ #
915
+ # * `12.1.0.1.v5` (supported for EE, SE1, and SE, in all AWS regions
916
+ # except ap-south-1, ap-northeast-2)
917
+ #
918
+ # * `12.1.0.1.v4` (supported for EE, SE1, and SE, in all AWS regions
919
+ # except ap-south-1, ap-northeast-2)
920
+ #
921
+ # * `12.1.0.1.v3` (supported for EE, SE1, and SE, in all AWS regions
922
+ # except ap-south-1, ap-northeast-2)
923
+ #
924
+ # * `12.1.0.1.v2` (supported for EE, SE1, and SE, in all AWS regions
925
+ # except ap-south-1, ap-northeast-2)
926
+ #
927
+ # * `12.1.0.1.v1` (supported for EE, SE1, and SE, in all AWS regions
928
+ # except ap-south-1, ap-northeast-2)
929
+ #
930
+ # **Oracle 11g**
931
+ #
932
+ # * `11.2.0.4.v10` (supported for EE, SE1, and SE, in all AWS regions)
933
+ #
934
+ # * `11.2.0.4.v9` (supported for EE, SE1, and SE, in all AWS regions)
935
+ #
936
+ # * `11.2.0.4.v8` (supported for EE, SE1, and SE, in all AWS regions)
937
+ #
938
+ # * `11.2.0.4.v7` (supported for EE, SE1, and SE, in all AWS regions)
939
+ #
940
+ # * `11.2.0.4.v6` (supported for EE, SE1, and SE, in all AWS regions)
941
+ #
942
+ # * `11.2.0.4.v5` (supported for EE, SE1, and SE, in all AWS regions)
943
+ #
944
+ # * `11.2.0.4.v4` (supported for EE, SE1, and SE, in all AWS regions)
945
+ #
946
+ # * `11.2.0.4.v3` (supported for EE, SE1, and SE, in all AWS regions)
947
+ #
948
+ # * `11.2.0.4.v1` (supported for EE, SE1, and SE, in all AWS regions)
949
+ #
950
+ # **PostgreSQL**
951
+ #
952
+ # * **Version 9.5 (available in these AWS regions: ap-northeast-1,
953
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
954
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1,
955
+ # us-west-2):** ` 9.5.4`
956
+ #
957
+ # * **Version 9.5 (available in these AWS regions: ap-northeast-1,
958
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
959
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1,
960
+ # us-west-2):** ` 9.5.2`
961
+ #
962
+ # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
963
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
964
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1,
965
+ # us-west-2):** ` 9.4.9`
966
+ #
967
+ # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
968
+ # ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
969
+ # eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1,
970
+ # us-west-2):** ` 9.4.7`
971
+ #
972
+ # * **Version 9.4 (available in all AWS regions):** ` 9.4.5`
973
+ #
974
+ # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
975
+ # ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1,
976
+ # eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1,
977
+ # us-west-2):** ` 9.4.4`
978
+ #
979
+ # * **Version 9.4 (available in these AWS regions: ap-northeast-1,
980
+ # ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1,
981
+ # eu-west-1, sa-east-1, us-east-1, us-east-2, us-gov-west-1,
982
+ # us-west-1, us-west-2):** ` 9.4.1`
983
+ #
984
+ # * **Version 9.3 (available in these AWS regions: ap-northeast-1,
985
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
986
+ # us-east-1, us-gov-west-1, us-west-1, us-west-2):** ` 9.3.10 | 9.3.3
987
+ # | 9.3.5 | 9.3.6 | 9.3.9`
988
+ #
989
+ # * **Version 9.3 (available in these AWS regions: ap-northeast-1,
990
+ # ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1,
991
+ # us-gov-west-1, us-west-1, us-west-2):** ` 9.3.1 | 9.3.2`
992
+ #
993
+ # * **Version 9.3 (available in these AWS regions: ap-northeast-1,
994
+ # ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1,
995
+ # us-east-1, us-west-1, us-west-2):** ` 9.3.12 | 9.3.14`
996
+ # @option options [Boolean] :auto_minor_version_upgrade
997
+ # Indicates that minor engine upgrades will be applied automatically to
998
+ # the DB instance during the maintenance window.
999
+ #
1000
+ # Default: `true`
1001
+ # @option options [String] :license_model
1002
+ # License model information for this DB instance.
1003
+ #
1004
+ # Valid values: `license-included` \| `bring-your-own-license` \|
1005
+ # `general-public-license`
1006
+ # @option options [Integer] :iops
1007
+ # The amount of Provisioned IOPS (input/output operations per second) to
1008
+ # be initially allocated for the DB instance.
1009
+ #
1010
+ # Constraints: Must be a multiple between 3 and 10 of the storage amount
1011
+ # for the DB instance. Must also be an integer multiple of 1000. For
1012
+ # example, if the size of your DB instance is 500 GB, then your `Iops`
1013
+ # value can be 2000, 3000, 4000, or 5000.
1014
+ # @option options [String] :option_group_name
1015
+ # Indicates that the DB instance should be associated with the specified
1016
+ # option group.
1017
+ #
1018
+ # Permanent options, such as the TDE option for Oracle Advanced Security
1019
+ # TDE, cannot be removed from an option group, and that option group
1020
+ # cannot be removed from a DB instance once it is associated with a DB
1021
+ # instance
1022
+ # @option options [String] :character_set_name
1023
+ # For supported engines, indicates that the DB instance should be
1024
+ # associated with the specified CharacterSet.
1025
+ # @option options [Boolean] :publicly_accessible
1026
+ # Specifies the accessibility options for the DB instance. A value of
1027
+ # true specifies an Internet-facing instance with a publicly resolvable
1028
+ # DNS name, which resolves to a public IP address. A value of false
1029
+ # specifies an internal instance with a DNS name that resolves to a
1030
+ # private IP address.
1031
+ #
1032
+ # Default: The default behavior varies depending on whether a VPC has
1033
+ # been requested or not. The following list shows the default behavior
1034
+ # in each case.
1035
+ #
1036
+ # * **Default VPC:** true
1037
+ #
1038
+ # * **VPC:** false
1039
+ #
1040
+ # If no DB subnet group has been specified as part of the request and
1041
+ # the PubliclyAccessible value has not been set, the DB instance will be
1042
+ # publicly accessible. If a specific DB subnet group has been specified
1043
+ # as part of the request and the PubliclyAccessible value has not been
1044
+ # set, the DB instance will be private.
1045
+ # @option options [Array<Types::Tag>] :tags
1046
+ # A list of tags.
1047
+ # @option options [String] :db_cluster_identifier
1048
+ # The identifier of the DB cluster that the instance will belong to.
1049
+ #
1050
+ # For information on creating a DB cluster, see CreateDBCluster.
1051
+ #
1052
+ # Type: String
1053
+ # @option options [String] :storage_type
1054
+ # Specifies the storage type to be associated with the DB instance.
1055
+ #
1056
+ # Valid values: `standard | gp2 | io1`
1057
+ #
1058
+ # If you specify `io1`, you must also include a value for the `Iops`
1059
+ # parameter.
1060
+ #
1061
+ # Default: `io1` if the `Iops` parameter is specified; otherwise
1062
+ # `standard`
1063
+ # @option options [String] :tde_credential_arn
1064
+ # The ARN from the Key Store with which to associate the instance for
1065
+ # TDE encryption.
1066
+ # @option options [String] :tde_credential_password
1067
+ # The password for the given ARN from the Key Store in order to access
1068
+ # the device.
1069
+ # @option options [Boolean] :storage_encrypted
1070
+ # Specifies whether the DB instance is encrypted.
1071
+ #
1072
+ # Default: false
1073
+ # @option options [String] :kms_key_id
1074
+ # The KMS key identifier for an encrypted DB instance.
1075
+ #
1076
+ # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
1077
+ # encryption key. If you are creating a DB instance with the same AWS
1078
+ # account that owns the KMS encryption key used to encrypt the new DB
1079
+ # instance, then you can use the KMS key alias instead of the ARN for
1080
+ # the KM encryption key.
1081
+ #
1082
+ # If the `StorageEncrypted` parameter is true, and you do not specify a
1083
+ # value for the `KmsKeyId` parameter, then Amazon RDS will use your
1084
+ # default encryption key. AWS KMS creates the default encryption key for
1085
+ # your AWS account. Your AWS account has a different default encryption
1086
+ # key for each AWS region.
1087
+ # @option options [String] :domain
1088
+ # Specify the Active Directory Domain to create the instance in.
1089
+ # @option options [Boolean] :copy_tags_to_snapshot
1090
+ # True to copy all tags from the DB instance to snapshots of the DB
1091
+ # instance; otherwise false. The default is false.
1092
+ # @option options [Integer] :monitoring_interval
1093
+ # The interval, in seconds, between points when Enhanced Monitoring
1094
+ # metrics are collected for the DB instance. To disable collecting
1095
+ # Enhanced Monitoring metrics, specify 0. The default is 0.
1096
+ #
1097
+ # If `MonitoringRoleArn` is specified, then you must also set
1098
+ # `MonitoringInterval` to a value other than 0.
1099
+ #
1100
+ # Valid Values: `0, 1, 5, 10, 15, 30, 60`
1101
+ # @option options [String] :monitoring_role_arn
1102
+ # The ARN for the IAM role that permits RDS to send enhanced monitoring
1103
+ # metrics to CloudWatch Logs. For example,
1104
+ # `arn:aws:iam:123456789012:role/emaccess`. For information on creating
1105
+ # a monitoring role, go to [To create an IAM role for Amazon RDS
1106
+ # Enhanced Monitoring][1].
1107
+ #
1108
+ # If `MonitoringInterval` is set to a value other than 0, then you must
1109
+ # supply a `MonitoringRoleArn` value.
1110
+ #
1111
+ #
1112
+ #
1113
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
1114
+ # @option options [String] :domain_iam_role_name
1115
+ # Specify the name of the IAM role to be used when making API calls to
1116
+ # the Directory Service.
1117
+ # @option options [Integer] :promotion_tier
1118
+ # A value that specifies the order in which an Aurora Replica is
1119
+ # promoted to the primary instance after a failure of the existing
1120
+ # primary instance. For more information, see [ Fault Tolerance for an
1121
+ # Aurora DB Cluster][1].
1122
+ #
1123
+ # Default: 1
1124
+ #
1125
+ # Valid Values: 0 - 15
1126
+ #
1127
+ #
1128
+ #
1129
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance
1130
+ # @option options [String] :timezone
1131
+ # The time zone of the DB instance. The time zone parameter is currently
1132
+ # supported only by [Microsoft SQL Server][1].
1133
+ #
1134
+ #
1135
+ #
1136
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
1137
+ # @return [DBInstance]
1138
+ def create_db_instance(options = {})
1139
+ resp = @client.create_db_instance(options)
1140
+ DBInstance.new(
1141
+ id: resp.data.db_instance.db_instance_identifier,
1142
+ data: resp.data.db_instance,
1143
+ client: @client
1144
+ )
1145
+ end
1041
1146
 
1042
- # @example Request syntax with placeholder values
1043
- #
1044
- # dbparametergroup = rds.create_db_parameter_group({
1045
- # db_parameter_group_name: "String", # required
1046
- # db_parameter_group_family: "String", # required
1047
- # description: "String", # required
1048
- # tags: [
1049
- # {
1050
- # key: "String",
1051
- # value: "String",
1052
- # },
1053
- # ],
1054
- # })
1055
- # @param [Hash] options ({})
1056
- # @option options [required, String] :db_parameter_group_name
1057
- # The name of the DB parameter group.
1058
- #
1059
- # Constraints:
1060
- #
1061
- # * Must be 1 to 255 alphanumeric characters
1062
- #
1063
- # * First character must be a letter
1064
- #
1065
- # * Cannot end with a hyphen or contain two consecutive hyphens
1066
- #
1067
- # <note markdown="1"> This value is stored as a lowercase string.
1068
- #
1069
- # </note>
1070
- # @option options [required, String] :db_parameter_group_family
1071
- # The DB parameter group family name. A DB parameter group can be
1072
- # associated with one and only one DB parameter group family, and can be
1073
- # applied only to a DB instance running a database engine and engine
1074
- # version compatible with that DB parameter group family.
1075
- # @option options [required, String] :description
1076
- # The description for the DB parameter group.
1077
- # @option options [Array<Types::Tag>] :tags
1078
- # A list of tags.
1079
- # @return [DBParameterGroup]
1080
- def create_db_parameter_group(options = {})
1081
- resp = @client.create_db_parameter_group(options)
1082
- DBParameterGroup.new(
1083
- name: resp.data.db_parameter_group.db_parameter_group_name,
1084
- data: resp.data.db_parameter_group,
1085
- client: @client
1086
- )
1087
- end
1147
+ # @example Request syntax with placeholder values
1148
+ #
1149
+ # dbparametergroup = rds.create_db_parameter_group({
1150
+ # db_parameter_group_name: "String", # required
1151
+ # db_parameter_group_family: "String", # required
1152
+ # description: "String", # required
1153
+ # tags: [
1154
+ # {
1155
+ # key: "String",
1156
+ # value: "String",
1157
+ # },
1158
+ # ],
1159
+ # })
1160
+ # @param [Hash] options ({})
1161
+ # @option options [required, String] :db_parameter_group_name
1162
+ # The name of the DB parameter group.
1163
+ #
1164
+ # Constraints:
1165
+ #
1166
+ # * Must be 1 to 255 alphanumeric characters
1167
+ #
1168
+ # * First character must be a letter
1169
+ #
1170
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1171
+ #
1172
+ # <note markdown="1"> This value is stored as a lowercase string.
1173
+ #
1174
+ # </note>
1175
+ # @option options [required, String] :db_parameter_group_family
1176
+ # The DB parameter group family name. A DB parameter group can be
1177
+ # associated with one and only one DB parameter group family, and can be
1178
+ # applied only to a DB instance running a database engine and engine
1179
+ # version compatible with that DB parameter group family.
1180
+ # @option options [required, String] :description
1181
+ # The description for the DB parameter group.
1182
+ # @option options [Array<Types::Tag>] :tags
1183
+ # A list of tags.
1184
+ # @return [DBParameterGroup]
1185
+ def create_db_parameter_group(options = {})
1186
+ resp = @client.create_db_parameter_group(options)
1187
+ DBParameterGroup.new(
1188
+ name: resp.data.db_parameter_group.db_parameter_group_name,
1189
+ data: resp.data.db_parameter_group,
1190
+ client: @client
1191
+ )
1192
+ end
1193
+
1194
+ # @example Request syntax with placeholder values
1195
+ #
1196
+ # dbsecuritygroup = rds.create_db_security_group({
1197
+ # db_security_group_name: "String", # required
1198
+ # db_security_group_description: "String", # required
1199
+ # tags: [
1200
+ # {
1201
+ # key: "String",
1202
+ # value: "String",
1203
+ # },
1204
+ # ],
1205
+ # })
1206
+ # @param [Hash] options ({})
1207
+ # @option options [required, String] :db_security_group_name
1208
+ # The name for the DB security group. This value is stored as a
1209
+ # lowercase string.
1210
+ #
1211
+ # Constraints:
1212
+ #
1213
+ # * Must be 1 to 255 alphanumeric characters
1214
+ #
1215
+ # * First character must be a letter
1216
+ #
1217
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1218
+ #
1219
+ # * Must not be "Default"
1220
+ #
1221
+ # Example: `mysecuritygroup`
1222
+ # @option options [required, String] :db_security_group_description
1223
+ # The description for the DB security group.
1224
+ # @option options [Array<Types::Tag>] :tags
1225
+ # A list of tags.
1226
+ # @return [DBSecurityGroup]
1227
+ def create_db_security_group(options = {})
1228
+ resp = @client.create_db_security_group(options)
1229
+ DBSecurityGroup.new(
1230
+ name: resp.data.db_security_group.db_security_group_name,
1231
+ data: resp.data.db_security_group,
1232
+ client: @client
1233
+ )
1234
+ end
1235
+
1236
+ # @example Request syntax with placeholder values
1237
+ #
1238
+ # dbsubnetgroup = rds.create_db_subnet_group({
1239
+ # db_subnet_group_name: "String", # required
1240
+ # db_subnet_group_description: "String", # required
1241
+ # subnet_ids: ["String"], # required
1242
+ # tags: [
1243
+ # {
1244
+ # key: "String",
1245
+ # value: "String",
1246
+ # },
1247
+ # ],
1248
+ # })
1249
+ # @param [Hash] options ({})
1250
+ # @option options [required, String] :db_subnet_group_name
1251
+ # The name for the DB subnet group. This value is stored as a lowercase
1252
+ # string.
1253
+ #
1254
+ # Constraints: Must contain no more than 255 alphanumeric characters,
1255
+ # periods, underscores, spaces, or hyphens. Must not be default.
1256
+ #
1257
+ # Example: `mySubnetgroup`
1258
+ # @option options [required, String] :db_subnet_group_description
1259
+ # The description for the DB subnet group.
1260
+ # @option options [required, Array<String>] :subnet_ids
1261
+ # The EC2 Subnet IDs for the DB subnet group.
1262
+ # @option options [Array<Types::Tag>] :tags
1263
+ # A list of tags.
1264
+ # @return [DBSubnetGroup]
1265
+ def create_db_subnet_group(options = {})
1266
+ resp = @client.create_db_subnet_group(options)
1267
+ DBSubnetGroup.new(
1268
+ name: resp.data.db_subnet_group.db_subnet_group_name,
1269
+ data: resp.data.db_subnet_group,
1270
+ client: @client
1271
+ )
1272
+ end
1273
+
1274
+ # @example Request syntax with placeholder values
1275
+ #
1276
+ # eventsubscription = rds.create_event_subscription({
1277
+ # subscription_name: "String", # required
1278
+ # sns_topic_arn: "String", # required
1279
+ # source_type: "String",
1280
+ # event_categories: ["String"],
1281
+ # source_ids: ["String"],
1282
+ # enabled: false,
1283
+ # tags: [
1284
+ # {
1285
+ # key: "String",
1286
+ # value: "String",
1287
+ # },
1288
+ # ],
1289
+ # })
1290
+ # @param [Hash] options ({})
1291
+ # @option options [required, String] :subscription_name
1292
+ # The name of the subscription.
1293
+ #
1294
+ # Constraints: The name must be less than 255 characters.
1295
+ # @option options [required, String] :sns_topic_arn
1296
+ # The Amazon Resource Name (ARN) of the SNS topic created for event
1297
+ # notification. The ARN is created by Amazon SNS when you create a topic
1298
+ # and subscribe to it.
1299
+ # @option options [String] :source_type
1300
+ # The type of source that will be generating the events. For example, if
1301
+ # you want to be notified of events generated by a DB instance, you
1302
+ # would set this parameter to db-instance. if this value is not
1303
+ # specified, all events are returned.
1304
+ #
1305
+ # Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
1306
+ # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
1307
+ # @option options [Array<String>] :event_categories
1308
+ # A list of event categories for a SourceType that you want to subscribe
1309
+ # to. You can see a list of the categories for a given SourceType in the
1310
+ # [Events][1] topic in the Amazon RDS User Guide or by using the
1311
+ # **DescribeEventCategories** action.
1312
+ #
1313
+ #
1314
+ #
1315
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
1316
+ # @option options [Array<String>] :source_ids
1317
+ # The list of identifiers of the event sources for which events will be
1318
+ # returned. If not specified, then all sources are included in the
1319
+ # response. An identifier must begin with a letter and must contain only
1320
+ # ASCII letters, digits, and hyphens; it cannot end with a hyphen or
1321
+ # contain two consecutive hyphens.
1322
+ #
1323
+ # Constraints:
1324
+ #
1325
+ # * If SourceIds are supplied, SourceType must also be provided.
1326
+ #
1327
+ # * If the source type is a DB instance, then a `DBInstanceIdentifier`
1328
+ # must be supplied.
1329
+ #
1330
+ # * If the source type is a DB security group, a `DBSecurityGroupName`
1331
+ # must be supplied.
1332
+ #
1333
+ # * If the source type is a DB parameter group, a `DBParameterGroupName`
1334
+ # must be supplied.
1335
+ #
1336
+ # * If the source type is a DB snapshot, a `DBSnapshotIdentifier` must
1337
+ # be supplied.
1338
+ # @option options [Boolean] :enabled
1339
+ # A Boolean value; set to **true** to activate the subscription, set to
1340
+ # **false** to create the subscription but not active it.
1341
+ # @option options [Array<Types::Tag>] :tags
1342
+ # A list of tags.
1343
+ # @return [EventSubscription]
1344
+ def create_event_subscription(options = {})
1345
+ resp = @client.create_event_subscription(options)
1346
+ EventSubscription.new(
1347
+ name: resp.data.event_subscription.cust_subscription_id,
1348
+ data: resp.data.event_subscription,
1349
+ client: @client
1350
+ )
1351
+ end
1088
1352
 
1089
- # @example Request syntax with placeholder values
1090
- #
1091
- # dbsecuritygroup = rds.create_db_security_group({
1092
- # db_security_group_name: "String", # required
1093
- # db_security_group_description: "String", # required
1094
- # tags: [
1095
- # {
1096
- # key: "String",
1097
- # value: "String",
1098
- # },
1099
- # ],
1100
- # })
1101
- # @param [Hash] options ({})
1102
- # @option options [required, String] :db_security_group_name
1103
- # The name for the DB security group. This value is stored as a
1104
- # lowercase string.
1105
- #
1106
- # Constraints:
1107
- #
1108
- # * Must be 1 to 255 alphanumeric characters
1109
- #
1110
- # * First character must be a letter
1111
- #
1112
- # * Cannot end with a hyphen or contain two consecutive hyphens
1113
- #
1114
- # * Must not be "Default"
1115
- #
1116
- # Example: `mysecuritygroup`
1117
- # @option options [required, String] :db_security_group_description
1118
- # The description for the DB security group.
1119
- # @option options [Array<Types::Tag>] :tags
1120
- # A list of tags.
1121
- # @return [DBSecurityGroup]
1122
- def create_db_security_group(options = {})
1123
- resp = @client.create_db_security_group(options)
1124
- DBSecurityGroup.new(
1125
- name: resp.data.db_security_group.db_security_group_name,
1126
- data: resp.data.db_security_group,
1127
- client: @client
1128
- )
1353
+ # @example Request syntax with placeholder values
1354
+ #
1355
+ # optiongroup = rds.create_option_group({
1356
+ # option_group_name: "String", # required
1357
+ # engine_name: "String", # required
1358
+ # major_engine_version: "String", # required
1359
+ # option_group_description: "String", # required
1360
+ # tags: [
1361
+ # {
1362
+ # key: "String",
1363
+ # value: "String",
1364
+ # },
1365
+ # ],
1366
+ # })
1367
+ # @param [Hash] options ({})
1368
+ # @option options [required, String] :option_group_name
1369
+ # Specifies the name of the option group to be created.
1370
+ #
1371
+ # Constraints:
1372
+ #
1373
+ # * Must be 1 to 255 alphanumeric characters or hyphens
1374
+ #
1375
+ # * First character must be a letter
1376
+ #
1377
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1378
+ #
1379
+ # Example: `myoptiongroup`
1380
+ # @option options [required, String] :engine_name
1381
+ # Specifies the name of the engine that this option group should be
1382
+ # associated with.
1383
+ # @option options [required, String] :major_engine_version
1384
+ # Specifies the major version of the engine that this option group
1385
+ # should be associated with.
1386
+ # @option options [required, String] :option_group_description
1387
+ # The description of the option group.
1388
+ # @option options [Array<Types::Tag>] :tags
1389
+ # A list of tags.
1390
+ # @return [OptionGroup]
1391
+ def create_option_group(options = {})
1392
+ resp = @client.create_option_group(options)
1393
+ OptionGroup.new(
1394
+ name: resp.data.option_group.option_group_name,
1395
+ data: resp.data.option_group,
1396
+ client: @client
1397
+ )
1398
+ end
1399
+
1400
+ # @!group Associations
1401
+
1402
+ # @example Request syntax with placeholder values
1403
+ #
1404
+ # rds.account_quotas()
1405
+ # @param [Hash] options ({})
1406
+ # @return [AccountQuota::Collection]
1407
+ def account_quotas(options = {})
1408
+ batches = Enumerator.new do |y|
1409
+ batch = []
1410
+ resp = @client.describe_account_attributes(options)
1411
+ resp.data.account_quotas.each do |a|
1412
+ batch << AccountQuota.new(
1413
+ name: a.account_quota_name,
1414
+ data: a,
1415
+ client: @client
1416
+ )
1417
+ end
1418
+ y.yield(batch)
1129
1419
  end
1420
+ AccountQuota::Collection.new(batches)
1421
+ end
1130
1422
 
1131
- # @example Request syntax with placeholder values
1132
- #
1133
- # dbsubnetgroup = rds.create_db_subnet_group({
1134
- # db_subnet_group_name: "String", # required
1135
- # db_subnet_group_description: "String", # required
1136
- # subnet_ids: ["String"], # required
1137
- # tags: [
1138
- # {
1139
- # key: "String",
1140
- # value: "String",
1141
- # },
1142
- # ],
1143
- # })
1144
- # @param [Hash] options ({})
1145
- # @option options [required, String] :db_subnet_group_name
1146
- # The name for the DB subnet group. This value is stored as a lowercase
1147
- # string.
1148
- #
1149
- # Constraints: Must contain no more than 255 alphanumeric characters,
1150
- # periods, underscores, spaces, or hyphens. Must not be default.
1151
- #
1152
- # Example: `mySubnetgroup`
1153
- # @option options [required, String] :db_subnet_group_description
1154
- # The description for the DB subnet group.
1155
- # @option options [required, Array<String>] :subnet_ids
1156
- # The EC2 Subnet IDs for the DB subnet group.
1157
- # @option options [Array<Types::Tag>] :tags
1158
- # A list of tags.
1159
- # @return [DBSubnetGroup]
1160
- def create_db_subnet_group(options = {})
1161
- resp = @client.create_db_subnet_group(options)
1162
- DBSubnetGroup.new(
1163
- name: resp.data.db_subnet_group.db_subnet_group_name,
1164
- data: resp.data.db_subnet_group,
1165
- client: @client
1166
- )
1423
+ # @param [String] id
1424
+ # @return [Certificate]
1425
+ def certificate(id)
1426
+ Certificate.new(
1427
+ id: id,
1428
+ client: @client
1429
+ )
1430
+ end
1431
+
1432
+ # @example Request syntax with placeholder values
1433
+ #
1434
+ # certificates = rds.certificates({
1435
+ # certificate_identifier: "String",
1436
+ # filters: [
1437
+ # {
1438
+ # name: "String", # required
1439
+ # values: ["String"], # required
1440
+ # },
1441
+ # ],
1442
+ # max_records: 1,
1443
+ # marker: "String",
1444
+ # })
1445
+ # @param [Hash] options ({})
1446
+ # @option options [String] :certificate_identifier
1447
+ # The user-supplied certificate identifier. If this parameter is
1448
+ # specified, information for only the identified certificate is
1449
+ # returned. This parameter isn't case-sensitive.
1450
+ #
1451
+ # Constraints:
1452
+ #
1453
+ # * Must contain from 1 to 63 alphanumeric characters or hyphens
1454
+ #
1455
+ # * First character must be a letter
1456
+ #
1457
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1458
+ # @option options [Array<Types::Filter>] :filters
1459
+ # This parameter is not currently supported.
1460
+ # @option options [Integer] :max_records
1461
+ # The maximum number of records to include in the response. If more
1462
+ # records exist than the specified `MaxRecords` value, a pagination
1463
+ # token called a marker is included in the response so that the
1464
+ # remaining results can be retrieved.
1465
+ #
1466
+ # Default: 100
1467
+ #
1468
+ # Constraints: Minimum 20, maximum 100.
1469
+ # @option options [String] :marker
1470
+ # An optional pagination token provided by a previous
1471
+ # DescribeCertificates request. If this parameter is specified, the
1472
+ # response includes only records beyond the marker, up to the value
1473
+ # specified by `MaxRecords`.
1474
+ # @return [Certificate::Collection]
1475
+ def certificates(options = {})
1476
+ batches = Enumerator.new do |y|
1477
+ batch = []
1478
+ resp = @client.describe_certificates(options)
1479
+ resp.data.certificates.each do |c|
1480
+ batch << Certificate.new(
1481
+ id: c.certificate_identifier,
1482
+ data: c,
1483
+ client: @client
1484
+ )
1485
+ end
1486
+ y.yield(batch)
1167
1487
  end
1488
+ Certificate::Collection.new(batches)
1489
+ end
1168
1490
 
1169
- # @example Request syntax with placeholder values
1170
- #
1171
- # eventsubscription = rds.create_event_subscription({
1172
- # subscription_name: "String", # required
1173
- # sns_topic_arn: "String", # required
1174
- # source_type: "String",
1175
- # event_categories: ["String"],
1176
- # source_ids: ["String"],
1177
- # enabled: false,
1178
- # tags: [
1179
- # {
1180
- # key: "String",
1181
- # value: "String",
1182
- # },
1183
- # ],
1184
- # })
1185
- # @param [Hash] options ({})
1186
- # @option options [required, String] :subscription_name
1187
- # The name of the subscription.
1188
- #
1189
- # Constraints: The name must be less than 255 characters.
1190
- # @option options [required, String] :sns_topic_arn
1191
- # The Amazon Resource Name (ARN) of the SNS topic created for event
1192
- # notification. The ARN is created by Amazon SNS when you create a topic
1193
- # and subscribe to it.
1194
- # @option options [String] :source_type
1195
- # The type of source that will be generating the events. For example, if
1196
- # you want to be notified of events generated by a DB instance, you
1197
- # would set this parameter to db-instance. if this value is not
1198
- # specified, all events are returned.
1199
- #
1200
- # Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
1201
- # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
1202
- # @option options [Array<String>] :event_categories
1203
- # A list of event categories for a SourceType that you want to subscribe
1204
- # to. You can see a list of the categories for a given SourceType in the
1205
- # [Events][1] topic in the Amazon RDS User Guide or by using the
1206
- # **DescribeEventCategories** action.
1207
- #
1208
- #
1209
- #
1210
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
1211
- # @option options [Array<String>] :source_ids
1212
- # The list of identifiers of the event sources for which events will be
1213
- # returned. If not specified, then all sources are included in the
1214
- # response. An identifier must begin with a letter and must contain only
1215
- # ASCII letters, digits, and hyphens; it cannot end with a hyphen or
1216
- # contain two consecutive hyphens.
1217
- #
1218
- # Constraints:
1219
- #
1220
- # * If SourceIds are supplied, SourceType must also be provided.
1221
- #
1222
- # * If the source type is a DB instance, then a `DBInstanceIdentifier`
1223
- # must be supplied.
1224
- #
1225
- # * If the source type is a DB security group, a `DBSecurityGroupName`
1226
- # must be supplied.
1227
- #
1228
- # * If the source type is a DB parameter group, a `DBParameterGroupName`
1229
- # must be supplied.
1230
- #
1231
- # * If the source type is a DB snapshot, a `DBSnapshotIdentifier` must
1232
- # be supplied.
1233
- # @option options [Boolean] :enabled
1234
- # A Boolean value; set to **true** to activate the subscription, set to
1235
- # **false** to create the subscription but not active it.
1236
- # @option options [Array<Types::Tag>] :tags
1237
- # A list of tags.
1238
- # @return [EventSubscription]
1239
- def create_event_subscription(options = {})
1240
- resp = @client.create_event_subscription(options)
1241
- EventSubscription.new(
1242
- name: resp.data.event_subscription.cust_subscription_id,
1243
- data: resp.data.event_subscription,
1244
- client: @client
1245
- )
1491
+ # @param [String] id
1492
+ # @return [DBCluster]
1493
+ def db_cluster(id)
1494
+ DBCluster.new(
1495
+ id: id,
1496
+ client: @client
1497
+ )
1498
+ end
1499
+
1500
+ # @param [String] name
1501
+ # @return [DBClusterParameterGroup]
1502
+ def db_cluster_parameter_group(name)
1503
+ DBClusterParameterGroup.new(
1504
+ name: name,
1505
+ client: @client
1506
+ )
1507
+ end
1508
+
1509
+ # @example Request syntax with placeholder values
1510
+ #
1511
+ # db_cluster_parameter_groups = rds.db_cluster_parameter_groups({
1512
+ # db_cluster_parameter_group_name: "String",
1513
+ # filters: [
1514
+ # {
1515
+ # name: "String", # required
1516
+ # values: ["String"], # required
1517
+ # },
1518
+ # ],
1519
+ # max_records: 1,
1520
+ # marker: "String",
1521
+ # })
1522
+ # @param [Hash] options ({})
1523
+ # @option options [String] :db_cluster_parameter_group_name
1524
+ # The name of a specific DB cluster parameter group to return details
1525
+ # for.
1526
+ #
1527
+ # Constraints:
1528
+ #
1529
+ # * Must be 1 to 255 alphanumeric characters
1530
+ #
1531
+ # * First character must be a letter
1532
+ #
1533
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1534
+ # @option options [Array<Types::Filter>] :filters
1535
+ # This parameter is not currently supported.
1536
+ # @option options [Integer] :max_records
1537
+ # The maximum number of records to include in the response. If more
1538
+ # records exist than the specified `MaxRecords` value, a pagination
1539
+ # token called a marker is included in the response so that the
1540
+ # remaining results can be retrieved.
1541
+ #
1542
+ # Default: 100
1543
+ #
1544
+ # Constraints: Minimum 20, maximum 100.
1545
+ # @option options [String] :marker
1546
+ # An optional pagination token provided by a previous
1547
+ # `DescribeDBClusterParameterGroups` request. If this parameter is
1548
+ # specified, the response includes only records beyond the marker, up to
1549
+ # the value specified by `MaxRecords`.
1550
+ # @return [DBClusterParameterGroup::Collection]
1551
+ def db_cluster_parameter_groups(options = {})
1552
+ batches = Enumerator.new do |y|
1553
+ batch = []
1554
+ resp = @client.describe_db_cluster_parameter_groups(options)
1555
+ resp.data.db_cluster_parameter_groups.each do |d|
1556
+ batch << DBClusterParameterGroup.new(
1557
+ name: d.db_cluster_parameter_group_name,
1558
+ data: d,
1559
+ client: @client
1560
+ )
1561
+ end
1562
+ y.yield(batch)
1246
1563
  end
1564
+ DBClusterParameterGroup::Collection.new(batches)
1565
+ end
1247
1566
 
1248
- # @example Request syntax with placeholder values
1249
- #
1250
- # optiongroup = rds.create_option_group({
1251
- # option_group_name: "String", # required
1252
- # engine_name: "String", # required
1253
- # major_engine_version: "String", # required
1254
- # option_group_description: "String", # required
1255
- # tags: [
1256
- # {
1257
- # key: "String",
1258
- # value: "String",
1259
- # },
1260
- # ],
1261
- # })
1262
- # @param [Hash] options ({})
1263
- # @option options [required, String] :option_group_name
1264
- # Specifies the name of the option group to be created.
1265
- #
1266
- # Constraints:
1267
- #
1268
- # * Must be 1 to 255 alphanumeric characters or hyphens
1269
- #
1270
- # * First character must be a letter
1271
- #
1272
- # * Cannot end with a hyphen or contain two consecutive hyphens
1273
- #
1274
- # Example: `myoptiongroup`
1275
- # @option options [required, String] :engine_name
1276
- # Specifies the name of the engine that this option group should be
1277
- # associated with.
1278
- # @option options [required, String] :major_engine_version
1279
- # Specifies the major version of the engine that this option group
1280
- # should be associated with.
1281
- # @option options [required, String] :option_group_description
1282
- # The description of the option group.
1283
- # @option options [Array<Types::Tag>] :tags
1284
- # A list of tags.
1285
- # @return [OptionGroup]
1286
- def create_option_group(options = {})
1287
- resp = @client.create_option_group(options)
1288
- OptionGroup.new(
1289
- name: resp.data.option_group.option_group_name,
1290
- data: resp.data.option_group,
1291
- client: @client
1292
- )
1567
+ # @example Request syntax with placeholder values
1568
+ #
1569
+ # db_clusters = rds.db_clusters({
1570
+ # db_cluster_identifier: "String",
1571
+ # filters: [
1572
+ # {
1573
+ # name: "String", # required
1574
+ # values: ["String"], # required
1575
+ # },
1576
+ # ],
1577
+ # max_records: 1,
1578
+ # marker: "String",
1579
+ # })
1580
+ # @param [Hash] options ({})
1581
+ # @option options [String] :db_cluster_identifier
1582
+ # The user-supplied DB cluster identifier. If this parameter is
1583
+ # specified, information from only the specific DB cluster is returned.
1584
+ # This parameter isn't case-sensitive.
1585
+ #
1586
+ # Constraints:
1587
+ #
1588
+ # * Must contain from 1 to 63 alphanumeric characters or hyphens
1589
+ #
1590
+ # * First character must be a letter
1591
+ #
1592
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1593
+ # @option options [Array<Types::Filter>] :filters
1594
+ # A filter that specifies one or more DB clusters to describe.
1595
+ #
1596
+ # Supported filters:
1597
+ #
1598
+ # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
1599
+ # Amazon Resource Names (ARNs). The results list will only include
1600
+ # information about the DB clusters identified by these ARNs.
1601
+ #
1602
+ # ^
1603
+ # @option options [Integer] :max_records
1604
+ # The maximum number of records to include in the response. If more
1605
+ # records exist than the specified `MaxRecords` value, a pagination
1606
+ # token called a marker is included in the response so that the
1607
+ # remaining results can be retrieved.
1608
+ #
1609
+ # Default: 100
1610
+ #
1611
+ # Constraints: Minimum 20, maximum 100.
1612
+ # @option options [String] :marker
1613
+ # An optional pagination token provided by a previous DescribeDBClusters
1614
+ # request. If this parameter is specified, the response includes only
1615
+ # records beyond the marker, up to the value specified by `MaxRecords`.
1616
+ # @return [DBCluster::Collection]
1617
+ def db_clusters(options = {})
1618
+ batches = Enumerator.new do |y|
1619
+ batch = []
1620
+ resp = @client.describe_db_clusters(options)
1621
+ resp.data.db_clusters.each do |d|
1622
+ batch << DBCluster.new(
1623
+ id: d.db_cluster_identifier,
1624
+ data: d,
1625
+ client: @client
1626
+ )
1627
+ end
1628
+ y.yield(batch)
1293
1629
  end
1630
+ DBCluster::Collection.new(batches)
1631
+ end
1294
1632
 
1295
- # @!group Associations
1633
+ # @param [String] name
1634
+ # @return [DBEngine]
1635
+ def db_engine(name)
1636
+ DBEngine.new(
1637
+ name: name,
1638
+ client: @client
1639
+ )
1640
+ end
1641
+
1642
+ # @param [String] engine_name
1643
+ # @param [String] version
1644
+ # @return [DBEngineVersion]
1645
+ def db_engine_version(engine_name, version)
1646
+ DBEngineVersion.new(
1647
+ engine_name: engine_name,
1648
+ version: version,
1649
+ client: @client
1650
+ )
1651
+ end
1296
1652
 
1297
- # @example Request syntax with placeholder values
1298
- #
1299
- # accountquotas = rds.account_quotas()
1300
- # @param [Hash] options ({})
1301
- # @return [AccountQuota::Collection]
1302
- def account_quotas(options = {})
1303
- batches = Enumerator.new do |y|
1653
+ # @example Request syntax with placeholder values
1654
+ #
1655
+ # db_engine_versions = rds.db_engine_versions({
1656
+ # engine: "String",
1657
+ # engine_version: "String",
1658
+ # db_parameter_group_family: "String",
1659
+ # filters: [
1660
+ # {
1661
+ # name: "String", # required
1662
+ # values: ["String"], # required
1663
+ # },
1664
+ # ],
1665
+ # default_only: false,
1666
+ # list_supported_character_sets: false,
1667
+ # list_supported_timezones: false,
1668
+ # })
1669
+ # @param [Hash] options ({})
1670
+ # @option options [String] :engine
1671
+ # The database engine to return.
1672
+ # @option options [String] :engine_version
1673
+ # The database engine version to return.
1674
+ #
1675
+ # Example: `5.1.49`
1676
+ # @option options [String] :db_parameter_group_family
1677
+ # The name of a specific DB parameter group family to return details
1678
+ # for.
1679
+ #
1680
+ # Constraints:
1681
+ #
1682
+ # * Must be 1 to 255 alphanumeric characters
1683
+ #
1684
+ # * First character must be a letter
1685
+ #
1686
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1687
+ # @option options [Array<Types::Filter>] :filters
1688
+ # Not currently supported.
1689
+ # @option options [Boolean] :default_only
1690
+ # Indicates that only the default version of the specified engine or
1691
+ # engine and major version combination is returned.
1692
+ # @option options [Boolean] :list_supported_character_sets
1693
+ # If this parameter is specified and the requested engine supports the
1694
+ # `CharacterSetName` parameter for `CreateDBInstance`, the response
1695
+ # includes a list of supported character sets for each engine version.
1696
+ # @option options [Boolean] :list_supported_timezones
1697
+ # If this parameter is specified and the requested engine supports the
1698
+ # `TimeZone` parameter for `CreateDBInstance`, the response includes a
1699
+ # list of supported time zones for each engine version.
1700
+ # @return [DBEngineVersion::Collection]
1701
+ def db_engine_versions(options = {})
1702
+ batches = Enumerator.new do |y|
1703
+ resp = @client.describe_db_engine_versions(options)
1704
+ resp.each_page do |page|
1304
1705
  batch = []
1305
- resp = @client.describe_account_attributes(options)
1306
- resp.data.account_quotas.each do |a|
1307
- batch << AccountQuota.new(
1308
- name: a.account_quota_name,
1309
- data: a,
1706
+ page.data.db_engine_versions.each do |d|
1707
+ batch << DBEngineVersion.new(
1708
+ engine_name: d.engine,
1709
+ version: d.engine_version,
1710
+ data: d,
1310
1711
  client: @client
1311
1712
  )
1312
1713
  end
1313
1714
  y.yield(batch)
1314
1715
  end
1315
- AccountQuota::Collection.new(batches)
1316
1716
  end
1717
+ DBEngineVersion::Collection.new(batches)
1718
+ end
1317
1719
 
1318
- # @param [String] id
1319
- # @return [Certificate]
1320
- def certificate(id)
1321
- Certificate.new(
1322
- id: id,
1323
- client: @client
1324
- )
1325
- end
1720
+ # @param [String] id
1721
+ # @return [DBInstance]
1722
+ def db_instance(id)
1723
+ DBInstance.new(
1724
+ id: id,
1725
+ client: @client
1726
+ )
1727
+ end
1326
1728
 
1327
- # @example Request syntax with placeholder values
1328
- #
1329
- # certificates = rds.certificates({
1330
- # certificate_identifier: "String",
1331
- # filters: [
1332
- # {
1333
- # name: "String", # required
1334
- # values: ["String"], # required
1335
- # },
1336
- # ],
1337
- # max_records: 1,
1338
- # marker: "String",
1339
- # })
1340
- # @param [Hash] options ({})
1341
- # @option options [String] :certificate_identifier
1342
- # The user-supplied certificate identifier. If this parameter is
1343
- # specified, information for only the identified certificate is
1344
- # returned. This parameter isn't case-sensitive.
1345
- #
1346
- # Constraints:
1347
- #
1348
- # * Must contain from 1 to 63 alphanumeric characters or hyphens
1349
- #
1350
- # * First character must be a letter
1351
- #
1352
- # * Cannot end with a hyphen or contain two consecutive hyphens
1353
- # @option options [Array<Types::Filter>] :filters
1354
- # This parameter is not currently supported.
1355
- # @option options [Integer] :max_records
1356
- # The maximum number of records to include in the response. If more
1357
- # records exist than the specified `MaxRecords` value, a pagination
1358
- # token called a marker is included in the response so that the
1359
- # remaining results can be retrieved.
1360
- #
1361
- # Default: 100
1362
- #
1363
- # Constraints: Minimum 20, maximum 100.
1364
- # @option options [String] :marker
1365
- # An optional pagination token provided by a previous
1366
- # DescribeCertificates request. If this parameter is specified, the
1367
- # response includes only records beyond the marker, up to the value
1368
- # specified by `MaxRecords`.
1369
- # @return [Certificate::Collection]
1370
- def certificates(options = {})
1371
- batches = Enumerator.new do |y|
1729
+ # @example Request syntax with placeholder values
1730
+ #
1731
+ # db_instances = rds.db_instances({
1732
+ # db_instance_identifier: "String",
1733
+ # filters: [
1734
+ # {
1735
+ # name: "String", # required
1736
+ # values: ["String"], # required
1737
+ # },
1738
+ # ],
1739
+ # })
1740
+ # @param [Hash] options ({})
1741
+ # @option options [String] :db_instance_identifier
1742
+ # The user-supplied instance identifier. If this parameter is specified,
1743
+ # information from only the specific DB instance is returned. This
1744
+ # parameter isn't case-sensitive.
1745
+ #
1746
+ # Constraints:
1747
+ #
1748
+ # * Must contain from 1 to 63 alphanumeric characters or hyphens
1749
+ #
1750
+ # * First character must be a letter
1751
+ #
1752
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1753
+ # @option options [Array<Types::Filter>] :filters
1754
+ # A filter that specifies one or more DB instances to describe.
1755
+ #
1756
+ # Supported filters:
1757
+ #
1758
+ # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
1759
+ # Amazon Resource Names (ARNs). The results list will only include
1760
+ # information about the DB instances associated with the DB Clusters
1761
+ # identified by these ARNs.
1762
+ #
1763
+ # * `db-instance-id` - Accepts DB instance identifiers and DB instance
1764
+ # Amazon Resource Names (ARNs). The results list will only include
1765
+ # information about the DB instances identified by these ARNs.
1766
+ # @return [DBInstance::Collection]
1767
+ def db_instances(options = {})
1768
+ batches = Enumerator.new do |y|
1769
+ resp = @client.describe_db_instances(options)
1770
+ resp.each_page do |page|
1372
1771
  batch = []
1373
- resp = @client.describe_certificates(options)
1374
- resp.data.certificates.each do |c|
1375
- batch << Certificate.new(
1376
- id: c.certificate_identifier,
1377
- data: c,
1772
+ page.data.db_instances.each do |d|
1773
+ batch << DBInstance.new(
1774
+ id: d.db_instance_identifier,
1775
+ data: d,
1378
1776
  client: @client
1379
1777
  )
1380
1778
  end
1381
1779
  y.yield(batch)
1382
1780
  end
1383
- Certificate::Collection.new(batches)
1384
1781
  end
1782
+ DBInstance::Collection.new(batches)
1783
+ end
1385
1784
 
1386
- # @param [String] id
1387
- # @return [DBCluster]
1388
- def db_cluster(id)
1389
- DBCluster.new(
1390
- id: id,
1391
- client: @client
1392
- )
1393
- end
1785
+ # @param [String] name
1786
+ # @return [DBParameterGroup]
1787
+ def db_parameter_group(name)
1788
+ DBParameterGroup.new(
1789
+ name: name,
1790
+ client: @client
1791
+ )
1792
+ end
1394
1793
 
1395
- # @param [String] name
1396
- # @return [DBClusterParameterGroup]
1397
- def db_cluster_parameter_group(name)
1398
- DBClusterParameterGroup.new(
1399
- name: name,
1400
- client: @client
1401
- )
1402
- end
1794
+ # @param [String] name
1795
+ # @return [DBParameterGroupFamily]
1796
+ def db_parameter_group_family(name)
1797
+ DBParameterGroupFamily.new(
1798
+ name: name,
1799
+ client: @client
1800
+ )
1801
+ end
1403
1802
 
1404
- # @example Request syntax with placeholder values
1405
- #
1406
- # dbclusterparametergroups = rds.db_cluster_parameter_groups({
1407
- # db_cluster_parameter_group_name: "String",
1408
- # filters: [
1409
- # {
1410
- # name: "String", # required
1411
- # values: ["String"], # required
1412
- # },
1413
- # ],
1414
- # max_records: 1,
1415
- # marker: "String",
1416
- # })
1417
- # @param [Hash] options ({})
1418
- # @option options [String] :db_cluster_parameter_group_name
1419
- # The name of a specific DB cluster parameter group to return details
1420
- # for.
1421
- #
1422
- # Constraints:
1423
- #
1424
- # * Must be 1 to 255 alphanumeric characters
1425
- #
1426
- # * First character must be a letter
1427
- #
1428
- # * Cannot end with a hyphen or contain two consecutive hyphens
1429
- # @option options [Array<Types::Filter>] :filters
1430
- # This parameter is not currently supported.
1431
- # @option options [Integer] :max_records
1432
- # The maximum number of records to include in the response. If more
1433
- # records exist than the specified `MaxRecords` value, a pagination
1434
- # token called a marker is included in the response so that the
1435
- # remaining results can be retrieved.
1436
- #
1437
- # Default: 100
1438
- #
1439
- # Constraints: Minimum 20, maximum 100.
1440
- # @option options [String] :marker
1441
- # An optional pagination token provided by a previous
1442
- # `DescribeDBClusterParameterGroups` request. If this parameter is
1443
- # specified, the response includes only records beyond the marker, up to
1444
- # the value specified by `MaxRecords`.
1445
- # @return [DBClusterParameterGroup::Collection]
1446
- def db_cluster_parameter_groups(options = {})
1447
- batches = Enumerator.new do |y|
1803
+ # @example Request syntax with placeholder values
1804
+ #
1805
+ # db_parameter_groups = rds.db_parameter_groups({
1806
+ # db_parameter_group_name: "String",
1807
+ # filters: [
1808
+ # {
1809
+ # name: "String", # required
1810
+ # values: ["String"], # required
1811
+ # },
1812
+ # ],
1813
+ # })
1814
+ # @param [Hash] options ({})
1815
+ # @option options [String] :db_parameter_group_name
1816
+ # The name of a specific DB parameter group to return details for.
1817
+ #
1818
+ # Constraints:
1819
+ #
1820
+ # * Must be 1 to 255 alphanumeric characters
1821
+ #
1822
+ # * First character must be a letter
1823
+ #
1824
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1825
+ # @option options [Array<Types::Filter>] :filters
1826
+ # This parameter is not currently supported.
1827
+ # @return [DBParameterGroup::Collection]
1828
+ def db_parameter_groups(options = {})
1829
+ batches = Enumerator.new do |y|
1830
+ resp = @client.describe_db_parameter_groups(options)
1831
+ resp.each_page do |page|
1448
1832
  batch = []
1449
- resp = @client.describe_db_cluster_parameter_groups(options)
1450
- resp.data.db_cluster_parameter_groups.each do |d|
1451
- batch << DBClusterParameterGroup.new(
1452
- name: d.db_cluster_parameter_group_name,
1833
+ page.data.db_parameter_groups.each do |d|
1834
+ batch << DBParameterGroup.new(
1835
+ name: d.db_parameter_group_name,
1453
1836
  data: d,
1454
1837
  client: @client
1455
1838
  )
1456
1839
  end
1457
1840
  y.yield(batch)
1458
1841
  end
1459
- DBClusterParameterGroup::Collection.new(batches)
1460
1842
  end
1843
+ DBParameterGroup::Collection.new(batches)
1844
+ end
1845
+
1846
+ # @param [String] name
1847
+ # @return [DBSecurityGroup]
1848
+ def db_security_group(name)
1849
+ DBSecurityGroup.new(
1850
+ name: name,
1851
+ client: @client
1852
+ )
1853
+ end
1461
1854
 
1462
- # @example Request syntax with placeholder values
1463
- #
1464
- # dbclusters = rds.db_clusters({
1465
- # db_cluster_identifier: "String",
1466
- # filters: [
1467
- # {
1468
- # name: "String", # required
1469
- # values: ["String"], # required
1470
- # },
1471
- # ],
1472
- # max_records: 1,
1473
- # marker: "String",
1474
- # })
1475
- # @param [Hash] options ({})
1476
- # @option options [String] :db_cluster_identifier
1477
- # The user-supplied DB cluster identifier. If this parameter is
1478
- # specified, information from only the specific DB cluster is returned.
1479
- # This parameter isn't case-sensitive.
1480
- #
1481
- # Constraints:
1482
- #
1483
- # * Must contain from 1 to 63 alphanumeric characters or hyphens
1484
- #
1485
- # * First character must be a letter
1486
- #
1487
- # * Cannot end with a hyphen or contain two consecutive hyphens
1488
- # @option options [Array<Types::Filter>] :filters
1489
- # A filter that specifies one or more DB clusters to describe.
1490
- #
1491
- # Supported filters:
1492
- #
1493
- # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
1494
- # Amazon Resource Names (ARNs). The results list will only include
1495
- # information about the DB clusters identified by these ARNs.
1496
- #
1497
- # ^
1498
- # @option options [Integer] :max_records
1499
- # The maximum number of records to include in the response. If more
1500
- # records exist than the specified `MaxRecords` value, a pagination
1501
- # token called a marker is included in the response so that the
1502
- # remaining results can be retrieved.
1503
- #
1504
- # Default: 100
1505
- #
1506
- # Constraints: Minimum 20, maximum 100.
1507
- # @option options [String] :marker
1508
- # An optional pagination token provided by a previous DescribeDBClusters
1509
- # request. If this parameter is specified, the response includes only
1510
- # records beyond the marker, up to the value specified by `MaxRecords`.
1511
- # @return [DBCluster::Collection]
1512
- def db_clusters(options = {})
1513
- batches = Enumerator.new do |y|
1855
+ # @example Request syntax with placeholder values
1856
+ #
1857
+ # db_security_groups = rds.db_security_groups({
1858
+ # db_security_group_name: "String",
1859
+ # filters: [
1860
+ # {
1861
+ # name: "String", # required
1862
+ # values: ["String"], # required
1863
+ # },
1864
+ # ],
1865
+ # })
1866
+ # @param [Hash] options ({})
1867
+ # @option options [String] :db_security_group_name
1868
+ # The name of the DB security group to return details for.
1869
+ # @option options [Array<Types::Filter>] :filters
1870
+ # This parameter is not currently supported.
1871
+ # @return [DBSecurityGroup::Collection]
1872
+ def db_security_groups(options = {})
1873
+ batches = Enumerator.new do |y|
1874
+ resp = @client.describe_db_security_groups(options)
1875
+ resp.each_page do |page|
1514
1876
  batch = []
1515
- resp = @client.describe_db_clusters(options)
1516
- resp.data.db_clusters.each do |d|
1517
- batch << DBCluster.new(
1518
- id: d.db_cluster_identifier,
1877
+ page.data.db_security_groups.each do |d|
1878
+ batch << DBSecurityGroup.new(
1879
+ name: d.db_security_group_name,
1519
1880
  data: d,
1520
1881
  client: @client
1521
1882
  )
1522
1883
  end
1523
1884
  y.yield(batch)
1524
1885
  end
1525
- DBCluster::Collection.new(batches)
1526
- end
1527
-
1528
- # @param [String] name
1529
- # @return [DBEngine]
1530
- def db_engine(name)
1531
- DBEngine.new(
1532
- name: name,
1533
- client: @client
1534
- )
1535
- end
1536
-
1537
- # @param [String] engine_name
1538
- # @param [String] version
1539
- # @return [DBEngineVersion]
1540
- def db_engine_version(engine_name, version)
1541
- DBEngineVersion.new(
1542
- engine_name: engine_name,
1543
- version: version,
1544
- client: @client
1545
- )
1546
- end
1547
-
1548
- # @example Request syntax with placeholder values
1549
- #
1550
- # dbengineversions = rds.db_engine_versions({
1551
- # engine: "String",
1552
- # engine_version: "String",
1553
- # db_parameter_group_family: "String",
1554
- # filters: [
1555
- # {
1556
- # name: "String", # required
1557
- # values: ["String"], # required
1558
- # },
1559
- # ],
1560
- # default_only: false,
1561
- # list_supported_character_sets: false,
1562
- # list_supported_timezones: false,
1563
- # })
1564
- # @param [Hash] options ({})
1565
- # @option options [String] :engine
1566
- # The database engine to return.
1567
- # @option options [String] :engine_version
1568
- # The database engine version to return.
1569
- #
1570
- # Example: `5.1.49`
1571
- # @option options [String] :db_parameter_group_family
1572
- # The name of a specific DB parameter group family to return details
1573
- # for.
1574
- #
1575
- # Constraints:
1576
- #
1577
- # * Must be 1 to 255 alphanumeric characters
1578
- #
1579
- # * First character must be a letter
1580
- #
1581
- # * Cannot end with a hyphen or contain two consecutive hyphens
1582
- # @option options [Array<Types::Filter>] :filters
1583
- # Not currently supported.
1584
- # @option options [Boolean] :default_only
1585
- # Indicates that only the default version of the specified engine or
1586
- # engine and major version combination is returned.
1587
- # @option options [Boolean] :list_supported_character_sets
1588
- # If this parameter is specified and the requested engine supports the
1589
- # `CharacterSetName` parameter for `CreateDBInstance`, the response
1590
- # includes a list of supported character sets for each engine version.
1591
- # @option options [Boolean] :list_supported_timezones
1592
- # If this parameter is specified and the requested engine supports the
1593
- # `TimeZone` parameter for `CreateDBInstance`, the response includes a
1594
- # list of supported time zones for each engine version.
1595
- # @return [DBEngineVersion::Collection]
1596
- def db_engine_versions(options = {})
1597
- batches = Enumerator.new do |y|
1598
- resp = @client.describe_db_engine_versions(options)
1599
- resp.each_page do |page|
1600
- batch = []
1601
- page.data.db_engine_versions.each do |d|
1602
- batch << DBEngineVersion.new(
1603
- engine_name: d.engine,
1604
- version: d.engine_version,
1605
- data: d,
1606
- client: @client
1607
- )
1608
- end
1609
- y.yield(batch)
1610
- end
1611
- end
1612
- DBEngineVersion::Collection.new(batches)
1613
- end
1614
-
1615
- # @param [String] id
1616
- # @return [DBInstance]
1617
- def db_instance(id)
1618
- DBInstance.new(
1619
- id: id,
1620
- client: @client
1621
- )
1622
- end
1623
-
1624
- # @example Request syntax with placeholder values
1625
- #
1626
- # dbinstances = rds.db_instances({
1627
- # db_instance_identifier: "String",
1628
- # filters: [
1629
- # {
1630
- # name: "String", # required
1631
- # values: ["String"], # required
1632
- # },
1633
- # ],
1634
- # })
1635
- # @param [Hash] options ({})
1636
- # @option options [String] :db_instance_identifier
1637
- # The user-supplied instance identifier. If this parameter is specified,
1638
- # information from only the specific DB instance is returned. This
1639
- # parameter isn't case-sensitive.
1640
- #
1641
- # Constraints:
1642
- #
1643
- # * Must contain from 1 to 63 alphanumeric characters or hyphens
1644
- #
1645
- # * First character must be a letter
1646
- #
1647
- # * Cannot end with a hyphen or contain two consecutive hyphens
1648
- # @option options [Array<Types::Filter>] :filters
1649
- # A filter that specifies one or more DB instances to describe.
1650
- #
1651
- # Supported filters:
1652
- #
1653
- # * `db-instance-id` - Accepts DB instance identifiers and DB instance
1654
- # Amazon Resource Names (ARNs). The results list will only include
1655
- # information about the DB instances identified by these ARNs.
1656
- #
1657
- # ^
1658
- # @return [DBInstance::Collection]
1659
- def db_instances(options = {})
1660
- batches = Enumerator.new do |y|
1661
- resp = @client.describe_db_instances(options)
1662
- resp.each_page do |page|
1663
- batch = []
1664
- page.data.db_instances.each do |d|
1665
- batch << DBInstance.new(
1666
- id: d.db_instance_identifier,
1667
- data: d,
1668
- client: @client
1669
- )
1670
- end
1671
- y.yield(batch)
1672
- end
1673
- end
1674
- DBInstance::Collection.new(batches)
1675
- end
1676
-
1677
- # @param [String] name
1678
- # @return [DBParameterGroup]
1679
- def db_parameter_group(name)
1680
- DBParameterGroup.new(
1681
- name: name,
1682
- client: @client
1683
- )
1684
- end
1685
-
1686
- # @param [String] name
1687
- # @return [DBParameterGroupFamily]
1688
- def db_parameter_group_family(name)
1689
- DBParameterGroupFamily.new(
1690
- name: name,
1691
- client: @client
1692
- )
1693
1886
  end
1887
+ DBSecurityGroup::Collection.new(batches)
1888
+ end
1694
1889
 
1695
- # @example Request syntax with placeholder values
1696
- #
1697
- # dbparametergroups = rds.db_parameter_groups({
1698
- # db_parameter_group_name: "String",
1699
- # filters: [
1700
- # {
1701
- # name: "String", # required
1702
- # values: ["String"], # required
1703
- # },
1704
- # ],
1705
- # })
1706
- # @param [Hash] options ({})
1707
- # @option options [String] :db_parameter_group_name
1708
- # The name of a specific DB parameter group to return details for.
1709
- #
1710
- # Constraints:
1711
- #
1712
- # * Must be 1 to 255 alphanumeric characters
1713
- #
1714
- # * First character must be a letter
1715
- #
1716
- # * Cannot end with a hyphen or contain two consecutive hyphens
1717
- # @option options [Array<Types::Filter>] :filters
1718
- # This parameter is not currently supported.
1719
- # @return [DBParameterGroup::Collection]
1720
- def db_parameter_groups(options = {})
1721
- batches = Enumerator.new do |y|
1722
- resp = @client.describe_db_parameter_groups(options)
1723
- resp.each_page do |page|
1724
- batch = []
1725
- page.data.db_parameter_groups.each do |d|
1726
- batch << DBParameterGroup.new(
1727
- name: d.db_parameter_group_name,
1728
- data: d,
1729
- client: @client
1730
- )
1731
- end
1732
- y.yield(batch)
1890
+ # @example Request syntax with placeholder values
1891
+ #
1892
+ # db_snapshots = rds.db_snapshots({
1893
+ # db_instance_identifier: "String",
1894
+ # db_snapshot_identifier: "String",
1895
+ # snapshot_type: "String",
1896
+ # filters: [
1897
+ # {
1898
+ # name: "String", # required
1899
+ # values: ["String"], # required
1900
+ # },
1901
+ # ],
1902
+ # include_shared: false,
1903
+ # include_public: false,
1904
+ # })
1905
+ # @param [Hash] options ({})
1906
+ # @option options [String] :db_instance_identifier
1907
+ # The ID of the DB instance to retrieve the list of DB snapshots for.
1908
+ # This parameter cannot be used in conjunction with
1909
+ # `DBSnapshotIdentifier`. This parameter is not case-sensitive.
1910
+ #
1911
+ # Constraints:
1912
+ #
1913
+ # * Must contain from 1 to 63 alphanumeric characters or hyphens
1914
+ #
1915
+ # * First character must be a letter
1916
+ #
1917
+ # * Cannot end with a hyphen or contain two consecutive hyphens
1918
+ # @option options [String] :db_snapshot_identifier
1919
+ # A specific DB snapshot identifier to describe. This parameter cannot
1920
+ # be used in conjunction with `DBInstanceIdentifier`. This value is
1921
+ # stored as a lowercase string.
1922
+ #
1923
+ # Constraints:
1924
+ #
1925
+ # * Must be 1 to 255 alphanumeric characters.
1926
+ #
1927
+ # * First character must be a letter.
1928
+ #
1929
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
1930
+ #
1931
+ # * If this identifier is for an automated snapshot, the `SnapshotType`
1932
+ # parameter must also be specified.
1933
+ # @option options [String] :snapshot_type
1934
+ # The type of snapshots to be returned. You can specify one of the
1935
+ # following values:
1936
+ #
1937
+ # * `automated` - Return all DB snapshots that have been automatically
1938
+ # taken by Amazon RDS for my AWS account.
1939
+ #
1940
+ # * `manual` - Return all DB snapshots that have been taken by my AWS
1941
+ # account.
1942
+ #
1943
+ # * `shared` - Return all manual DB snapshots that have been shared to
1944
+ # my AWS account.
1945
+ #
1946
+ # * `public` - Return all DB snapshots that have been marked as public.
1947
+ #
1948
+ # If you don't specify a `SnapshotType` value, then both automated and
1949
+ # manual snapshots are returned. Shared and public DB snapshots are not
1950
+ # included in the returned results by default. You can include shared
1951
+ # snapshots with these results by setting the `IncludeShared` parameter
1952
+ # to `true`. You can include public snapshots with these results by
1953
+ # setting the `IncludePublic` parameter to `true`.
1954
+ #
1955
+ # The `IncludeShared` and `IncludePublic` parameters don't apply for
1956
+ # `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
1957
+ # parameter doesn't apply when `SnapshotType` is set to `shared`. The
1958
+ # `IncludeShared` parameter doesn't apply when `SnapshotType` is set to
1959
+ # `public`.
1960
+ # @option options [Array<Types::Filter>] :filters
1961
+ # This parameter is not currently supported.
1962
+ # @option options [Boolean] :include_shared
1963
+ # Set this value to `true` to include shared manual DB snapshots from
1964
+ # other AWS accounts that this AWS account has been given permission to
1965
+ # copy or restore, otherwise set this value to `false`. The default is
1966
+ # `false`.
1967
+ #
1968
+ # You can give an AWS account permission to restore a manual DB snapshot
1969
+ # from another AWS account by using the ModifyDBSnapshotAttribute API
1970
+ # action.
1971
+ # @option options [Boolean] :include_public
1972
+ # Set this value to `true` to include manual DB snapshots that are
1973
+ # public and can be copied or restored by any AWS account, otherwise set
1974
+ # this value to `false`. The default is `false`.
1975
+ #
1976
+ # You can share a manual DB snapshot as public by using the
1977
+ # ModifyDBSnapshotAttribute API.
1978
+ # @return [DBSnapshot::Collection]
1979
+ def db_snapshots(options = {})
1980
+ batches = Enumerator.new do |y|
1981
+ resp = @client.describe_db_snapshots(options)
1982
+ resp.each_page do |page|
1983
+ batch = []
1984
+ page.data.db_snapshots.each do |d|
1985
+ batch << DBSnapshot.new(
1986
+ instance_id: d.db_instance_identifier,
1987
+ snapshot_id: d.db_snapshot_identifier,
1988
+ data: d,
1989
+ client: @client
1990
+ )
1733
1991
  end
1992
+ y.yield(batch)
1734
1993
  end
1735
- DBParameterGroup::Collection.new(batches)
1736
- end
1737
-
1738
- # @param [String] name
1739
- # @return [DBSecurityGroup]
1740
- def db_security_group(name)
1741
- DBSecurityGroup.new(
1742
- name: name,
1743
- client: @client
1744
- )
1745
1994
  end
1995
+ DBSnapshot::Collection.new(batches)
1996
+ end
1746
1997
 
1747
- # @example Request syntax with placeholder values
1748
- #
1749
- # dbsecuritygroups = rds.db_security_groups({
1750
- # db_security_group_name: "String",
1751
- # filters: [
1752
- # {
1753
- # name: "String", # required
1754
- # values: ["String"], # required
1755
- # },
1756
- # ],
1757
- # })
1758
- # @param [Hash] options ({})
1759
- # @option options [String] :db_security_group_name
1760
- # The name of the DB security group to return details for.
1761
- # @option options [Array<Types::Filter>] :filters
1762
- # This parameter is not currently supported.
1763
- # @return [DBSecurityGroup::Collection]
1764
- def db_security_groups(options = {})
1765
- batches = Enumerator.new do |y|
1766
- resp = @client.describe_db_security_groups(options)
1767
- resp.each_page do |page|
1768
- batch = []
1769
- page.data.db_security_groups.each do |d|
1770
- batch << DBSecurityGroup.new(
1771
- name: d.db_security_group_name,
1772
- data: d,
1773
- client: @client
1774
- )
1775
- end
1776
- y.yield(batch)
1777
- end
1778
- end
1779
- DBSecurityGroup::Collection.new(batches)
1780
- end
1998
+ # @param [String] name
1999
+ # @return [DBSubnetGroup]
2000
+ def db_subnet_group(name)
2001
+ DBSubnetGroup.new(
2002
+ name: name,
2003
+ client: @client
2004
+ )
2005
+ end
1781
2006
 
1782
- # @example Request syntax with placeholder values
1783
- #
1784
- # dbsnapshots = rds.db_snapshots({
1785
- # db_instance_identifier: "String",
1786
- # db_snapshot_identifier: "String",
1787
- # snapshot_type: "String",
1788
- # filters: [
1789
- # {
1790
- # name: "String", # required
1791
- # values: ["String"], # required
1792
- # },
1793
- # ],
1794
- # include_shared: false,
1795
- # include_public: false,
1796
- # })
1797
- # @param [Hash] options ({})
1798
- # @option options [String] :db_instance_identifier
1799
- # The ID of the DB instance to retrieve the list of DB snapshots for.
1800
- # This parameter cannot be used in conjunction with
1801
- # `DBSnapshotIdentifier`. This parameter is not case-sensitive.
1802
- #
1803
- # Constraints:
1804
- #
1805
- # * Must contain from 1 to 63 alphanumeric characters or hyphens
1806
- #
1807
- # * First character must be a letter
1808
- #
1809
- # * Cannot end with a hyphen or contain two consecutive hyphens
1810
- # @option options [String] :db_snapshot_identifier
1811
- # A specific DB snapshot identifier to describe. This parameter cannot
1812
- # be used in conjunction with `DBInstanceIdentifier`. This value is
1813
- # stored as a lowercase string.
1814
- #
1815
- # Constraints:
1816
- #
1817
- # * Must be 1 to 255 alphanumeric characters.
1818
- #
1819
- # * First character must be a letter.
1820
- #
1821
- # * Cannot end with a hyphen or contain two consecutive hyphens.
1822
- #
1823
- # * If this identifier is for an automated snapshot, the `SnapshotType`
1824
- # parameter must also be specified.
1825
- # @option options [String] :snapshot_type
1826
- # The type of snapshots to be returned. You can specify one of the
1827
- # following values:
1828
- #
1829
- # * `automated` - Return all DB snapshots that have been automatically
1830
- # taken by Amazon RDS for my AWS account.
1831
- #
1832
- # * `manual` - Return all DB snapshots that have been taken by my AWS
1833
- # account.
1834
- #
1835
- # * `shared` - Return all manual DB snapshots that have been shared to
1836
- # my AWS account.
1837
- #
1838
- # * `public` - Return all DB snapshots that have been marked as public.
1839
- #
1840
- # If you don't specify a `SnapshotType` value, then both automated and
1841
- # manual snapshots are returned. Shared and public DB snapshots are not
1842
- # included in the returned results by default. You can include shared
1843
- # snapshots with these results by setting the `IncludeShared` parameter
1844
- # to `true`. You can include public snapshots with these results by
1845
- # setting the `IncludePublic` parameter to `true`.
1846
- #
1847
- # The `IncludeShared` and `IncludePublic` parameters don't apply for
1848
- # `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
1849
- # parameter doesn't apply when `SnapshotType` is set to `shared`. The
1850
- # `IncludeShared` parameter doesn't apply when `SnapshotType` is set to
1851
- # `public`.
1852
- # @option options [Array<Types::Filter>] :filters
1853
- # This parameter is not currently supported.
1854
- # @option options [Boolean] :include_shared
1855
- # Set this value to `true` to include shared manual DB snapshots from
1856
- # other AWS accounts that this AWS account has been given permission to
1857
- # copy or restore, otherwise set this value to `false`. The default is
1858
- # `false`.
1859
- #
1860
- # You can give an AWS account permission to restore a manual DB snapshot
1861
- # from another AWS account by using the ModifyDBSnapshotAttribute API
1862
- # action.
1863
- # @option options [Boolean] :include_public
1864
- # Set this value to `true` to include manual DB snapshots that are
1865
- # public and can be copied or restored by any AWS account, otherwise set
1866
- # this value to `false`. The default is `false`.
1867
- #
1868
- # You can share a manual DB snapshot as public by using the
1869
- # ModifyDBSnapshotAttribute API.
1870
- # @return [DBSnapshot::Collection]
1871
- def db_snapshots(options = {})
1872
- batches = Enumerator.new do |y|
1873
- resp = @client.describe_db_snapshots(options)
1874
- resp.each_page do |page|
1875
- batch = []
1876
- page.data.db_snapshots.each do |d|
1877
- batch << DBSnapshot.new(
1878
- instance_id: d.db_instance_identifier,
1879
- snapshot_id: d.db_snapshot_identifier,
1880
- data: d,
1881
- client: @client
1882
- )
1883
- end
1884
- y.yield(batch)
2007
+ # @example Request syntax with placeholder values
2008
+ #
2009
+ # db_subnet_groups = rds.db_subnet_groups({
2010
+ # db_subnet_group_name: "String",
2011
+ # filters: [
2012
+ # {
2013
+ # name: "String", # required
2014
+ # values: ["String"], # required
2015
+ # },
2016
+ # ],
2017
+ # })
2018
+ # @param [Hash] options ({})
2019
+ # @option options [String] :db_subnet_group_name
2020
+ # The name of the DB subnet group to return details for.
2021
+ # @option options [Array<Types::Filter>] :filters
2022
+ # This parameter is not currently supported.
2023
+ # @return [DBSubnetGroup::Collection]
2024
+ def db_subnet_groups(options = {})
2025
+ batches = Enumerator.new do |y|
2026
+ resp = @client.describe_db_subnet_groups(options)
2027
+ resp.each_page do |page|
2028
+ batch = []
2029
+ page.data.db_subnet_groups.each do |d|
2030
+ batch << DBSubnetGroup.new(
2031
+ name: d.db_subnet_group_name,
2032
+ data: d,
2033
+ client: @client
2034
+ )
1885
2035
  end
2036
+ y.yield(batch)
1886
2037
  end
1887
- DBSnapshot::Collection.new(batches)
1888
2038
  end
2039
+ DBSubnetGroup::Collection.new(batches)
2040
+ end
1889
2041
 
1890
- # @param [String] name
1891
- # @return [DBSubnetGroup]
1892
- def db_subnet_group(name)
1893
- DBSubnetGroup.new(
1894
- name: name,
1895
- client: @client
1896
- )
1897
- end
2042
+ # @param [String] source_type
2043
+ # @return [EventCategoryMap]
2044
+ def event_category_map(source_type)
2045
+ EventCategoryMap.new(
2046
+ source_type: source_type,
2047
+ client: @client
2048
+ )
2049
+ end
1898
2050
 
1899
- # @example Request syntax with placeholder values
1900
- #
1901
- # dbsubnetgroups = rds.db_subnet_groups({
1902
- # db_subnet_group_name: "String",
1903
- # filters: [
1904
- # {
1905
- # name: "String", # required
1906
- # values: ["String"], # required
1907
- # },
1908
- # ],
1909
- # })
1910
- # @param [Hash] options ({})
1911
- # @option options [String] :db_subnet_group_name
1912
- # The name of the DB subnet group to return details for.
1913
- # @option options [Array<Types::Filter>] :filters
1914
- # This parameter is not currently supported.
1915
- # @return [DBSubnetGroup::Collection]
1916
- def db_subnet_groups(options = {})
1917
- batches = Enumerator.new do |y|
1918
- resp = @client.describe_db_subnet_groups(options)
1919
- resp.each_page do |page|
1920
- batch = []
1921
- page.data.db_subnet_groups.each do |d|
1922
- batch << DBSubnetGroup.new(
1923
- name: d.db_subnet_group_name,
1924
- data: d,
1925
- client: @client
1926
- )
1927
- end
1928
- y.yield(batch)
1929
- end
2051
+ # @example Request syntax with placeholder values
2052
+ #
2053
+ # event_category_maps = rds.event_category_maps({
2054
+ # source_type: "String",
2055
+ # filters: [
2056
+ # {
2057
+ # name: "String", # required
2058
+ # values: ["String"], # required
2059
+ # },
2060
+ # ],
2061
+ # })
2062
+ # @param [Hash] options ({})
2063
+ # @option options [String] :source_type
2064
+ # The type of source that will be generating the events.
2065
+ #
2066
+ # Valid values: db-instance \| db-parameter-group \| db-security-group
2067
+ # \| db-snapshot
2068
+ # @option options [Array<Types::Filter>] :filters
2069
+ # This parameter is not currently supported.
2070
+ # @return [EventCategoryMap::Collection]
2071
+ def event_category_maps(options = {})
2072
+ batches = Enumerator.new do |y|
2073
+ batch = []
2074
+ resp = @client.describe_event_categories(options)
2075
+ resp.data.event_categories_map_list.each do |e|
2076
+ batch << EventCategoryMap.new(
2077
+ source_type: e.source_type,
2078
+ data: e,
2079
+ client: @client
2080
+ )
1930
2081
  end
1931
- DBSubnetGroup::Collection.new(batches)
2082
+ y.yield(batch)
1932
2083
  end
2084
+ EventCategoryMap::Collection.new(batches)
2085
+ end
1933
2086
 
1934
- # @param [String] source_type
1935
- # @return [EventCategoryMap]
1936
- def event_category_map(source_type)
1937
- EventCategoryMap.new(
1938
- source_type: source_type,
1939
- client: @client
1940
- )
1941
- end
2087
+ # @param [String] name
2088
+ # @return [EventSubscription]
2089
+ def event_subscription(name)
2090
+ EventSubscription.new(
2091
+ name: name,
2092
+ client: @client
2093
+ )
2094
+ end
1942
2095
 
1943
- # @example Request syntax with placeholder values
1944
- #
1945
- # eventcategorymaps = rds.event_category_maps({
1946
- # source_type: "String",
1947
- # filters: [
1948
- # {
1949
- # name: "String", # required
1950
- # values: ["String"], # required
1951
- # },
1952
- # ],
1953
- # })
1954
- # @param [Hash] options ({})
1955
- # @option options [String] :source_type
1956
- # The type of source that will be generating the events.
1957
- #
1958
- # Valid values: db-instance \| db-parameter-group \| db-security-group
1959
- # \| db-snapshot
1960
- # @option options [Array<Types::Filter>] :filters
1961
- # This parameter is not currently supported.
1962
- # @return [EventCategoryMap::Collection]
1963
- def event_category_maps(options = {})
1964
- batches = Enumerator.new do |y|
2096
+ # @example Request syntax with placeholder values
2097
+ #
2098
+ # event_subscriptions = rds.event_subscriptions({
2099
+ # subscription_name: "String",
2100
+ # filters: [
2101
+ # {
2102
+ # name: "String", # required
2103
+ # values: ["String"], # required
2104
+ # },
2105
+ # ],
2106
+ # })
2107
+ # @param [Hash] options ({})
2108
+ # @option options [String] :subscription_name
2109
+ # The name of the RDS event notification subscription you want to
2110
+ # describe.
2111
+ # @option options [Array<Types::Filter>] :filters
2112
+ # This parameter is not currently supported.
2113
+ # @return [EventSubscription::Collection]
2114
+ def event_subscriptions(options = {})
2115
+ batches = Enumerator.new do |y|
2116
+ resp = @client.describe_event_subscriptions(options)
2117
+ resp.each_page do |page|
1965
2118
  batch = []
1966
- resp = @client.describe_event_categories(options)
1967
- resp.data.event_categories_map_list.each do |e|
1968
- batch << EventCategoryMap.new(
1969
- source_type: e.source_type,
2119
+ page.data.event_subscriptions_list.each do |e|
2120
+ batch << EventSubscription.new(
2121
+ name: e.cust_subscription_id,
1970
2122
  data: e,
1971
2123
  client: @client
1972
2124
  )
1973
2125
  end
1974
2126
  y.yield(batch)
1975
2127
  end
1976
- EventCategoryMap::Collection.new(batches)
1977
- end
1978
-
1979
- # @param [String] name
1980
- # @return [EventSubscription]
1981
- def event_subscription(name)
1982
- EventSubscription.new(
1983
- name: name,
1984
- client: @client
1985
- )
1986
- end
1987
-
1988
- # @example Request syntax with placeholder values
1989
- #
1990
- # eventsubscriptions = rds.event_subscriptions({
1991
- # subscription_name: "String",
1992
- # filters: [
1993
- # {
1994
- # name: "String", # required
1995
- # values: ["String"], # required
1996
- # },
1997
- # ],
1998
- # })
1999
- # @param [Hash] options ({})
2000
- # @option options [String] :subscription_name
2001
- # The name of the RDS event notification subscription you want to
2002
- # describe.
2003
- # @option options [Array<Types::Filter>] :filters
2004
- # This parameter is not currently supported.
2005
- # @return [EventSubscription::Collection]
2006
- def event_subscriptions(options = {})
2007
- batches = Enumerator.new do |y|
2008
- resp = @client.describe_event_subscriptions(options)
2009
- resp.each_page do |page|
2010
- batch = []
2011
- page.data.event_subscriptions_list.each do |e|
2012
- batch << EventSubscription.new(
2013
- name: e.cust_subscription_id,
2014
- data: e,
2015
- client: @client
2016
- )
2017
- end
2018
- y.yield(batch)
2019
- end
2020
- end
2021
- EventSubscription::Collection.new(batches)
2022
2128
  end
2129
+ EventSubscription::Collection.new(batches)
2130
+ end
2023
2131
 
2024
- # @example Request syntax with placeholder values
2025
- #
2026
- # events = rds.events({
2027
- # source_identifier: "String",
2028
- # source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
2029
- # start_time: Time.now,
2030
- # end_time: Time.now,
2031
- # duration: 1,
2032
- # event_categories: ["String"],
2033
- # filters: [
2034
- # {
2035
- # name: "String", # required
2036
- # values: ["String"], # required
2037
- # },
2038
- # ],
2039
- # })
2040
- # @param [Hash] options ({})
2041
- # @option options [String] :source_identifier
2042
- # The identifier of the event source for which events will be returned.
2043
- # If not specified, then all sources are included in the response.
2044
- #
2045
- # Constraints:
2046
- #
2047
- # * If SourceIdentifier is supplied, SourceType must also be provided.
2048
- #
2049
- # * If the source type is `DBInstance`, then a `DBInstanceIdentifier`
2050
- # must be supplied.
2051
- #
2052
- # * If the source type is `DBSecurityGroup`, a `DBSecurityGroupName`
2053
- # must be supplied.
2054
- #
2055
- # * If the source type is `DBParameterGroup`, a `DBParameterGroupName`
2056
- # must be supplied.
2057
- #
2058
- # * If the source type is `DBSnapshot`, a `DBSnapshotIdentifier` must be
2059
- # supplied.
2060
- #
2061
- # * Cannot end with a hyphen or contain two consecutive hyphens.
2062
- # @option options [String] :source_type
2063
- # The event source to retrieve events for. If no value is specified, all
2064
- # events are returned.
2065
- # @option options [Time,DateTime,Date,Integer,String] :start_time
2066
- # The beginning of the time interval to retrieve events for, specified
2067
- # in ISO 8601 format. For more information about ISO 8601, go to the
2068
- # [ISO8601 Wikipedia page.][1]
2069
- #
2070
- # Example: 2009-07-08T18:00Z
2071
- #
2072
- #
2073
- #
2074
- # [1]: http://en.wikipedia.org/wiki/ISO_8601
2075
- # @option options [Time,DateTime,Date,Integer,String] :end_time
2076
- # The end of the time interval for which to retrieve events, specified
2077
- # in ISO 8601 format. For more information about ISO 8601, go to the
2078
- # [ISO8601 Wikipedia page.][1]
2079
- #
2080
- # Example: 2009-07-08T18:00Z
2081
- #
2082
- #
2083
- #
2084
- # [1]: http://en.wikipedia.org/wiki/ISO_8601
2085
- # @option options [Integer] :duration
2086
- # The number of minutes to retrieve events for.
2087
- #
2088
- # Default: 60
2089
- # @option options [Array<String>] :event_categories
2090
- # A list of event categories that trigger notifications for a event
2091
- # notification subscription.
2092
- # @option options [Array<Types::Filter>] :filters
2093
- # This parameter is not currently supported.
2094
- # @return [Event::Collection]
2095
- def events(options = {})
2096
- batches = Enumerator.new do |y|
2097
- resp = @client.describe_events(options)
2098
- resp.each_page do |page|
2099
- batch = []
2100
- page.data.events.each do |e|
2101
- batch << Event.new(
2102
- source_id: e.source_identifier,
2103
- date: e.date,
2104
- data: e,
2105
- client: @client
2106
- )
2107
- end
2108
- y.yield(batch)
2132
+ # @example Request syntax with placeholder values
2133
+ #
2134
+ # events = rds.events({
2135
+ # source_identifier: "String",
2136
+ # source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
2137
+ # start_time: Time.now,
2138
+ # end_time: Time.now,
2139
+ # duration: 1,
2140
+ # event_categories: ["String"],
2141
+ # filters: [
2142
+ # {
2143
+ # name: "String", # required
2144
+ # values: ["String"], # required
2145
+ # },
2146
+ # ],
2147
+ # })
2148
+ # @param [Hash] options ({})
2149
+ # @option options [String] :source_identifier
2150
+ # The identifier of the event source for which events will be returned.
2151
+ # If not specified, then all sources are included in the response.
2152
+ #
2153
+ # Constraints:
2154
+ #
2155
+ # * If SourceIdentifier is supplied, SourceType must also be provided.
2156
+ #
2157
+ # * If the source type is `DBInstance`, then a `DBInstanceIdentifier`
2158
+ # must be supplied.
2159
+ #
2160
+ # * If the source type is `DBSecurityGroup`, a `DBSecurityGroupName`
2161
+ # must be supplied.
2162
+ #
2163
+ # * If the source type is `DBParameterGroup`, a `DBParameterGroupName`
2164
+ # must be supplied.
2165
+ #
2166
+ # * If the source type is `DBSnapshot`, a `DBSnapshotIdentifier` must be
2167
+ # supplied.
2168
+ #
2169
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
2170
+ # @option options [String] :source_type
2171
+ # The event source to retrieve events for. If no value is specified, all
2172
+ # events are returned.
2173
+ # @option options [Time,DateTime,Date,Integer,String] :start_time
2174
+ # The beginning of the time interval to retrieve events for, specified
2175
+ # in ISO 8601 format. For more information about ISO 8601, go to the
2176
+ # [ISO8601 Wikipedia page.][1]
2177
+ #
2178
+ # Example: 2009-07-08T18:00Z
2179
+ #
2180
+ #
2181
+ #
2182
+ # [1]: http://en.wikipedia.org/wiki/ISO_8601
2183
+ # @option options [Time,DateTime,Date,Integer,String] :end_time
2184
+ # The end of the time interval for which to retrieve events, specified
2185
+ # in ISO 8601 format. For more information about ISO 8601, go to the
2186
+ # [ISO8601 Wikipedia page.][1]
2187
+ #
2188
+ # Example: 2009-07-08T18:00Z
2189
+ #
2190
+ #
2191
+ #
2192
+ # [1]: http://en.wikipedia.org/wiki/ISO_8601
2193
+ # @option options [Integer] :duration
2194
+ # The number of minutes to retrieve events for.
2195
+ #
2196
+ # Default: 60
2197
+ # @option options [Array<String>] :event_categories
2198
+ # A list of event categories that trigger notifications for a event
2199
+ # notification subscription.
2200
+ # @option options [Array<Types::Filter>] :filters
2201
+ # This parameter is not currently supported.
2202
+ # @return [Event::Collection]
2203
+ def events(options = {})
2204
+ batches = Enumerator.new do |y|
2205
+ resp = @client.describe_events(options)
2206
+ resp.each_page do |page|
2207
+ batch = []
2208
+ page.data.events.each do |e|
2209
+ batch << Event.new(
2210
+ source_id: e.source_identifier,
2211
+ date: e.date,
2212
+ data: e,
2213
+ client: @client
2214
+ )
2109
2215
  end
2216
+ y.yield(batch)
2110
2217
  end
2111
- Event::Collection.new(batches)
2112
2218
  end
2219
+ Event::Collection.new(batches)
2220
+ end
2113
2221
 
2114
- # @param [String] name
2115
- # @return [OptionGroup]
2116
- def option_group(name)
2117
- OptionGroup.new(
2118
- name: name,
2119
- client: @client
2120
- )
2121
- end
2222
+ # @param [String] name
2223
+ # @return [OptionGroup]
2224
+ def option_group(name)
2225
+ OptionGroup.new(
2226
+ name: name,
2227
+ client: @client
2228
+ )
2229
+ end
2122
2230
 
2123
- # @example Request syntax with placeholder values
2124
- #
2125
- # optiongroups = rds.option_groups({
2126
- # option_group_name: "String",
2127
- # filters: [
2128
- # {
2129
- # name: "String", # required
2130
- # values: ["String"], # required
2131
- # },
2132
- # ],
2133
- # engine_name: "String",
2134
- # major_engine_version: "String",
2135
- # })
2136
- # @param [Hash] options ({})
2137
- # @option options [String] :option_group_name
2138
- # The name of the option group to describe. Cannot be supplied together
2139
- # with EngineName or MajorEngineVersion.
2140
- # @option options [Array<Types::Filter>] :filters
2141
- # This parameter is not currently supported.
2142
- # @option options [String] :engine_name
2143
- # Filters the list of option groups to only include groups associated
2144
- # with a specific database engine.
2145
- # @option options [String] :major_engine_version
2146
- # Filters the list of option groups to only include groups associated
2147
- # with a specific database engine version. If specified, then EngineName
2148
- # must also be specified.
2149
- # @return [OptionGroup::Collection]
2150
- def option_groups(options = {})
2151
- batches = Enumerator.new do |y|
2152
- resp = @client.describe_option_groups(options)
2153
- resp.each_page do |page|
2154
- batch = []
2155
- page.data.option_groups_list.each do |o|
2156
- batch << OptionGroup.new(
2157
- name: o.option_group_name,
2158
- data: o,
2159
- client: @client
2160
- )
2161
- end
2162
- y.yield(batch)
2231
+ # @example Request syntax with placeholder values
2232
+ #
2233
+ # option_groups = rds.option_groups({
2234
+ # option_group_name: "String",
2235
+ # filters: [
2236
+ # {
2237
+ # name: "String", # required
2238
+ # values: ["String"], # required
2239
+ # },
2240
+ # ],
2241
+ # engine_name: "String",
2242
+ # major_engine_version: "String",
2243
+ # })
2244
+ # @param [Hash] options ({})
2245
+ # @option options [String] :option_group_name
2246
+ # The name of the option group to describe. Cannot be supplied together
2247
+ # with EngineName or MajorEngineVersion.
2248
+ # @option options [Array<Types::Filter>] :filters
2249
+ # This parameter is not currently supported.
2250
+ # @option options [String] :engine_name
2251
+ # Filters the list of option groups to only include groups associated
2252
+ # with a specific database engine.
2253
+ # @option options [String] :major_engine_version
2254
+ # Filters the list of option groups to only include groups associated
2255
+ # with a specific database engine version. If specified, then EngineName
2256
+ # must also be specified.
2257
+ # @return [OptionGroup::Collection]
2258
+ def option_groups(options = {})
2259
+ batches = Enumerator.new do |y|
2260
+ resp = @client.describe_option_groups(options)
2261
+ resp.each_page do |page|
2262
+ batch = []
2263
+ page.data.option_groups_list.each do |o|
2264
+ batch << OptionGroup.new(
2265
+ name: o.option_group_name,
2266
+ data: o,
2267
+ client: @client
2268
+ )
2163
2269
  end
2270
+ y.yield(batch)
2164
2271
  end
2165
- OptionGroup::Collection.new(batches)
2166
- end
2167
-
2168
- # @param [String] target_arn
2169
- # @param [String] name
2170
- # @return [PendingMaintenanceAction]
2171
- def pending_maintenance_action(target_arn, name)
2172
- PendingMaintenanceAction.new(
2173
- target_arn: target_arn,
2174
- name: name,
2175
- client: @client
2176
- )
2177
- end
2178
-
2179
- # @param [String] id
2180
- # @return [ReservedDBInstance]
2181
- def reserved_db_instance(id)
2182
- ReservedDBInstance.new(
2183
- id: id,
2184
- client: @client
2185
- )
2186
2272
  end
2273
+ OptionGroup::Collection.new(batches)
2274
+ end
2187
2275
 
2188
- # @example Request syntax with placeholder values
2189
- #
2190
- # reserveddbinstances = rds.reserved_db_instances({
2191
- # reserved_db_instance_id: "String",
2192
- # reserved_db_instances_offering_id: "String",
2193
- # db_instance_class: "String",
2194
- # duration: "String",
2195
- # product_description: "String",
2196
- # offering_type: "String",
2197
- # multi_az: false,
2198
- # filters: [
2199
- # {
2200
- # name: "String", # required
2201
- # values: ["String"], # required
2202
- # },
2203
- # ],
2204
- # })
2205
- # @param [Hash] options ({})
2206
- # @option options [String] :reserved_db_instance_id
2207
- # The reserved DB instance identifier filter value. Specify this
2208
- # parameter to show only the reservation that matches the specified
2209
- # reservation ID.
2210
- # @option options [String] :reserved_db_instances_offering_id
2211
- # The offering identifier filter value. Specify this parameter to show
2212
- # only purchased reservations matching the specified offering
2213
- # identifier.
2214
- # @option options [String] :db_instance_class
2215
- # The DB instance class filter value. Specify this parameter to show
2216
- # only those reservations matching the specified DB instances class.
2217
- # @option options [String] :duration
2218
- # The duration filter value, specified in years or seconds. Specify this
2219
- # parameter to show only reservations for this duration.
2220
- #
2221
- # Valid Values: `1 | 3 | 31536000 | 94608000`
2222
- # @option options [String] :product_description
2223
- # The product description filter value. Specify this parameter to show
2224
- # only those reservations matching the specified product description.
2225
- # @option options [String] :offering_type
2226
- # The offering type filter value. Specify this parameter to show only
2227
- # the available offerings matching the specified offering type.
2228
- #
2229
- # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
2230
- # @option options [Boolean] :multi_az
2231
- # The Multi-AZ filter value. Specify this parameter to show only those
2232
- # reservations matching the specified Multi-AZ parameter.
2233
- # @option options [Array<Types::Filter>] :filters
2234
- # This parameter is not currently supported.
2235
- # @return [ReservedDBInstance::Collection]
2236
- def reserved_db_instances(options = {})
2237
- batches = Enumerator.new do |y|
2238
- resp = @client.describe_reserved_db_instances(options)
2239
- resp.each_page do |page|
2240
- batch = []
2241
- page.data.reserved_db_instances.each do |r|
2242
- batch << ReservedDBInstance.new(
2243
- id: r.reserved_db_instance_id,
2244
- data: r,
2245
- client: @client
2246
- )
2247
- end
2248
- y.yield(batch)
2249
- end
2250
- end
2251
- ReservedDBInstance::Collection.new(batches)
2252
- end
2276
+ # @param [String] target_arn
2277
+ # @param [String] name
2278
+ # @return [PendingMaintenanceAction]
2279
+ def pending_maintenance_action(target_arn, name)
2280
+ PendingMaintenanceAction.new(
2281
+ target_arn: target_arn,
2282
+ name: name,
2283
+ client: @client
2284
+ )
2285
+ end
2253
2286
 
2254
- # @param [String] id
2255
- # @return [ReservedDBInstancesOffering]
2256
- def reserved_db_instances_offering(id)
2257
- ReservedDBInstancesOffering.new(
2258
- id: id,
2259
- client: @client
2260
- )
2261
- end
2287
+ # @param [String] id
2288
+ # @return [ReservedDBInstance]
2289
+ def reserved_db_instance(id)
2290
+ ReservedDBInstance.new(
2291
+ id: id,
2292
+ client: @client
2293
+ )
2294
+ end
2262
2295
 
2263
- # @example Request syntax with placeholder values
2264
- #
2265
- # reserveddbinstancesofferings = rds.reserved_db_instances_offerings({
2266
- # reserved_db_instances_offering_id: "String",
2267
- # db_instance_class: "String",
2268
- # duration: "String",
2269
- # product_description: "String",
2270
- # offering_type: "String",
2271
- # multi_az: false,
2272
- # filters: [
2273
- # {
2274
- # name: "String", # required
2275
- # values: ["String"], # required
2276
- # },
2277
- # ],
2278
- # })
2279
- # @param [Hash] options ({})
2280
- # @option options [String] :reserved_db_instances_offering_id
2281
- # The offering identifier filter value. Specify this parameter to show
2282
- # only the available offering that matches the specified reservation
2283
- # identifier.
2284
- #
2285
- # Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706`
2286
- # @option options [String] :db_instance_class
2287
- # The DB instance class filter value. Specify this parameter to show
2288
- # only the available offerings matching the specified DB instance class.
2289
- # @option options [String] :duration
2290
- # Duration filter value, specified in years or seconds. Specify this
2291
- # parameter to show only reservations for this duration.
2292
- #
2293
- # Valid Values: `1 | 3 | 31536000 | 94608000`
2294
- # @option options [String] :product_description
2295
- # Product description filter value. Specify this parameter to show only
2296
- # the available offerings matching the specified product description.
2297
- # @option options [String] :offering_type
2298
- # The offering type filter value. Specify this parameter to show only
2299
- # the available offerings matching the specified offering type.
2300
- #
2301
- # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
2302
- # @option options [Boolean] :multi_az
2303
- # The Multi-AZ filter value. Specify this parameter to show only the
2304
- # available offerings matching the specified Multi-AZ parameter.
2305
- # @option options [Array<Types::Filter>] :filters
2306
- # This parameter is not currently supported.
2307
- # @return [ReservedDBInstancesOffering::Collection]
2308
- def reserved_db_instances_offerings(options = {})
2309
- batches = Enumerator.new do |y|
2310
- resp = @client.describe_reserved_db_instances_offerings(options)
2311
- resp.each_page do |page|
2312
- batch = []
2313
- page.data.reserved_db_instances_offerings.each do |r|
2314
- batch << ReservedDBInstancesOffering.new(
2315
- id: r.reserved_db_instances_offering_id,
2316
- data: r,
2317
- client: @client
2318
- )
2319
- end
2320
- y.yield(batch)
2296
+ # @example Request syntax with placeholder values
2297
+ #
2298
+ # reserved_db_instances = rds.reserved_db_instances({
2299
+ # reserved_db_instance_id: "String",
2300
+ # reserved_db_instances_offering_id: "String",
2301
+ # db_instance_class: "String",
2302
+ # duration: "String",
2303
+ # product_description: "String",
2304
+ # offering_type: "String",
2305
+ # multi_az: false,
2306
+ # filters: [
2307
+ # {
2308
+ # name: "String", # required
2309
+ # values: ["String"], # required
2310
+ # },
2311
+ # ],
2312
+ # })
2313
+ # @param [Hash] options ({})
2314
+ # @option options [String] :reserved_db_instance_id
2315
+ # The reserved DB instance identifier filter value. Specify this
2316
+ # parameter to show only the reservation that matches the specified
2317
+ # reservation ID.
2318
+ # @option options [String] :reserved_db_instances_offering_id
2319
+ # The offering identifier filter value. Specify this parameter to show
2320
+ # only purchased reservations matching the specified offering
2321
+ # identifier.
2322
+ # @option options [String] :db_instance_class
2323
+ # The DB instance class filter value. Specify this parameter to show
2324
+ # only those reservations matching the specified DB instances class.
2325
+ # @option options [String] :duration
2326
+ # The duration filter value, specified in years or seconds. Specify this
2327
+ # parameter to show only reservations for this duration.
2328
+ #
2329
+ # Valid Values: `1 | 3 | 31536000 | 94608000`
2330
+ # @option options [String] :product_description
2331
+ # The product description filter value. Specify this parameter to show
2332
+ # only those reservations matching the specified product description.
2333
+ # @option options [String] :offering_type
2334
+ # The offering type filter value. Specify this parameter to show only
2335
+ # the available offerings matching the specified offering type.
2336
+ #
2337
+ # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
2338
+ # @option options [Boolean] :multi_az
2339
+ # The Multi-AZ filter value. Specify this parameter to show only those
2340
+ # reservations matching the specified Multi-AZ parameter.
2341
+ # @option options [Array<Types::Filter>] :filters
2342
+ # This parameter is not currently supported.
2343
+ # @return [ReservedDBInstance::Collection]
2344
+ def reserved_db_instances(options = {})
2345
+ batches = Enumerator.new do |y|
2346
+ resp = @client.describe_reserved_db_instances(options)
2347
+ resp.each_page do |page|
2348
+ batch = []
2349
+ page.data.reserved_db_instances.each do |r|
2350
+ batch << ReservedDBInstance.new(
2351
+ id: r.reserved_db_instance_id,
2352
+ data: r,
2353
+ client: @client
2354
+ )
2321
2355
  end
2356
+ y.yield(batch)
2322
2357
  end
2323
- ReservedDBInstancesOffering::Collection.new(batches)
2324
2358
  end
2359
+ ReservedDBInstance::Collection.new(batches)
2360
+ end
2325
2361
 
2326
- # @param [String] arn
2327
- # @return [ResourcePendingMaintenanceActionList]
2328
- def resource_with_pending_maintenance_actions(arn)
2329
- ResourcePendingMaintenanceActionList.new(
2330
- arn: arn,
2331
- client: @client
2332
- )
2333
- end
2362
+ # @param [String] id
2363
+ # @return [ReservedDBInstancesOffering]
2364
+ def reserved_db_instances_offering(id)
2365
+ ReservedDBInstancesOffering.new(
2366
+ id: id,
2367
+ client: @client
2368
+ )
2369
+ end
2334
2370
 
2335
- # @example Request syntax with placeholder values
2336
- #
2337
- # resourceswithpendingmaintenanceactions = rds.resources_with_pending_maintenance_actions({
2338
- # resource_identifier: "String",
2339
- # filters: [
2340
- # {
2341
- # name: "String", # required
2342
- # values: ["String"], # required
2343
- # },
2344
- # ],
2345
- # marker: "String",
2346
- # max_records: 1,
2347
- # })
2348
- # @param [Hash] options ({})
2349
- # @option options [String] :resource_identifier
2350
- # The ARN of a resource to return pending maintenance actions for.
2351
- # @option options [Array<Types::Filter>] :filters
2352
- # A filter that specifies one or more resources to return pending
2353
- # maintenance actions for.
2354
- #
2355
- # Supported filters:
2356
- #
2357
- # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
2358
- # Amazon Resource Names (ARNs). The results list will only include
2359
- # pending maintenance actions for the DB clusters identified by these
2360
- # ARNs.
2361
- #
2362
- # * `db-instance-id` - Accepts DB instance identifiers and DB instance
2363
- # ARNs. The results list will only include pending maintenance actions
2364
- # for the DB instances identified by these ARNs.
2365
- # @option options [String] :marker
2366
- # An optional pagination token provided by a previous
2367
- # `DescribePendingMaintenanceActions` request. If this parameter is
2368
- # specified, the response includes only records beyond the marker, up to
2369
- # a number of records specified by `MaxRecords`.
2370
- # @option options [Integer] :max_records
2371
- # The maximum number of records to include in the response. If more
2372
- # records exist than the specified `MaxRecords` value, a pagination
2373
- # token called a marker is included in the response so that the
2374
- # remaining results can be retrieved.
2375
- #
2376
- # Default: 100
2377
- #
2378
- # Constraints: Minimum 20, maximum 100.
2379
- # @return [ResourcePendingMaintenanceActionList::Collection]
2380
- def resources_with_pending_maintenance_actions(options = {})
2381
- batches = Enumerator.new do |y|
2371
+ # @example Request syntax with placeholder values
2372
+ #
2373
+ # reserved_db_instances_offerings = rds.reserved_db_instances_offerings({
2374
+ # reserved_db_instances_offering_id: "String",
2375
+ # db_instance_class: "String",
2376
+ # duration: "String",
2377
+ # product_description: "String",
2378
+ # offering_type: "String",
2379
+ # multi_az: false,
2380
+ # filters: [
2381
+ # {
2382
+ # name: "String", # required
2383
+ # values: ["String"], # required
2384
+ # },
2385
+ # ],
2386
+ # })
2387
+ # @param [Hash] options ({})
2388
+ # @option options [String] :reserved_db_instances_offering_id
2389
+ # The offering identifier filter value. Specify this parameter to show
2390
+ # only the available offering that matches the specified reservation
2391
+ # identifier.
2392
+ #
2393
+ # Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706`
2394
+ # @option options [String] :db_instance_class
2395
+ # The DB instance class filter value. Specify this parameter to show
2396
+ # only the available offerings matching the specified DB instance class.
2397
+ # @option options [String] :duration
2398
+ # Duration filter value, specified in years or seconds. Specify this
2399
+ # parameter to show only reservations for this duration.
2400
+ #
2401
+ # Valid Values: `1 | 3 | 31536000 | 94608000`
2402
+ # @option options [String] :product_description
2403
+ # Product description filter value. Specify this parameter to show only
2404
+ # the available offerings matching the specified product description.
2405
+ # @option options [String] :offering_type
2406
+ # The offering type filter value. Specify this parameter to show only
2407
+ # the available offerings matching the specified offering type.
2408
+ #
2409
+ # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
2410
+ # @option options [Boolean] :multi_az
2411
+ # The Multi-AZ filter value. Specify this parameter to show only the
2412
+ # available offerings matching the specified Multi-AZ parameter.
2413
+ # @option options [Array<Types::Filter>] :filters
2414
+ # This parameter is not currently supported.
2415
+ # @return [ReservedDBInstancesOffering::Collection]
2416
+ def reserved_db_instances_offerings(options = {})
2417
+ batches = Enumerator.new do |y|
2418
+ resp = @client.describe_reserved_db_instances_offerings(options)
2419
+ resp.each_page do |page|
2382
2420
  batch = []
2383
- resp = @client.describe_pending_maintenance_actions(options)
2384
- resp.data.pending_maintenance_actions.each do |p|
2385
- batch << ResourcePendingMaintenanceActionList.new(
2386
- arn: p.resource_identifier,
2387
- data: p,
2421
+ page.data.reserved_db_instances_offerings.each do |r|
2422
+ batch << ReservedDBInstancesOffering.new(
2423
+ id: r.reserved_db_instances_offering_id,
2424
+ data: r,
2388
2425
  client: @client
2389
2426
  )
2390
2427
  end
2391
2428
  y.yield(batch)
2392
2429
  end
2393
- ResourcePendingMaintenanceActionList::Collection.new(batches)
2394
2430
  end
2431
+ ReservedDBInstancesOffering::Collection.new(batches)
2432
+ end
2433
+
2434
+ # @param [String] arn
2435
+ # @return [ResourcePendingMaintenanceActionList]
2436
+ def resource_with_pending_maintenance_actions(arn)
2437
+ ResourcePendingMaintenanceActionList.new(
2438
+ arn: arn,
2439
+ client: @client
2440
+ )
2441
+ end
2395
2442
 
2443
+ # @example Request syntax with placeholder values
2444
+ #
2445
+ # resources_with_pending_maintenance_actions = rds.resources_with_pending_maintenance_actions({
2446
+ # resource_identifier: "String",
2447
+ # filters: [
2448
+ # {
2449
+ # name: "String", # required
2450
+ # values: ["String"], # required
2451
+ # },
2452
+ # ],
2453
+ # marker: "String",
2454
+ # max_records: 1,
2455
+ # })
2456
+ # @param [Hash] options ({})
2457
+ # @option options [String] :resource_identifier
2458
+ # The ARN of a resource to return pending maintenance actions for.
2459
+ # @option options [Array<Types::Filter>] :filters
2460
+ # A filter that specifies one or more resources to return pending
2461
+ # maintenance actions for.
2462
+ #
2463
+ # Supported filters:
2464
+ #
2465
+ # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
2466
+ # Amazon Resource Names (ARNs). The results list will only include
2467
+ # pending maintenance actions for the DB clusters identified by these
2468
+ # ARNs.
2469
+ #
2470
+ # * `db-instance-id` - Accepts DB instance identifiers and DB instance
2471
+ # ARNs. The results list will only include pending maintenance actions
2472
+ # for the DB instances identified by these ARNs.
2473
+ # @option options [String] :marker
2474
+ # An optional pagination token provided by a previous
2475
+ # `DescribePendingMaintenanceActions` request. If this parameter is
2476
+ # specified, the response includes only records beyond the marker, up to
2477
+ # a number of records specified by `MaxRecords`.
2478
+ # @option options [Integer] :max_records
2479
+ # The maximum number of records to include in the response. If more
2480
+ # records exist than the specified `MaxRecords` value, a pagination
2481
+ # token called a marker is included in the response so that the
2482
+ # remaining results can be retrieved.
2483
+ #
2484
+ # Default: 100
2485
+ #
2486
+ # Constraints: Minimum 20, maximum 100.
2487
+ # @return [ResourcePendingMaintenanceActionList::Collection]
2488
+ def resources_with_pending_maintenance_actions(options = {})
2489
+ batches = Enumerator.new do |y|
2490
+ batch = []
2491
+ resp = @client.describe_pending_maintenance_actions(options)
2492
+ resp.data.pending_maintenance_actions.each do |p|
2493
+ batch << ResourcePendingMaintenanceActionList.new(
2494
+ arn: p.resource_identifier,
2495
+ data: p,
2496
+ client: @client
2497
+ )
2498
+ end
2499
+ y.yield(batch)
2500
+ end
2501
+ ResourcePendingMaintenanceActionList::Collection.new(batches)
2396
2502
  end
2503
+
2397
2504
  end
2398
2505
  end