aws-sdk 1.13.0 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +3 -3
- data/lib/aws/api_config/OpsWorks-2013-02-18.yml +55 -0
- data/lib/aws/api_config/SNS-2010-03-31.yml +0 -3
- data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +30 -0
- data/lib/aws/auto_scaling/client.rb +0 -530
- data/lib/aws/cloud_formation/client.rb +0 -356
- data/lib/aws/cloud_front/client.rb +0 -1567
- data/lib/aws/cloud_search/client.rb +0 -578
- data/lib/aws/cloud_watch/client.rb +0 -445
- data/lib/aws/data_pipeline/client.rb +0 -396
- data/lib/aws/direct_connect/client.rb +0 -248
- data/lib/aws/dynamo_db.rb +0 -1
- data/lib/aws/dynamo_db/client.rb +70 -1
- data/lib/aws/dynamo_db/client_v2.rb +1 -1
- data/lib/aws/ec2/client.rb +0 -3942
- data/lib/aws/ec2/reserved_instances_offering_collection.rb +9 -3
- data/lib/aws/ec2/tag_collection.rb +1 -1
- data/lib/aws/elastic_beanstalk/client.rb +0 -898
- data/lib/aws/elastic_transcoder/client.rb +0 -1755
- data/lib/aws/elasticache/client.rb +0 -947
- data/lib/aws/elb/client.rb +0 -509
- data/lib/aws/emr/client.rb +0 -314
- data/lib/aws/glacier/client.rb +0 -278
- data/lib/aws/iam/client.rb +0 -1155
- data/lib/aws/import_export/client.rb +0 -96
- data/lib/aws/ops_works/client.rb +0 -1255
- data/lib/aws/rds/client.rb +0 -2367
- data/lib/aws/redshift/client.rb +0 -1458
- data/lib/aws/route_53/client.rb +0 -420
- data/lib/aws/simple_db/client.rb +2 -250
- data/lib/aws/simple_email_service/client.rb +0 -282
- data/lib/aws/simple_workflow/client.rb +0 -1248
- data/lib/aws/sns/client.rb +0 -283
- data/lib/aws/sns/message.rb +1 -1
- data/lib/aws/sqs/client.rb +0 -255
- data/lib/aws/storage_gateway/client.rb +0 -582
- data/lib/aws/sts/client.rb +0 -183
- data/lib/aws/support/client.rb +0 -232
- data/lib/aws/version.rb +1 -1
- metadata +2 -3
- data/lib/aws/dynamo_db/client_base.rb +0 -92
data/lib/aws/rds/client.rb
CHANGED
@@ -26,2373 +26,6 @@ module AWS
|
|
26
26
|
|
27
27
|
class Client::V20130515 < Client
|
28
28
|
|
29
|
-
# client methods #
|
30
|
-
|
31
|
-
# @!method add_source_identifier_to_subscription(options = {})
|
32
|
-
# Calls the AddSourceIdentifierToSubscription API operation.
|
33
|
-
# @param [Hash] options
|
34
|
-
#
|
35
|
-
# * `:subscription_name` - *required* - (String) The name of the RDS
|
36
|
-
# event notification subscription you want to add a source identifier
|
37
|
-
# to.
|
38
|
-
# * `:source_identifier` - *required* - (String) The identifier of the
|
39
|
-
# event source to be added. An identifier must begin with a letter
|
40
|
-
# and must contain only ASCII letters, digits, and hyphens; it cannot
|
41
|
-
# end with a hyphen or contain two consecutive hyphens. Constraints:
|
42
|
-
# If the source type is a DB instance, then a DBInstanceIdentifier
|
43
|
-
# must be supplied. If the source type is a DB security group, a
|
44
|
-
# DBSecurityGroupName must be supplied. If the source type is a DB
|
45
|
-
# parameter group, a DBParameterGroupName must be supplied. If the
|
46
|
-
# source type is a DB Snapshot, a DBSnapshotIdentifier must be
|
47
|
-
# supplied.
|
48
|
-
# @return [Core::Response]
|
49
|
-
# The #data method of the response object returns
|
50
|
-
# a hash with the following structure:
|
51
|
-
#
|
52
|
-
# * `:customer_aws_id` - (String)
|
53
|
-
# * `:cust_subscription_id` - (String)
|
54
|
-
# * `:sns_topic_arn` - (String)
|
55
|
-
# * `:status` - (String)
|
56
|
-
# * `:subscription_creation_time` - (String)
|
57
|
-
# * `:source_type` - (String)
|
58
|
-
# * `:source_ids_list` - (Array<String>)
|
59
|
-
# * `:event_categories_list` - (Array<String>)
|
60
|
-
# * `:enabled` - (Boolean)
|
61
|
-
|
62
|
-
# @!method add_tags_to_resource(options = {})
|
63
|
-
# Calls the AddTagsToResource API operation.
|
64
|
-
# @param [Hash] options
|
65
|
-
#
|
66
|
-
# * `:resource_name` - *required* - (String) The DB Instance the tags
|
67
|
-
# will be added to.
|
68
|
-
# * `:tags` - *required* - (Array<Hash>) The tags to be assigned to the
|
69
|
-
# DB Instance.
|
70
|
-
# * `:key` - (String) A key is the required name of the tag. The
|
71
|
-
# string value can be from 1 to 128 Unicode characters in length
|
72
|
-
# and cannot be prefixed with "aws:". The string may only contain
|
73
|
-
# only the set of Unicode letters, digits, white-space, '_', '.',
|
74
|
-
# '/', '=', '+', '-' (Java regex:
|
75
|
-
# "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
|
76
|
-
# * `:value` - (String) A value is the optional value of the tag. The
|
77
|
-
# string value can be from 1 to 256 Unicode characters in length
|
78
|
-
# and cannot be prefixed with "aws:". The string may only contain
|
79
|
-
# only the set of Unicode letters, digits, white-space, '_', '.',
|
80
|
-
# '/', '=', '+', '-' (Java regex:
|
81
|
-
# "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
|
82
|
-
# @return [Core::Response]
|
83
|
-
|
84
|
-
# @!method authorize_db_security_group_ingress(options = {})
|
85
|
-
# Calls the AuthorizeDBSecurityGroupIngress API operation.
|
86
|
-
# @param [Hash] options
|
87
|
-
#
|
88
|
-
# * `:db_security_group_name` - *required* - (String) The name of the
|
89
|
-
# DB Security Group to authorize.
|
90
|
-
# * `:cidrip` - (String) The IP range to authorize.
|
91
|
-
# * `:ec2_security_group_name` - (String) Name of the EC2 Security
|
92
|
-
# Group to authorize.
|
93
|
-
# * `:ec2_security_group_id` - (String) Id of the EC2 Security Group to
|
94
|
-
# authorize. For VPC DB Security Groups, EC2SecurityGroupId must be
|
95
|
-
# provided. Otherwise, EC2SecurityGroupOwnerId and either
|
96
|
-
# EC2SecurityGroupName or EC2SecurityGroupId must be provided.
|
97
|
-
# * `:ec2_security_group_owner_id` - (String) AWS Account Number of the
|
98
|
-
# owner of the security group specified in the EC2SecurityGroupName
|
99
|
-
# parameter. The AWS Access Key ID is not an acceptable value.
|
100
|
-
# @return [Core::Response]
|
101
|
-
# The #data method of the response object returns
|
102
|
-
# a hash with the following structure:
|
103
|
-
#
|
104
|
-
# * `:owner_id` - (String)
|
105
|
-
# * `:db_security_group_name` - (String)
|
106
|
-
# * `:db_security_group_description` - (String)
|
107
|
-
# * `:vpc_id` - (String)
|
108
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
109
|
-
# * `:status` - (String)
|
110
|
-
# * `:ec2_security_group_name` - (String)
|
111
|
-
# * `:ec2_security_group_id` - (String)
|
112
|
-
# * `:ec2_security_group_owner_id` - (String)
|
113
|
-
# * `:ip_ranges` - (Array<Hash>)
|
114
|
-
# * `:status` - (String)
|
115
|
-
# * `:cidrip` - (String)
|
116
|
-
|
117
|
-
# @!method copy_db_snapshot(options = {})
|
118
|
-
# Calls the CopyDBSnapshot API operation.
|
119
|
-
# @param [Hash] options
|
120
|
-
#
|
121
|
-
# * `:source_db_snapshot_identifier` - *required* - (String) The
|
122
|
-
# identifier for the source DB snapshot. Constraints: Must be the
|
123
|
-
# identifier for a valid automated snapshot in the "available" state.
|
124
|
-
# Example: rds:mydb-2012-01-15-00-01
|
125
|
-
# * `:target_db_snapshot_identifier` - *required* - (String) The
|
126
|
-
# identifier for the copied snapshot. Constraints: Cannot be null,
|
127
|
-
# empty, or blank Must contain from 1 to 255 alphanumeric characters
|
128
|
-
# or hyphens First character must be a letter Cannot end with a
|
129
|
-
# hyphen or contain two consecutive hyphens Example: my-db-snapshot
|
130
|
-
# @return [Core::Response]
|
131
|
-
# The #data method of the response object returns
|
132
|
-
# a hash with the following structure:
|
133
|
-
#
|
134
|
-
# * `:db_snapshot_identifier` - (String)
|
135
|
-
# * `:db_instance_identifier` - (String)
|
136
|
-
# * `:snapshot_create_time` - (Time)
|
137
|
-
# * `:engine` - (String)
|
138
|
-
# * `:allocated_storage` - (Integer)
|
139
|
-
# * `:status` - (String)
|
140
|
-
# * `:port` - (Integer)
|
141
|
-
# * `:availability_zone` - (String)
|
142
|
-
# * `:vpc_id` - (String)
|
143
|
-
# * `:instance_create_time` - (Time)
|
144
|
-
# * `:master_username` - (String)
|
145
|
-
# * `:engine_version` - (String)
|
146
|
-
# * `:license_model` - (String)
|
147
|
-
# * `:snapshot_type` - (String)
|
148
|
-
# * `:iops` - (Integer)
|
149
|
-
# * `:option_group_name` - (String)
|
150
|
-
|
151
|
-
# @!method create_db_instance(options = {})
|
152
|
-
# Calls the CreateDBInstance API operation.
|
153
|
-
# @param [Hash] options
|
154
|
-
#
|
155
|
-
# * `:db_name` - (String) The name of the database to create when the
|
156
|
-
# DB Instance is created. If this parameter is not specified, no
|
157
|
-
# database is created in the DB Instance.
|
158
|
-
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
159
|
-
# identifier. This parameter is stored as a lowercase string.
|
160
|
-
# * `:allocated_storage` - *required* - (Integer) The amount of storage
|
161
|
-
# (in gigabytes) to be initially allocated for the database instance.
|
162
|
-
# * `:db_instance_class` - *required* - (String) The compute and memory
|
163
|
-
# capacity of the DB Instance.
|
164
|
-
# * `:engine` - *required* - (String) The name of the database engine
|
165
|
-
# to be used for this instance.
|
166
|
-
# * `:master_username` - *required* - (String) The name of master user
|
167
|
-
# for the client DB Instance.
|
168
|
-
# * `:master_user_password` - *required* - (String) The password for
|
169
|
-
# the master DB Instance user.
|
170
|
-
# * `:db_security_groups` - (Array<String>) A list of DB Security
|
171
|
-
# Groups to associate with this DB Instance.
|
172
|
-
# * `:vpc_security_group_ids` - (Array<String>) A list of Ec2 Vpc
|
173
|
-
# Security Groups to associate with this DB Instance. Default: The
|
174
|
-
# default Ec2 Vpc Security Group for the DB Subnet group's Vpc.
|
175
|
-
# * `:availability_zone` - (String) The EC2 Availability Zone that the
|
176
|
-
# database instance will be created in.
|
177
|
-
# * `:db_subnet_group_name` - (String) A DB Subnet Group to associate
|
178
|
-
# with this DB Instance. If there is no DB Subnet Group, then it is a
|
179
|
-
# non-VPC DB instance.
|
180
|
-
# * `:preferred_maintenance_window` - (String) The weekly time range
|
181
|
-
# (in UTC) during which system maintenance can occur.
|
182
|
-
# * `:db_parameter_group_name` - (String) The name of the database
|
183
|
-
# parameter group to associate with this DB instance. If this
|
184
|
-
# argument is omitted, the default DBParameterGroup for the specified
|
185
|
-
# engine will be used.
|
186
|
-
# * `:backup_retention_period` - (Integer) The number of days for which
|
187
|
-
# automated backups are retained. Setting this parameter to a
|
188
|
-
# positive number enables backups. Setting this parameter to 0
|
189
|
-
# disables automated backups.
|
190
|
-
# * `:preferred_backup_window` - (String) The daily time range during
|
191
|
-
# which automated backups are created if automated backups are
|
192
|
-
# enabled, as determined by the BackupRetentionPeriod.
|
193
|
-
# * `:port` - (Integer) The port number on which the database accepts
|
194
|
-
# connections.
|
195
|
-
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
196
|
-
# deployment. You cannot set the AvailabilityZone parameter if the
|
197
|
-
# MultiAZ parameter is set to `true` .
|
198
|
-
# * `:engine_version` - (String) The version number of the database
|
199
|
-
# engine to use. Example: 5.1.42
|
200
|
-
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
201
|
-
# engine upgrades will be applied automatically to the DB Instance
|
202
|
-
# during the maintenance window. Default: `true`
|
203
|
-
# * `:license_model` - (String) License model information for this DB
|
204
|
-
# Instance. Valid values: license-included | bring-your-own-license |
|
205
|
-
# general-public-license
|
206
|
-
# * `:iops` - (Integer) The amount of provisioned input/output
|
207
|
-
# operations per second to be initially allocated for the database
|
208
|
-
# instance. Constraints: Must be an integer Type: Integer
|
209
|
-
# * `:option_group_name` - (String) Indicates that the DB Instance
|
210
|
-
# should be associated with the specified option group.
|
211
|
-
# * `:character_set_name` - (String) For supported engines, indicates
|
212
|
-
# that the DB Instance should be associated with the specified
|
213
|
-
# CharacterSet.
|
214
|
-
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
215
|
-
# options for the DB Instance. A value of `true` specifies an
|
216
|
-
# Internet-facing instance with a publicly resolvable DNS name, which
|
217
|
-
# resolves to a public IP address. A value of `false` specifies an
|
218
|
-
# internal instance with a DNS name that resolves to a private IP
|
219
|
-
# address. Default: The default behavior varies depending on whether
|
220
|
-
# a VPC has been requested or not. The following list shows the
|
221
|
-
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
222
|
-
# no DB subnet group has been specified as part of the request and
|
223
|
-
# the PubliclyAccessible value has not been set, the DB instance will
|
224
|
-
# be publicly accessible. If a specific DB subnet group has been
|
225
|
-
# specified as part of the request and the PubliclyAccessible value
|
226
|
-
# has not been set, the DB instance will be private.
|
227
|
-
# @return [Core::Response]
|
228
|
-
# The #data method of the response object returns
|
229
|
-
# a hash with the following structure:
|
230
|
-
#
|
231
|
-
# * `:db_instance_identifier` - (String)
|
232
|
-
# * `:db_instance_class` - (String)
|
233
|
-
# * `:engine` - (String)
|
234
|
-
# * `:db_instance_status` - (String)
|
235
|
-
# * `:master_username` - (String)
|
236
|
-
# * `:db_name` - (String)
|
237
|
-
# * `:endpoint` - (Hash)
|
238
|
-
# * `:address` - (String)
|
239
|
-
# * `:port` - (Integer)
|
240
|
-
# * `:allocated_storage` - (Integer)
|
241
|
-
# * `:instance_create_time` - (Time)
|
242
|
-
# * `:preferred_backup_window` - (String)
|
243
|
-
# * `:backup_retention_period` - (Integer)
|
244
|
-
# * `:db_security_groups` - (Array<Hash>)
|
245
|
-
# * `:db_security_group_name` - (String)
|
246
|
-
# * `:status` - (String)
|
247
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
248
|
-
# * `:vpc_security_group_id` - (String)
|
249
|
-
# * `:status` - (String)
|
250
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
251
|
-
# * `:db_parameter_group_name` - (String)
|
252
|
-
# * `:parameter_apply_status` - (String)
|
253
|
-
# * `:availability_zone` - (String)
|
254
|
-
# * `:db_subnet_group` - (Hash)
|
255
|
-
# * `:db_subnet_group_name` - (String)
|
256
|
-
# * `:db_subnet_group_description` - (String)
|
257
|
-
# * `:vpc_id` - (String)
|
258
|
-
# * `:subnet_group_status` - (String)
|
259
|
-
# * `:subnets` - (Array<Hash>)
|
260
|
-
# * `:subnet_identifier` - (String)
|
261
|
-
# * `:subnet_availability_zone` - (Hash)
|
262
|
-
# * `:name` - (String)
|
263
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
264
|
-
# * `:subnet_status` - (String)
|
265
|
-
# * `:preferred_maintenance_window` - (String)
|
266
|
-
# * `:pending_modified_values` - (Hash)
|
267
|
-
# * `:db_instance_class` - (String)
|
268
|
-
# * `:allocated_storage` - (Integer)
|
269
|
-
# * `:master_user_password` - (String)
|
270
|
-
# * `:port` - (Integer)
|
271
|
-
# * `:backup_retention_period` - (Integer)
|
272
|
-
# * `:multi_az` - (Boolean)
|
273
|
-
# * `:engine_version` - (String)
|
274
|
-
# * `:iops` - (Integer)
|
275
|
-
# * `:db_instance_identifier` - (String)
|
276
|
-
# * `:latest_restorable_time` - (Time)
|
277
|
-
# * `:multi_az` - (Boolean)
|
278
|
-
# * `:engine_version` - (String)
|
279
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
280
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
281
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
282
|
-
# * `:license_model` - (String)
|
283
|
-
# * `:iops` - (Integer)
|
284
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
285
|
-
# * `:option_group_name` - (String)
|
286
|
-
# * `:status` - (String)
|
287
|
-
# * `:character_set_name` - (String)
|
288
|
-
# * `:secondary_availability_zone` - (String)
|
289
|
-
# * `:publicly_accessible` - (Boolean)
|
290
|
-
# * `:status_infos` - (Array<Hash>)
|
291
|
-
# * `:status_type` - (String)
|
292
|
-
# * `:normal` - (Boolean)
|
293
|
-
# * `:status` - (String)
|
294
|
-
# * `:message` - (String)
|
295
|
-
|
296
|
-
# @!method create_db_instance_read_replica(options = {})
|
297
|
-
# Calls the CreateDBInstanceReadReplica API operation.
|
298
|
-
# @param [Hash] options
|
299
|
-
#
|
300
|
-
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
301
|
-
# identifier of the Read Replica. This is the unique key that
|
302
|
-
# identifies a DB Instance. This parameter is stored as a lowercase
|
303
|
-
# string.
|
304
|
-
# * `:source_db_instance_identifier` - *required* - (String) The
|
305
|
-
# identifier of the DB Instance that will act as the source for the
|
306
|
-
# Read Replica. Each DB Instance can have up to five Read Replicas.
|
307
|
-
# Constraints: Must be the identifier of an existing DB Instance that
|
308
|
-
# is not already a Read Replica DB Instance.
|
309
|
-
# * `:db_instance_class` - (String) The compute and memory capacity of
|
310
|
-
# the Read Replica. Valid Values: db.m1.small | db.m1.large |
|
311
|
-
# db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge Default:
|
312
|
-
# Inherits from the source DB Instance.
|
313
|
-
# * `:availability_zone` - (String) The Amazon EC2 Availability Zone
|
314
|
-
# that the Read Replica will be created in. Default: A random,
|
315
|
-
# system-chosen Availability Zone in the endpoint's region. Example:
|
316
|
-
# us-east-1d
|
317
|
-
# * `:port` - (Integer) The port number that the DB Instance uses for
|
318
|
-
# connections. Default: Inherits from the source DB Instance Valid
|
319
|
-
# Values: 1150-65535
|
320
|
-
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
321
|
-
# engine upgrades will be applied automatically to the Read Replica
|
322
|
-
# during the maintenance window. Default: Inherits from the source DB
|
323
|
-
# Instance
|
324
|
-
# * `:iops` - (Integer) The amount of Provisioned IOPS (input/output
|
325
|
-
# operations per second) to be initially allocated for the DB
|
326
|
-
# Instance.
|
327
|
-
# * `:option_group_name` - (String) The option group the DB instance
|
328
|
-
# will be associated with. If omitted, the default Option Group for
|
329
|
-
# the engine specified will be used.
|
330
|
-
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
331
|
-
# options for the DB Instance. A value of `true` specifies an
|
332
|
-
# Internet-facing instance with a publicly resolvable DNS name, which
|
333
|
-
# resolves to a public IP address. A value of `false` specifies an
|
334
|
-
# internal instance with a DNS name that resolves to a private IP
|
335
|
-
# address. Default: The default behavior varies depending on whether
|
336
|
-
# a VPC has been requested or not. The following list shows the
|
337
|
-
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
338
|
-
# no DB subnet group has been specified as part of the request and
|
339
|
-
# the PubliclyAccessible value has not been set, the DB instance will
|
340
|
-
# be publicly accessible. If a specific DB subnet group has been
|
341
|
-
# specified as part of the request and the PubliclyAccessible value
|
342
|
-
# has not been set, the DB instance will be private.
|
343
|
-
# @return [Core::Response]
|
344
|
-
# The #data method of the response object returns
|
345
|
-
# a hash with the following structure:
|
346
|
-
#
|
347
|
-
# * `:db_instance_identifier` - (String)
|
348
|
-
# * `:db_instance_class` - (String)
|
349
|
-
# * `:engine` - (String)
|
350
|
-
# * `:db_instance_status` - (String)
|
351
|
-
# * `:master_username` - (String)
|
352
|
-
# * `:db_name` - (String)
|
353
|
-
# * `:endpoint` - (Hash)
|
354
|
-
# * `:address` - (String)
|
355
|
-
# * `:port` - (Integer)
|
356
|
-
# * `:allocated_storage` - (Integer)
|
357
|
-
# * `:instance_create_time` - (Time)
|
358
|
-
# * `:preferred_backup_window` - (String)
|
359
|
-
# * `:backup_retention_period` - (Integer)
|
360
|
-
# * `:db_security_groups` - (Array<Hash>)
|
361
|
-
# * `:db_security_group_name` - (String)
|
362
|
-
# * `:status` - (String)
|
363
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
364
|
-
# * `:vpc_security_group_id` - (String)
|
365
|
-
# * `:status` - (String)
|
366
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
367
|
-
# * `:db_parameter_group_name` - (String)
|
368
|
-
# * `:parameter_apply_status` - (String)
|
369
|
-
# * `:availability_zone` - (String)
|
370
|
-
# * `:db_subnet_group` - (Hash)
|
371
|
-
# * `:db_subnet_group_name` - (String)
|
372
|
-
# * `:db_subnet_group_description` - (String)
|
373
|
-
# * `:vpc_id` - (String)
|
374
|
-
# * `:subnet_group_status` - (String)
|
375
|
-
# * `:subnets` - (Array<Hash>)
|
376
|
-
# * `:subnet_identifier` - (String)
|
377
|
-
# * `:subnet_availability_zone` - (Hash)
|
378
|
-
# * `:name` - (String)
|
379
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
380
|
-
# * `:subnet_status` - (String)
|
381
|
-
# * `:preferred_maintenance_window` - (String)
|
382
|
-
# * `:pending_modified_values` - (Hash)
|
383
|
-
# * `:db_instance_class` - (String)
|
384
|
-
# * `:allocated_storage` - (Integer)
|
385
|
-
# * `:master_user_password` - (String)
|
386
|
-
# * `:port` - (Integer)
|
387
|
-
# * `:backup_retention_period` - (Integer)
|
388
|
-
# * `:multi_az` - (Boolean)
|
389
|
-
# * `:engine_version` - (String)
|
390
|
-
# * `:iops` - (Integer)
|
391
|
-
# * `:db_instance_identifier` - (String)
|
392
|
-
# * `:latest_restorable_time` - (Time)
|
393
|
-
# * `:multi_az` - (Boolean)
|
394
|
-
# * `:engine_version` - (String)
|
395
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
396
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
397
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
398
|
-
# * `:license_model` - (String)
|
399
|
-
# * `:iops` - (Integer)
|
400
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
401
|
-
# * `:option_group_name` - (String)
|
402
|
-
# * `:status` - (String)
|
403
|
-
# * `:character_set_name` - (String)
|
404
|
-
# * `:secondary_availability_zone` - (String)
|
405
|
-
# * `:publicly_accessible` - (Boolean)
|
406
|
-
# * `:status_infos` - (Array<Hash>)
|
407
|
-
# * `:status_type` - (String)
|
408
|
-
# * `:normal` - (Boolean)
|
409
|
-
# * `:status` - (String)
|
410
|
-
# * `:message` - (String)
|
411
|
-
|
412
|
-
# @!method create_db_parameter_group(options = {})
|
413
|
-
# Calls the CreateDBParameterGroup API operation.
|
414
|
-
# @param [Hash] options
|
415
|
-
#
|
416
|
-
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
417
|
-
# DB Parameter Group.
|
418
|
-
# * `:db_parameter_group_family` - *required* - (String) The name of
|
419
|
-
# the DB Parameter Group Family the DB Parameter Group can be used
|
420
|
-
# with.
|
421
|
-
# * `:description` - *required* - (String) The description for the DB
|
422
|
-
# Parameter Group.
|
423
|
-
# @return [Core::Response]
|
424
|
-
# The #data method of the response object returns
|
425
|
-
# a hash with the following structure:
|
426
|
-
#
|
427
|
-
# * `:db_parameter_group_name` - (String)
|
428
|
-
# * `:db_parameter_group_family` - (String)
|
429
|
-
# * `:description` - (String)
|
430
|
-
|
431
|
-
# @!method create_db_security_group(options = {})
|
432
|
-
# Calls the CreateDBSecurityGroup API operation.
|
433
|
-
# @param [Hash] options
|
434
|
-
#
|
435
|
-
# * `:db_security_group_name` - *required* - (String) The name for the
|
436
|
-
# DB Security Group. This value is stored as a lowercase string.
|
437
|
-
# * `:db_security_group_description` - *required* - (String) The
|
438
|
-
# description for the DB Security Group.
|
439
|
-
# @return [Core::Response]
|
440
|
-
# The #data method of the response object returns
|
441
|
-
# a hash with the following structure:
|
442
|
-
#
|
443
|
-
# * `:owner_id` - (String)
|
444
|
-
# * `:db_security_group_name` - (String)
|
445
|
-
# * `:db_security_group_description` - (String)
|
446
|
-
# * `:vpc_id` - (String)
|
447
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
448
|
-
# * `:status` - (String)
|
449
|
-
# * `:ec2_security_group_name` - (String)
|
450
|
-
# * `:ec2_security_group_id` - (String)
|
451
|
-
# * `:ec2_security_group_owner_id` - (String)
|
452
|
-
# * `:ip_ranges` - (Array<Hash>)
|
453
|
-
# * `:status` - (String)
|
454
|
-
# * `:cidrip` - (String)
|
455
|
-
|
456
|
-
# @!method create_db_snapshot(options = {})
|
457
|
-
# Calls the CreateDBSnapshot API operation.
|
458
|
-
# @param [Hash] options
|
459
|
-
#
|
460
|
-
# * `:db_snapshot_identifier` - *required* - (String) The identifier
|
461
|
-
# for the DB Snapshot.
|
462
|
-
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
463
|
-
# identifier. This is the unique key that identifies a DB Instance.
|
464
|
-
# This parameter isn't case sensitive.
|
465
|
-
# @return [Core::Response]
|
466
|
-
# The #data method of the response object returns
|
467
|
-
# a hash with the following structure:
|
468
|
-
#
|
469
|
-
# * `:db_snapshot_identifier` - (String)
|
470
|
-
# * `:db_instance_identifier` - (String)
|
471
|
-
# * `:snapshot_create_time` - (Time)
|
472
|
-
# * `:engine` - (String)
|
473
|
-
# * `:allocated_storage` - (Integer)
|
474
|
-
# * `:status` - (String)
|
475
|
-
# * `:port` - (Integer)
|
476
|
-
# * `:availability_zone` - (String)
|
477
|
-
# * `:vpc_id` - (String)
|
478
|
-
# * `:instance_create_time` - (Time)
|
479
|
-
# * `:master_username` - (String)
|
480
|
-
# * `:engine_version` - (String)
|
481
|
-
# * `:license_model` - (String)
|
482
|
-
# * `:snapshot_type` - (String)
|
483
|
-
# * `:iops` - (Integer)
|
484
|
-
# * `:option_group_name` - (String)
|
485
|
-
|
486
|
-
# @!method create_db_subnet_group(options = {})
|
487
|
-
# Calls the CreateDBSubnetGroup API operation.
|
488
|
-
# @param [Hash] options
|
489
|
-
#
|
490
|
-
# * `:db_subnet_group_name` - *required* - (String) The name for the DB
|
491
|
-
# Subnet Group. This value is stored as a lowercase string.
|
492
|
-
# Constraints: Must contain no more than 255 alphanumeric characters
|
493
|
-
# or hyphens. Must not be "Default". Example: mySubnetgroup
|
494
|
-
# * `:db_subnet_group_description` - *required* - (String) The
|
495
|
-
# description for the DB Subnet Group.
|
496
|
-
# * `:subnet_ids` - *required* - (Array<String>) The EC2 Subnet IDs for
|
497
|
-
# the DB Subnet Group.
|
498
|
-
# @return [Core::Response]
|
499
|
-
# The #data method of the response object returns
|
500
|
-
# a hash with the following structure:
|
501
|
-
#
|
502
|
-
# * `:db_subnet_group_name` - (String)
|
503
|
-
# * `:db_subnet_group_description` - (String)
|
504
|
-
# * `:vpc_id` - (String)
|
505
|
-
# * `:subnet_group_status` - (String)
|
506
|
-
# * `:subnets` - (Array<Hash>)
|
507
|
-
# * `:subnet_identifier` - (String)
|
508
|
-
# * `:subnet_availability_zone` - (Hash)
|
509
|
-
# * `:name` - (String)
|
510
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
511
|
-
# * `:subnet_status` - (String)
|
512
|
-
|
513
|
-
# @!method create_event_subscription(options = {})
|
514
|
-
# Calls the CreateEventSubscription API operation.
|
515
|
-
# @param [Hash] options
|
516
|
-
#
|
517
|
-
# * `:subscription_name` - *required* - (String) The name of the
|
518
|
-
# subscription. Constraints: The name must be less than 255
|
519
|
-
# characters.
|
520
|
-
# * `:sns_topic_arn` - *required* - (String) The Amazon Resource Name
|
521
|
-
# (ARN) of the SNS topic created for event notification. The ARN is
|
522
|
-
# created by Amazon SNS when you create a topic and subscribe to it.
|
523
|
-
# * `:source_type` - (String) The type of source that will be
|
524
|
-
# generating the events. For example, if you want to be notified of
|
525
|
-
# events generated by a DB instance, you would set this parameter to
|
526
|
-
# db-instance. if this value is not specified, all events are
|
527
|
-
# returned. Valid values: db-instance | db-parameter-group |
|
528
|
-
# db-security-group | db-snapshot
|
529
|
-
# * `:event_categories` - (Array<String>) A list of event categories
|
530
|
-
# for a SourceType that you want to subscribe to. You can see a list
|
531
|
-
# of the categories for a given SourceType in the Events topic in the
|
532
|
-
# Amazon RDS User Guide or by using the DescribeEventCategories
|
533
|
-
# action.
|
534
|
-
# * `:source_ids` - (Array<String>) The list of identifiers of the
|
535
|
-
# event sources for which events will be returned. If not specified,
|
536
|
-
# then all sources are included in the response. An identifier must
|
537
|
-
# begin with a letter and must contain only ASCII letters, digits,
|
538
|
-
# and hyphens; it cannot end with a hyphen or contain two consecutive
|
539
|
-
# hyphens. Constraints: If SourceIds are supplied, SourceType must
|
540
|
-
# also be provided. If the source type is a DB instance, then a
|
541
|
-
# DBInstanceIdentifier must be supplied. If the source type is a DB
|
542
|
-
# security group, a DBSecurityGroupName must be supplied. If the
|
543
|
-
# source type is a DB parameter group, a DBParameterGroupName must be
|
544
|
-
# supplied. If the source type is a DB Snapshot, a
|
545
|
-
# DBSnapshotIdentifier must be supplied.
|
546
|
-
# * `:enabled` - (Boolean) A Boolean value; set to `true` to activate
|
547
|
-
# the subscription, set to `false` to create the subscription but not
|
548
|
-
# active it.
|
549
|
-
# @return [Core::Response]
|
550
|
-
# The #data method of the response object returns
|
551
|
-
# a hash with the following structure:
|
552
|
-
#
|
553
|
-
# * `:customer_aws_id` - (String)
|
554
|
-
# * `:cust_subscription_id` - (String)
|
555
|
-
# * `:sns_topic_arn` - (String)
|
556
|
-
# * `:status` - (String)
|
557
|
-
# * `:subscription_creation_time` - (String)
|
558
|
-
# * `:source_type` - (String)
|
559
|
-
# * `:source_ids_list` - (Array<String>)
|
560
|
-
# * `:event_categories_list` - (Array<String>)
|
561
|
-
# * `:enabled` - (Boolean)
|
562
|
-
|
563
|
-
# @!method create_option_group(options = {})
|
564
|
-
# Calls the CreateOptionGroup API operation.
|
565
|
-
# @param [Hash] options
|
566
|
-
#
|
567
|
-
# * `:option_group_name` - *required* - (String) Specifies the name of
|
568
|
-
# the option group to be created. Constraints: Must be 1 to 255
|
569
|
-
# alphanumeric characters or hyphens First character must be a letter
|
570
|
-
# Cannot end with a hyphen or contain two consecutive hyphens
|
571
|
-
# Example: myOptiongroup
|
572
|
-
# * `:engine_name` - *required* - (String) Specifies the name of the
|
573
|
-
# engine that this option group should be associated with.
|
574
|
-
# * `:major_engine_version` - *required* - (String) Specifies the major
|
575
|
-
# version of the engine that this option group should be associated
|
576
|
-
# with.
|
577
|
-
# * `:option_group_description` - *required* - (String) The description
|
578
|
-
# of the option group.
|
579
|
-
# @return [Core::Response]
|
580
|
-
# The #data method of the response object returns
|
581
|
-
# a hash with the following structure:
|
582
|
-
#
|
583
|
-
# * `:option_group_name` - (String)
|
584
|
-
# * `:option_group_description` - (String)
|
585
|
-
# * `:engine_name` - (String)
|
586
|
-
# * `:major_engine_version` - (String)
|
587
|
-
# * `:options` - (Array<Hash>)
|
588
|
-
# * `:option_name` - (String)
|
589
|
-
# * `:option_description` - (String)
|
590
|
-
# * `:persistent` - (Boolean)
|
591
|
-
# * `:permanent` - (Boolean)
|
592
|
-
# * `:port` - (Integer)
|
593
|
-
# * `:option_settings` - (Array<Hash>)
|
594
|
-
# * `:name` - (String)
|
595
|
-
# * `:value` - (String)
|
596
|
-
# * `:default_value` - (String)
|
597
|
-
# * `:description` - (String)
|
598
|
-
# * `:apply_type` - (String)
|
599
|
-
# * `:data_type` - (String)
|
600
|
-
# * `:allowed_values` - (String)
|
601
|
-
# * `:is_modifiable` - (Boolean)
|
602
|
-
# * `:is_collection` - (Boolean)
|
603
|
-
# * `:db_security_group_memberships` - (Array<Hash>)
|
604
|
-
# * `:db_security_group_name` - (String)
|
605
|
-
# * `:status` - (String)
|
606
|
-
# * `:vpc_security_group_memberships` - (Array<Hash>)
|
607
|
-
# * `:vpc_security_group_id` - (String)
|
608
|
-
# * `:status` - (String)
|
609
|
-
# * `:allows_vpc_and_non_vpc_instance_memberships` - (Boolean)
|
610
|
-
# * `:vpc_id` - (String)
|
611
|
-
|
612
|
-
# @!method delete_db_instance(options = {})
|
613
|
-
# Calls the DeleteDBInstance API operation.
|
614
|
-
# @param [Hash] options
|
615
|
-
#
|
616
|
-
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
617
|
-
# identifier for the DB Instance to be deleted. This parameter isn't
|
618
|
-
# case sensitive.
|
619
|
-
# * `:skip_final_snapshot` - (Boolean)
|
620
|
-
# * `:final_db_snapshot_identifier` - (String) Determines whether a
|
621
|
-
# final DB Snapshot is created before the DB Instance is deleted. If
|
622
|
-
# `true` , no DBSnapshot is created. If `false` , a DB Snapshot is
|
623
|
-
# created before the DB Instance is deleted.
|
624
|
-
# @return [Core::Response]
|
625
|
-
# The #data method of the response object returns
|
626
|
-
# a hash with the following structure:
|
627
|
-
#
|
628
|
-
# * `:db_instance_identifier` - (String)
|
629
|
-
# * `:db_instance_class` - (String)
|
630
|
-
# * `:engine` - (String)
|
631
|
-
# * `:db_instance_status` - (String)
|
632
|
-
# * `:master_username` - (String)
|
633
|
-
# * `:db_name` - (String)
|
634
|
-
# * `:endpoint` - (Hash)
|
635
|
-
# * `:address` - (String)
|
636
|
-
# * `:port` - (Integer)
|
637
|
-
# * `:allocated_storage` - (Integer)
|
638
|
-
# * `:instance_create_time` - (Time)
|
639
|
-
# * `:preferred_backup_window` - (String)
|
640
|
-
# * `:backup_retention_period` - (Integer)
|
641
|
-
# * `:db_security_groups` - (Array<Hash>)
|
642
|
-
# * `:db_security_group_name` - (String)
|
643
|
-
# * `:status` - (String)
|
644
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
645
|
-
# * `:vpc_security_group_id` - (String)
|
646
|
-
# * `:status` - (String)
|
647
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
648
|
-
# * `:db_parameter_group_name` - (String)
|
649
|
-
# * `:parameter_apply_status` - (String)
|
650
|
-
# * `:availability_zone` - (String)
|
651
|
-
# * `:db_subnet_group` - (Hash)
|
652
|
-
# * `:db_subnet_group_name` - (String)
|
653
|
-
# * `:db_subnet_group_description` - (String)
|
654
|
-
# * `:vpc_id` - (String)
|
655
|
-
# * `:subnet_group_status` - (String)
|
656
|
-
# * `:subnets` - (Array<Hash>)
|
657
|
-
# * `:subnet_identifier` - (String)
|
658
|
-
# * `:subnet_availability_zone` - (Hash)
|
659
|
-
# * `:name` - (String)
|
660
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
661
|
-
# * `:subnet_status` - (String)
|
662
|
-
# * `:preferred_maintenance_window` - (String)
|
663
|
-
# * `:pending_modified_values` - (Hash)
|
664
|
-
# * `:db_instance_class` - (String)
|
665
|
-
# * `:allocated_storage` - (Integer)
|
666
|
-
# * `:master_user_password` - (String)
|
667
|
-
# * `:port` - (Integer)
|
668
|
-
# * `:backup_retention_period` - (Integer)
|
669
|
-
# * `:multi_az` - (Boolean)
|
670
|
-
# * `:engine_version` - (String)
|
671
|
-
# * `:iops` - (Integer)
|
672
|
-
# * `:db_instance_identifier` - (String)
|
673
|
-
# * `:latest_restorable_time` - (Time)
|
674
|
-
# * `:multi_az` - (Boolean)
|
675
|
-
# * `:engine_version` - (String)
|
676
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
677
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
678
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
679
|
-
# * `:license_model` - (String)
|
680
|
-
# * `:iops` - (Integer)
|
681
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
682
|
-
# * `:option_group_name` - (String)
|
683
|
-
# * `:status` - (String)
|
684
|
-
# * `:character_set_name` - (String)
|
685
|
-
# * `:secondary_availability_zone` - (String)
|
686
|
-
# * `:publicly_accessible` - (Boolean)
|
687
|
-
# * `:status_infos` - (Array<Hash>)
|
688
|
-
# * `:status_type` - (String)
|
689
|
-
# * `:normal` - (Boolean)
|
690
|
-
# * `:status` - (String)
|
691
|
-
# * `:message` - (String)
|
692
|
-
|
693
|
-
# @!method delete_db_parameter_group(options = {})
|
694
|
-
# Calls the DeleteDBParameterGroup API operation.
|
695
|
-
# @param [Hash] options
|
696
|
-
#
|
697
|
-
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
698
|
-
# DB Parameter Group. The specified database security group must not
|
699
|
-
# be associated with any DB instances.
|
700
|
-
# @return [Core::Response]
|
701
|
-
|
702
|
-
# @!method delete_db_security_group(options = {})
|
703
|
-
# Calls the DeleteDBSecurityGroup API operation.
|
704
|
-
# @param [Hash] options
|
705
|
-
#
|
706
|
-
# * `:db_security_group_name` - *required* - (String) The name of the
|
707
|
-
# database security group to delete.
|
708
|
-
# @return [Core::Response]
|
709
|
-
|
710
|
-
# @!method delete_db_snapshot(options = {})
|
711
|
-
# Calls the DeleteDBSnapshot API operation.
|
712
|
-
# @param [Hash] options
|
713
|
-
#
|
714
|
-
# * `:db_snapshot_identifier` - *required* - (String) The DBSnapshot
|
715
|
-
# identifier.
|
716
|
-
# @return [Core::Response]
|
717
|
-
# The #data method of the response object returns
|
718
|
-
# a hash with the following structure:
|
719
|
-
#
|
720
|
-
# * `:db_snapshot_identifier` - (String)
|
721
|
-
# * `:db_instance_identifier` - (String)
|
722
|
-
# * `:snapshot_create_time` - (Time)
|
723
|
-
# * `:engine` - (String)
|
724
|
-
# * `:allocated_storage` - (Integer)
|
725
|
-
# * `:status` - (String)
|
726
|
-
# * `:port` - (Integer)
|
727
|
-
# * `:availability_zone` - (String)
|
728
|
-
# * `:vpc_id` - (String)
|
729
|
-
# * `:instance_create_time` - (Time)
|
730
|
-
# * `:master_username` - (String)
|
731
|
-
# * `:engine_version` - (String)
|
732
|
-
# * `:license_model` - (String)
|
733
|
-
# * `:snapshot_type` - (String)
|
734
|
-
# * `:iops` - (Integer)
|
735
|
-
# * `:option_group_name` - (String)
|
736
|
-
|
737
|
-
# @!method delete_db_subnet_group(options = {})
|
738
|
-
# Calls the DeleteDBSubnetGroup API operation.
|
739
|
-
# @param [Hash] options
|
740
|
-
#
|
741
|
-
# * `:db_subnet_group_name` - *required* - (String) The name of the
|
742
|
-
# database subnet group to delete. You cannot delete the default
|
743
|
-
# subnet group. Constraints: Must be 1 to 255 alphanumeric characters
|
744
|
-
# First character must be a letter Cannot end with a hyphen or
|
745
|
-
# contain two consecutive hyphens
|
746
|
-
# @return [Core::Response]
|
747
|
-
|
748
|
-
# @!method delete_event_subscription(options = {})
|
749
|
-
# Calls the DeleteEventSubscription API operation.
|
750
|
-
# @param [Hash] options
|
751
|
-
#
|
752
|
-
# * `:subscription_name` - *required* - (String) The name of the RDS
|
753
|
-
# event notification subscription you want to delete.
|
754
|
-
# @return [Core::Response]
|
755
|
-
# The #data method of the response object returns
|
756
|
-
# a hash with the following structure:
|
757
|
-
#
|
758
|
-
# * `:customer_aws_id` - (String)
|
759
|
-
# * `:cust_subscription_id` - (String)
|
760
|
-
# * `:sns_topic_arn` - (String)
|
761
|
-
# * `:status` - (String)
|
762
|
-
# * `:subscription_creation_time` - (String)
|
763
|
-
# * `:source_type` - (String)
|
764
|
-
# * `:source_ids_list` - (Array<String>)
|
765
|
-
# * `:event_categories_list` - (Array<String>)
|
766
|
-
# * `:enabled` - (Boolean)
|
767
|
-
|
768
|
-
# @!method delete_option_group(options = {})
|
769
|
-
# Calls the DeleteOptionGroup API operation.
|
770
|
-
# @param [Hash] options
|
771
|
-
#
|
772
|
-
# * `:option_group_name` - *required* - (String) The name of the option
|
773
|
-
# group to be deleted. You cannot delete default Option Groups.
|
774
|
-
# @return [Core::Response]
|
775
|
-
|
776
|
-
# @!method describe_db_engine_versions(options = {})
|
777
|
-
# Calls the DescribeDBEngineVersions API operation.
|
778
|
-
# @param [Hash] options
|
779
|
-
#
|
780
|
-
# * `:engine` - (String) The database engine to return.
|
781
|
-
# * `:engine_version` - (String) The database engine version to return.
|
782
|
-
# * `:db_parameter_group_family` - (String) The name of a specific
|
783
|
-
# database parameter group family to return details for. Constraints:
|
784
|
-
# Must be 1 to 255 alphanumeric characters First character must be a
|
785
|
-
# letter Cannot end with a hyphen or contain two consecutive hyphens
|
786
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
787
|
-
# in the response. If more than the MaxRecords value is available, a
|
788
|
-
# marker is included in the response so that the following results
|
789
|
-
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
790
|
-
# * `:marker` - (String) The marker provided in the previous request.
|
791
|
-
# If this parameter is specified, the response includes records
|
792
|
-
# beyond the marker only, up to MaxRecords.
|
793
|
-
# * `:default_only` - (Boolean) Indicates that only the default version
|
794
|
-
# of the specified engine or engine and major version combination is
|
795
|
-
# returned.
|
796
|
-
# * `:list_supported_character_sets` - (Boolean) If this parameter is
|
797
|
-
# specified, and if the requested engine supports the
|
798
|
-
# CharacterSetName parameter for CreateDBInstance, the response
|
799
|
-
# includes a list of supported character sets for each engine
|
800
|
-
# version.
|
801
|
-
# @return [Core::Response]
|
802
|
-
# The #data method of the response object returns
|
803
|
-
# a hash with the following structure:
|
804
|
-
#
|
805
|
-
# * `:marker` - (String)
|
806
|
-
# * `:db_engine_versions` - (Array<Hash>)
|
807
|
-
# * `:engine` - (String)
|
808
|
-
# * `:engine_version` - (String)
|
809
|
-
# * `:db_parameter_group_family` - (String)
|
810
|
-
# * `:db_engine_description` - (String)
|
811
|
-
# * `:db_engine_version_description` - (String)
|
812
|
-
# * `:default_character_set` - (Hash)
|
813
|
-
# * `:character_set_name` - (String)
|
814
|
-
# * `:character_set_description` - (String)
|
815
|
-
# * `:supported_character_sets` - (Array<Hash>)
|
816
|
-
# * `:character_set_name` - (String)
|
817
|
-
# * `:character_set_description` - (String)
|
818
|
-
|
819
|
-
# @!method describe_db_instances(options = {})
|
820
|
-
# Calls the DescribeDBInstances API operation.
|
821
|
-
# @param [Hash] options
|
822
|
-
#
|
823
|
-
# * `:db_instance_identifier` - (String) The user-supplied instance
|
824
|
-
# identifier. If this parameter is specified, information from only
|
825
|
-
# the specific DB Instance is returned. This parameter isn't case
|
826
|
-
# sensitive.
|
827
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
828
|
-
# in the response. If more records exist than the specified
|
829
|
-
# MaxRecords value, a marker is included in the response so that the
|
830
|
-
# remaining results may be retrieved.
|
831
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
832
|
-
# DescribeDBInstances request. If this parameter is specified, the
|
833
|
-
# response includes only records beyond the marker, up to the value
|
834
|
-
# specified by MaxRecords.
|
835
|
-
# @return [Core::Response]
|
836
|
-
# The #data method of the response object returns
|
837
|
-
# a hash with the following structure:
|
838
|
-
#
|
839
|
-
# * `:marker` - (String)
|
840
|
-
# * `:db_instances` - (Array<Hash>)
|
841
|
-
# * `:db_instance_identifier` - (String)
|
842
|
-
# * `:db_instance_class` - (String)
|
843
|
-
# * `:engine` - (String)
|
844
|
-
# * `:db_instance_status` - (String)
|
845
|
-
# * `:master_username` - (String)
|
846
|
-
# * `:db_name` - (String)
|
847
|
-
# * `:endpoint` - (Hash)
|
848
|
-
# * `:address` - (String)
|
849
|
-
# * `:port` - (Integer)
|
850
|
-
# * `:allocated_storage` - (Integer)
|
851
|
-
# * `:instance_create_time` - (Time)
|
852
|
-
# * `:preferred_backup_window` - (String)
|
853
|
-
# * `:backup_retention_period` - (Integer)
|
854
|
-
# * `:db_security_groups` - (Array<Hash>)
|
855
|
-
# * `:db_security_group_name` - (String)
|
856
|
-
# * `:status` - (String)
|
857
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
858
|
-
# * `:vpc_security_group_id` - (String)
|
859
|
-
# * `:status` - (String)
|
860
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
861
|
-
# * `:db_parameter_group_name` - (String)
|
862
|
-
# * `:parameter_apply_status` - (String)
|
863
|
-
# * `:availability_zone` - (String)
|
864
|
-
# * `:db_subnet_group` - (Hash)
|
865
|
-
# * `:db_subnet_group_name` - (String)
|
866
|
-
# * `:db_subnet_group_description` - (String)
|
867
|
-
# * `:vpc_id` - (String)
|
868
|
-
# * `:subnet_group_status` - (String)
|
869
|
-
# * `:subnets` - (Array<Hash>)
|
870
|
-
# * `:subnet_identifier` - (String)
|
871
|
-
# * `:subnet_availability_zone` - (Hash)
|
872
|
-
# * `:name` - (String)
|
873
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
874
|
-
# * `:subnet_status` - (String)
|
875
|
-
# * `:preferred_maintenance_window` - (String)
|
876
|
-
# * `:pending_modified_values` - (Hash)
|
877
|
-
# * `:db_instance_class` - (String)
|
878
|
-
# * `:allocated_storage` - (Integer)
|
879
|
-
# * `:master_user_password` - (String)
|
880
|
-
# * `:port` - (Integer)
|
881
|
-
# * `:backup_retention_period` - (Integer)
|
882
|
-
# * `:multi_az` - (Boolean)
|
883
|
-
# * `:engine_version` - (String)
|
884
|
-
# * `:iops` - (Integer)
|
885
|
-
# * `:db_instance_identifier` - (String)
|
886
|
-
# * `:latest_restorable_time` - (Time)
|
887
|
-
# * `:multi_az` - (Boolean)
|
888
|
-
# * `:engine_version` - (String)
|
889
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
890
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
891
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
892
|
-
# * `:license_model` - (String)
|
893
|
-
# * `:iops` - (Integer)
|
894
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
895
|
-
# * `:option_group_name` - (String)
|
896
|
-
# * `:status` - (String)
|
897
|
-
# * `:character_set_name` - (String)
|
898
|
-
# * `:secondary_availability_zone` - (String)
|
899
|
-
# * `:publicly_accessible` - (Boolean)
|
900
|
-
# * `:status_infos` - (Array<Hash>)
|
901
|
-
# * `:status_type` - (String)
|
902
|
-
# * `:normal` - (Boolean)
|
903
|
-
# * `:status` - (String)
|
904
|
-
# * `:message` - (String)
|
905
|
-
|
906
|
-
# @!method describe_db_log_files(options = {})
|
907
|
-
# Calls the DescribeDBLogFiles API operation.
|
908
|
-
# @param [Hash] options
|
909
|
-
#
|
910
|
-
# * `:db_instance_identifier` - (String) The customer-assigned name of
|
911
|
-
# the DB Instance that contains the log files you want to list.
|
912
|
-
# Constraints: Must contain from 1 to 63 alphanumeric characters or
|
913
|
-
# hyphens First character must be a letter Cannot end with a hyphen
|
914
|
-
# or contain two consecutive hyphens
|
915
|
-
# * `:filename_contains` - (String) Filters the available log files for
|
916
|
-
# log file names that contain the specified string.
|
917
|
-
# * `:file_last_written` - (Integer) Filters the available log files
|
918
|
-
# for files written since the specified date.
|
919
|
-
# * `:file_size` - (Integer) Filters the available log files for files
|
920
|
-
# larger than the specified size.
|
921
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
922
|
-
# in the response. If more records exist than the specified
|
923
|
-
# MaxRecords value, a pagination token called a marker is included in
|
924
|
-
# the response so that the remaining results can be retrieved.
|
925
|
-
# * `:marker` - (String) The pagination token provided in the previous
|
926
|
-
# request. If this parameter is specified the response includes only
|
927
|
-
# records beyond the marker, up to MaxRecords.
|
928
|
-
# @return [Core::Response]
|
929
|
-
# The #data method of the response object returns
|
930
|
-
# a hash with the following structure:
|
931
|
-
#
|
932
|
-
# * `:describe_db_log_files` - (Array<Hash>)
|
933
|
-
# * `:log_file_name` - (String)
|
934
|
-
# * `:last_written` - (Integer)
|
935
|
-
# * `:size` - (Integer)
|
936
|
-
# * `:marker` - (String)
|
937
|
-
|
938
|
-
# @!method describe_db_parameter_groups(options = {})
|
939
|
-
# Calls the DescribeDBParameterGroups API operation.
|
940
|
-
# @param [Hash] options
|
941
|
-
#
|
942
|
-
# * `:db_parameter_group_name` - (String) The name of a specific
|
943
|
-
# database parameter group to return details for.
|
944
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
945
|
-
# in the response. If more records exist than the specified
|
946
|
-
# MaxRecords value, a marker is included in the response so that the
|
947
|
-
# remaining results may be retrieved.
|
948
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
949
|
-
# DescribeDBInstances request. If this parameter is specified, the
|
950
|
-
# response includes only records beyond the marker, up to the value
|
951
|
-
# specified by MaxRecords.
|
952
|
-
# @return [Core::Response]
|
953
|
-
# The #data method of the response object returns
|
954
|
-
# a hash with the following structure:
|
955
|
-
#
|
956
|
-
# * `:marker` - (String)
|
957
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
958
|
-
# * `:db_parameter_group_name` - (String)
|
959
|
-
# * `:db_parameter_group_family` - (String)
|
960
|
-
# * `:description` - (String)
|
961
|
-
|
962
|
-
# @!method describe_db_parameters(options = {})
|
963
|
-
# Calls the DescribeDBParameters API operation.
|
964
|
-
# @param [Hash] options
|
965
|
-
#
|
966
|
-
# * `:db_parameter_group_name` - *required* - (String) The name of a
|
967
|
-
# specific database parameter group to return details for.
|
968
|
-
# * `:source` - (String) The parameter types to return.
|
969
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
970
|
-
# in the response. If more records exist than the specified
|
971
|
-
# MaxRecords value, a marker is included in the response so that the
|
972
|
-
# remaining results may be retrieved.
|
973
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
974
|
-
# DescribeDBInstances request. If this parameter is specified, the
|
975
|
-
# response includes only records beyond the marker, up to the value
|
976
|
-
# specified by MaxRecords.
|
977
|
-
# @return [Core::Response]
|
978
|
-
# The #data method of the response object returns
|
979
|
-
# a hash with the following structure:
|
980
|
-
#
|
981
|
-
# * `:parameters` - (Array<Hash>)
|
982
|
-
# * `:parameter_name` - (String)
|
983
|
-
# * `:parameter_value` - (String)
|
984
|
-
# * `:description` - (String)
|
985
|
-
# * `:source` - (String)
|
986
|
-
# * `:apply_type` - (String)
|
987
|
-
# * `:data_type` - (String)
|
988
|
-
# * `:allowed_values` - (String)
|
989
|
-
# * `:is_modifiable` - (Boolean)
|
990
|
-
# * `:minimum_engine_version` - (String)
|
991
|
-
# * `:apply_method` - (String)
|
992
|
-
# * `:marker` - (String)
|
993
|
-
|
994
|
-
# @!method describe_db_security_groups(options = {})
|
995
|
-
# Calls the DescribeDBSecurityGroups API operation.
|
996
|
-
# @param [Hash] options
|
997
|
-
#
|
998
|
-
# * `:db_security_group_name` - (String) The name of the DB Security
|
999
|
-
# Group to return details for.
|
1000
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1001
|
-
# in the response. If more records exist than the specified
|
1002
|
-
# MaxRecords value, a marker is included in the response so that the
|
1003
|
-
# remaining results may be retrieved.
|
1004
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
1005
|
-
# DescribeDBInstances request. If this parameter is specified, the
|
1006
|
-
# response includes only records beyond the marker, up to the value
|
1007
|
-
# specified by MaxRecords.
|
1008
|
-
# @return [Core::Response]
|
1009
|
-
# The #data method of the response object returns
|
1010
|
-
# a hash with the following structure:
|
1011
|
-
#
|
1012
|
-
# * `:marker` - (String)
|
1013
|
-
# * `:db_security_groups` - (Array<Hash>)
|
1014
|
-
# * `:owner_id` - (String)
|
1015
|
-
# * `:db_security_group_name` - (String)
|
1016
|
-
# * `:db_security_group_description` - (String)
|
1017
|
-
# * `:vpc_id` - (String)
|
1018
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
1019
|
-
# * `:status` - (String)
|
1020
|
-
# * `:ec2_security_group_name` - (String)
|
1021
|
-
# * `:ec2_security_group_id` - (String)
|
1022
|
-
# * `:ec2_security_group_owner_id` - (String)
|
1023
|
-
# * `:ip_ranges` - (Array<Hash>)
|
1024
|
-
# * `:status` - (String)
|
1025
|
-
# * `:cidrip` - (String)
|
1026
|
-
|
1027
|
-
# @!method describe_db_snapshots(options = {})
|
1028
|
-
# Calls the DescribeDBSnapshots API operation.
|
1029
|
-
# @param [Hash] options
|
1030
|
-
#
|
1031
|
-
# * `:db_instance_identifier` - (String) The unique identifier for the
|
1032
|
-
# Amazon RDS DB snapshot. This value is stored as a lowercase string.
|
1033
|
-
# * `:db_snapshot_identifier` - (String) The DB Instance identifier.
|
1034
|
-
# This parameter isn't case sensitive.
|
1035
|
-
# * `:snapshot_type` - (String) An optional snapshot type for which
|
1036
|
-
# snapshots will be returned. If not specified, the returned results
|
1037
|
-
# will include snapshots of all types.
|
1038
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1039
|
-
# in the response. If more records exist than the specified
|
1040
|
-
# MaxRecords value, a marker is included in the response so that the
|
1041
|
-
# remaining results may be retrieved.
|
1042
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
1043
|
-
# DescribeDBInstances request. If this parameter is specified, the
|
1044
|
-
# response includes only records beyond the marker, up to the value
|
1045
|
-
# specified by MaxRecords.
|
1046
|
-
# @return [Core::Response]
|
1047
|
-
# The #data method of the response object returns
|
1048
|
-
# a hash with the following structure:
|
1049
|
-
#
|
1050
|
-
# * `:marker` - (String)
|
1051
|
-
# * `:db_snapshots` - (Array<Hash>)
|
1052
|
-
# * `:db_snapshot_identifier` - (String)
|
1053
|
-
# * `:db_instance_identifier` - (String)
|
1054
|
-
# * `:snapshot_create_time` - (Time)
|
1055
|
-
# * `:engine` - (String)
|
1056
|
-
# * `:allocated_storage` - (Integer)
|
1057
|
-
# * `:status` - (String)
|
1058
|
-
# * `:port` - (Integer)
|
1059
|
-
# * `:availability_zone` - (String)
|
1060
|
-
# * `:vpc_id` - (String)
|
1061
|
-
# * `:instance_create_time` - (Time)
|
1062
|
-
# * `:master_username` - (String)
|
1063
|
-
# * `:engine_version` - (String)
|
1064
|
-
# * `:license_model` - (String)
|
1065
|
-
# * `:snapshot_type` - (String)
|
1066
|
-
# * `:iops` - (Integer)
|
1067
|
-
# * `:option_group_name` - (String)
|
1068
|
-
|
1069
|
-
# @!method describe_db_subnet_groups(options = {})
|
1070
|
-
# Calls the DescribeDBSubnetGroups API operation.
|
1071
|
-
# @param [Hash] options
|
1072
|
-
#
|
1073
|
-
# * `:db_subnet_group_name` - (String) The name of the DB Subnet Group
|
1074
|
-
# to return details for.
|
1075
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1076
|
-
# in the response. If more records exist than the specified
|
1077
|
-
# MaxRecords value, a marker is included in the response so that the
|
1078
|
-
# remaining results may be retrieved. Default: 100 Constraints:
|
1079
|
-
# minimum 20, maximum 100
|
1080
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
1081
|
-
# DescribeDBSubnetGroups request. If this parameter is specified, the
|
1082
|
-
# response includes only records beyond the marker, up to the value
|
1083
|
-
# specified by MaxRecords.
|
1084
|
-
# @return [Core::Response]
|
1085
|
-
# The #data method of the response object returns
|
1086
|
-
# a hash with the following structure:
|
1087
|
-
#
|
1088
|
-
# * `:marker` - (String)
|
1089
|
-
# * `:db_subnet_groups` - (Array<Hash>)
|
1090
|
-
# * `:db_subnet_group_name` - (String)
|
1091
|
-
# * `:db_subnet_group_description` - (String)
|
1092
|
-
# * `:vpc_id` - (String)
|
1093
|
-
# * `:subnet_group_status` - (String)
|
1094
|
-
# * `:subnets` - (Array<Hash>)
|
1095
|
-
# * `:subnet_identifier` - (String)
|
1096
|
-
# * `:subnet_availability_zone` - (Hash)
|
1097
|
-
# * `:name` - (String)
|
1098
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
1099
|
-
# * `:subnet_status` - (String)
|
1100
|
-
|
1101
|
-
# @!method describe_engine_default_parameters(options = {})
|
1102
|
-
# Calls the DescribeEngineDefaultParameters API operation.
|
1103
|
-
# @param [Hash] options
|
1104
|
-
#
|
1105
|
-
# * `:db_parameter_group_family` - *required* - (String) The name of
|
1106
|
-
# the DB Parameter Group Family.
|
1107
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1108
|
-
# in the response. If more records exist than the specified
|
1109
|
-
# MaxRecords value, a marker is included in the response so that the
|
1110
|
-
# remaining results may be retrieved.
|
1111
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
1112
|
-
# DescribeDBInstances request. If this parameter is specified, the
|
1113
|
-
# response includes only records beyond the marker, up to the value
|
1114
|
-
# specified by MaxRecords.
|
1115
|
-
# @return [Core::Response]
|
1116
|
-
# The #data method of the response object returns
|
1117
|
-
# a hash with the following structure:
|
1118
|
-
#
|
1119
|
-
# * `:db_parameter_group_family` - (String)
|
1120
|
-
# * `:marker` - (String)
|
1121
|
-
# * `:parameters` - (Array<Hash>)
|
1122
|
-
# * `:parameter_name` - (String)
|
1123
|
-
# * `:parameter_value` - (String)
|
1124
|
-
# * `:description` - (String)
|
1125
|
-
# * `:source` - (String)
|
1126
|
-
# * `:apply_type` - (String)
|
1127
|
-
# * `:data_type` - (String)
|
1128
|
-
# * `:allowed_values` - (String)
|
1129
|
-
# * `:is_modifiable` - (Boolean)
|
1130
|
-
# * `:minimum_engine_version` - (String)
|
1131
|
-
# * `:apply_method` - (String)
|
1132
|
-
|
1133
|
-
# @!method describe_event_categories(options = {})
|
1134
|
-
# Calls the DescribeEventCategories API operation.
|
1135
|
-
# @param [Hash] options
|
1136
|
-
#
|
1137
|
-
# * `:source_type` - (String) The type of source that will be
|
1138
|
-
# generating the events. Valid values: db-instance |
|
1139
|
-
# db-parameter-group | db-security-group | db-snapshot
|
1140
|
-
# @return [Core::Response]
|
1141
|
-
# The #data method of the response object returns
|
1142
|
-
# a hash with the following structure:
|
1143
|
-
#
|
1144
|
-
# * `:event_categories_map_list` - (Array<Hash>)
|
1145
|
-
# * `:source_type` - (String)
|
1146
|
-
# * `:event_categories` - (Array<String>)
|
1147
|
-
|
1148
|
-
# @!method describe_event_subscriptions(options = {})
|
1149
|
-
# Calls the DescribeEventSubscriptions API operation.
|
1150
|
-
# @param [Hash] options
|
1151
|
-
#
|
1152
|
-
# * `:subscription_name` - (String) The name of the RDS event
|
1153
|
-
# notification subscription you want to describe.
|
1154
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1155
|
-
# in the response. If more records exist than the specified
|
1156
|
-
# MaxRecords value, a pagination token called a marker is included in
|
1157
|
-
# the response so that the remaining results can be retrieved.
|
1158
|
-
# Default: 100 Constraints: minimum 20, maximum 100
|
1159
|
-
# * `:marker` - (String) An optional pagination token provided by a
|
1160
|
-
# previous DescribeOrderableDBInstanceOptions request. If this
|
1161
|
-
# parameter is specified, the response includes only records beyond
|
1162
|
-
# the marker, up to the value specified by MaxRecords .
|
1163
|
-
# @return [Core::Response]
|
1164
|
-
# The #data method of the response object returns
|
1165
|
-
# a hash with the following structure:
|
1166
|
-
#
|
1167
|
-
# * `:marker` - (String)
|
1168
|
-
# * `:event_subscriptions_list` - (Array<Hash>)
|
1169
|
-
# * `:customer_aws_id` - (String)
|
1170
|
-
# * `:cust_subscription_id` - (String)
|
1171
|
-
# * `:sns_topic_arn` - (String)
|
1172
|
-
# * `:status` - (String)
|
1173
|
-
# * `:subscription_creation_time` - (String)
|
1174
|
-
# * `:source_type` - (String)
|
1175
|
-
# * `:source_ids_list` - (Array<String>)
|
1176
|
-
# * `:event_categories_list` - (Array<String>)
|
1177
|
-
# * `:enabled` - (Boolean)
|
1178
|
-
|
1179
|
-
# @!method describe_events(options = {})
|
1180
|
-
# Calls the DescribeEvents API operation.
|
1181
|
-
# @param [Hash] options
|
1182
|
-
#
|
1183
|
-
# * `:source_identifier` - (String) The identifier of the event source
|
1184
|
-
# for which events will be returned. If not specified, then all
|
1185
|
-
# sources are included in the response.
|
1186
|
-
# * `:source_type` - (String) The event source to retrieve events for.
|
1187
|
-
# If no value is specified, all events are returned. Valid values
|
1188
|
-
# include:
|
1189
|
-
# * `db-instance`
|
1190
|
-
# * `db-parameter-group`
|
1191
|
-
# * `db-security-group`
|
1192
|
-
# * `db-snapshot`
|
1193
|
-
# * `:start_time` - (String<ISO8601 datetime>) The beginning of the
|
1194
|
-
# time interval to retrieve events for, specified in ISO 8601 format.
|
1195
|
-
# * `:end_time` - (String<ISO8601 datetime>) The end of the time
|
1196
|
-
# interval for which to retrieve events, specified in ISO 8601
|
1197
|
-
# format.
|
1198
|
-
# * `:duration` - (Integer) The number of minutes to retrieve events
|
1199
|
-
# for.
|
1200
|
-
# * `:event_categories` - (Array<String>) A list of event categories
|
1201
|
-
# that trigger notifications for a event notification subscription.
|
1202
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1203
|
-
# in the response. If more records exist than the specified
|
1204
|
-
# MaxRecords value, a marker is included in the response so that the
|
1205
|
-
# remaining results may be retrieved.
|
1206
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
1207
|
-
# DescribeDBInstances request. If this parameter is specified, the
|
1208
|
-
# response includes only records beyond the marker, up to the value
|
1209
|
-
# specified by MaxRecords.
|
1210
|
-
# @return [Core::Response]
|
1211
|
-
# The #data method of the response object returns
|
1212
|
-
# a hash with the following structure:
|
1213
|
-
#
|
1214
|
-
# * `:marker` - (String)
|
1215
|
-
# * `:events` - (Array<Hash>)
|
1216
|
-
# * `:source_identifier` - (String)
|
1217
|
-
# * `:source_type` - (String)
|
1218
|
-
# * `:message` - (String)
|
1219
|
-
# * `:event_categories` - (Array<String>)
|
1220
|
-
# * `:date` - (Time)
|
1221
|
-
|
1222
|
-
# @!method describe_option_group_options(options = {})
|
1223
|
-
# Calls the DescribeOptionGroupOptions API operation.
|
1224
|
-
# @param [Hash] options
|
1225
|
-
#
|
1226
|
-
# * `:engine_name` - *required* - (String) A required parameter.
|
1227
|
-
# Options available for the given Engine name will be described.
|
1228
|
-
# * `:major_engine_version` - (String) If specified, filters the
|
1229
|
-
# results to include only options for the specified major engine
|
1230
|
-
# version.
|
1231
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1232
|
-
# in the response. If more records exist than the specified
|
1233
|
-
# MaxRecords value, a pagination token called a marker is included in
|
1234
|
-
# the response so that the remaining results can be retrieved.
|
1235
|
-
# Default: 100 Constraints: minimum 20, maximum 100
|
1236
|
-
# * `:marker` - (String) An optional pagination token provided by a
|
1237
|
-
# previous request. If this parameter is specified, the response
|
1238
|
-
# includes only records beyond the marker, up to the value specified
|
1239
|
-
# by MaxRecords.
|
1240
|
-
# @return [Core::Response]
|
1241
|
-
# The #data method of the response object returns
|
1242
|
-
# a hash with the following structure:
|
1243
|
-
#
|
1244
|
-
# * `:option_group_options` - (Array<Hash>)
|
1245
|
-
# * `:name` - (String)
|
1246
|
-
# * `:description` - (String)
|
1247
|
-
# * `:engine_name` - (String)
|
1248
|
-
# * `:major_engine_version` - (String)
|
1249
|
-
# * `:minimum_required_minor_engine_version` - (String)
|
1250
|
-
# * `:port_required` - (Boolean)
|
1251
|
-
# * `:default_port` - (Integer)
|
1252
|
-
# * `:options_depended_on` - (Array<String>)
|
1253
|
-
# * `:persistent` - (Boolean)
|
1254
|
-
# * `:permanent` - (Boolean)
|
1255
|
-
# * `:option_group_option_settings` - (Array<Hash>)
|
1256
|
-
# * `:setting_name` - (String)
|
1257
|
-
# * `:setting_description` - (String)
|
1258
|
-
# * `:default_value` - (String)
|
1259
|
-
# * `:apply_type` - (String)
|
1260
|
-
# * `:allowed_values` - (String)
|
1261
|
-
# * `:is_modifiable` - (Boolean)
|
1262
|
-
# * `:marker` - (String)
|
1263
|
-
|
1264
|
-
# @!method describe_option_groups(options = {})
|
1265
|
-
# Calls the DescribeOptionGroups API operation.
|
1266
|
-
# @param [Hash] options
|
1267
|
-
#
|
1268
|
-
# * `:option_group_name` - (String) The name of the option group to
|
1269
|
-
# describe. Cannot be supplied together with EngineName or
|
1270
|
-
# MajorEngineVersion.
|
1271
|
-
# * `:marker` - (String) An optional pagination token provided by a
|
1272
|
-
# previous DescribeOptionGroups request. If this parameter is
|
1273
|
-
# specified, the response includes only records beyond the marker, up
|
1274
|
-
# to the value specified by MaxRecords.
|
1275
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1276
|
-
# in the response. If more records exist than the specified
|
1277
|
-
# MaxRecords value, a pagination token called a marker is included in
|
1278
|
-
# the response so that the remaining results can be retrieved.
|
1279
|
-
# Default: 100 Constraints: minimum 20, maximum 100
|
1280
|
-
# * `:engine_name` - (String) Filters the list of option groups to only
|
1281
|
-
# include groups associated with a specific database engine.
|
1282
|
-
# * `:major_engine_version` - (String) Filters the list of option
|
1283
|
-
# groups to only include groups associated with a specific database
|
1284
|
-
# engine version. If specified, then EngineName must also be
|
1285
|
-
# specified.
|
1286
|
-
# @return [Core::Response]
|
1287
|
-
# The #data method of the response object returns
|
1288
|
-
# a hash with the following structure:
|
1289
|
-
#
|
1290
|
-
# * `:option_groups_list` - (Array<Hash>)
|
1291
|
-
# * `:option_group_name` - (String)
|
1292
|
-
# * `:option_group_description` - (String)
|
1293
|
-
# * `:engine_name` - (String)
|
1294
|
-
# * `:major_engine_version` - (String)
|
1295
|
-
# * `:options` - (Array<Hash>)
|
1296
|
-
# * `:option_name` - (String)
|
1297
|
-
# * `:option_description` - (String)
|
1298
|
-
# * `:persistent` - (Boolean)
|
1299
|
-
# * `:permanent` - (Boolean)
|
1300
|
-
# * `:port` - (Integer)
|
1301
|
-
# * `:option_settings` - (Array<Hash>)
|
1302
|
-
# * `:name` - (String)
|
1303
|
-
# * `:value` - (String)
|
1304
|
-
# * `:default_value` - (String)
|
1305
|
-
# * `:description` - (String)
|
1306
|
-
# * `:apply_type` - (String)
|
1307
|
-
# * `:data_type` - (String)
|
1308
|
-
# * `:allowed_values` - (String)
|
1309
|
-
# * `:is_modifiable` - (Boolean)
|
1310
|
-
# * `:is_collection` - (Boolean)
|
1311
|
-
# * `:db_security_group_memberships` - (Array<Hash>)
|
1312
|
-
# * `:db_security_group_name` - (String)
|
1313
|
-
# * `:status` - (String)
|
1314
|
-
# * `:vpc_security_group_memberships` - (Array<Hash>)
|
1315
|
-
# * `:vpc_security_group_id` - (String)
|
1316
|
-
# * `:status` - (String)
|
1317
|
-
# * `:allows_vpc_and_non_vpc_instance_memberships` - (Boolean)
|
1318
|
-
# * `:vpc_id` - (String)
|
1319
|
-
# * `:marker` - (String)
|
1320
|
-
|
1321
|
-
# @!method describe_orderable_db_instance_options(options = {})
|
1322
|
-
# Calls the DescribeOrderableDBInstanceOptions API operation.
|
1323
|
-
# @param [Hash] options
|
1324
|
-
#
|
1325
|
-
# * `:engine` - *required* - (String) The name of the engine to
|
1326
|
-
# retrieve DB Instance options for.
|
1327
|
-
# * `:engine_version` - (String) The engine version filter value.
|
1328
|
-
# Specify this parameter to show only the available offerings
|
1329
|
-
# matching the specified engine version.
|
1330
|
-
# * `:db_instance_class` - (String) The DB Instance class filter value.
|
1331
|
-
# Specify this parameter to show only the available offerings
|
1332
|
-
# matching the specified DB Instance class.
|
1333
|
-
# * `:license_model` - (String) The license model filter value. Specify
|
1334
|
-
# this parameter to show only the available offerings matching the
|
1335
|
-
# specified license model.
|
1336
|
-
# * `:vpc` - (Boolean) The VPC filter value. Specify this parameter to
|
1337
|
-
# show only the available VPC or non-VPC offerings.
|
1338
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1339
|
-
# in the response. If more records exist than the specified
|
1340
|
-
# MaxRecords value, a marker is included in the response so that the
|
1341
|
-
# remaining results may be retrieved. Default: 100 Constraints:
|
1342
|
-
# minimum 20, maximum 100
|
1343
|
-
# * `:marker` - (String) An optional marker provided in the previous
|
1344
|
-
# DescribeOrderableDBInstanceOptions request. If this parameter is
|
1345
|
-
# specified, the response includes only records beyond the marker, up
|
1346
|
-
# to the value specified by MaxRecords .
|
1347
|
-
# @return [Core::Response]
|
1348
|
-
# The #data method of the response object returns
|
1349
|
-
# a hash with the following structure:
|
1350
|
-
#
|
1351
|
-
# * `:orderable_db_instance_options` - (Array<Hash>)
|
1352
|
-
# * `:engine` - (String)
|
1353
|
-
# * `:engine_version` - (String)
|
1354
|
-
# * `:db_instance_class` - (String)
|
1355
|
-
# * `:license_model` - (String)
|
1356
|
-
# * `:availability_zones` - (Array<Hash>)
|
1357
|
-
# * `:name` - (String)
|
1358
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
1359
|
-
# * `:multi_az_capable` - (Boolean)
|
1360
|
-
# * `:read_replica_capable` - (Boolean)
|
1361
|
-
# * `:vpc` - (Boolean)
|
1362
|
-
# * `:marker` - (String)
|
1363
|
-
|
1364
|
-
# @!method describe_reserved_db_instances(options = {})
|
1365
|
-
# Calls the DescribeReservedDBInstances API operation.
|
1366
|
-
# @param [Hash] options
|
1367
|
-
#
|
1368
|
-
# * `:reserved_db_instance_id` - (String) The reserved DB Instance
|
1369
|
-
# identifier filter value. Specify this parameter to show only the
|
1370
|
-
# reservation that matches the specified reservation ID.
|
1371
|
-
# * `:reserved_db_instances_offering_id` - (String) The offering
|
1372
|
-
# identifier filter value. Specify this parameter to show only
|
1373
|
-
# purchased reservations matching the specified offering identifier.
|
1374
|
-
# * `:db_instance_class` - (String) The DB Instance class filter value.
|
1375
|
-
# Specify this parameter to show only those reservations matching the
|
1376
|
-
# specified DB Instances class.
|
1377
|
-
# * `:duration` - (String) The duration filter value, specified in
|
1378
|
-
# years or seconds. Specify this parameter to show only reservations
|
1379
|
-
# for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
|
1380
|
-
# * `:product_description` - (String) The product description filter
|
1381
|
-
# value. Specify this parameter to show only those reservations
|
1382
|
-
# matching the specified product description.
|
1383
|
-
# * `:offering_type` - (String) The offering type filter value. Specify
|
1384
|
-
# this parameter to show only the available offerings matching the
|
1385
|
-
# specified offering type. Valid Values: "Light Utilization" |
|
1386
|
-
# "Medium Utilization" | "Heavy Utilization"
|
1387
|
-
# * `:multi_az` - (Boolean) The Multi-AZ filter value. Specify this
|
1388
|
-
# parameter to show only those reservations matching the specified
|
1389
|
-
# Multi-AZ parameter.
|
1390
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1391
|
-
# in the response. If more than the MaxRecords value is available, a
|
1392
|
-
# marker is included in the response so that the following results
|
1393
|
-
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
1394
|
-
# * `:marker` - (String) The marker provided in the previous request.
|
1395
|
-
# If this parameter is specified, the response includes records
|
1396
|
-
# beyond the marker only, up to MaxRecords.
|
1397
|
-
# @return [Core::Response]
|
1398
|
-
# The #data method of the response object returns
|
1399
|
-
# a hash with the following structure:
|
1400
|
-
#
|
1401
|
-
# * `:marker` - (String)
|
1402
|
-
# * `:reserved_db_instances` - (Array<Hash>)
|
1403
|
-
# * `:reserved_db_instance_id` - (String)
|
1404
|
-
# * `:reserved_db_instances_offering_id` - (String)
|
1405
|
-
# * `:db_instance_class` - (String)
|
1406
|
-
# * `:start_time` - (Time)
|
1407
|
-
# * `:duration` - (Integer)
|
1408
|
-
# * `:fixed_price` - (Numeric)
|
1409
|
-
# * `:usage_price` - (Numeric)
|
1410
|
-
# * `:currency_code` - (String)
|
1411
|
-
# * `:db_instance_count` - (Integer)
|
1412
|
-
# * `:product_description` - (String)
|
1413
|
-
# * `:offering_type` - (String)
|
1414
|
-
# * `:multi_az` - (Boolean)
|
1415
|
-
# * `:state` - (String)
|
1416
|
-
# * `:recurring_charges` - (Array<Hash>)
|
1417
|
-
# * `:recurring_charge_amount` - (Numeric)
|
1418
|
-
# * `:recurring_charge_frequency` - (String)
|
1419
|
-
|
1420
|
-
# @!method describe_reserved_db_instances_offerings(options = {})
|
1421
|
-
# Calls the DescribeReservedDBInstancesOfferings API operation.
|
1422
|
-
# @param [Hash] options
|
1423
|
-
#
|
1424
|
-
# * `:reserved_db_instances_offering_id` - (String) The offering
|
1425
|
-
# identifier filter value. Specify this parameter to show only the
|
1426
|
-
# available offering that matches the specified reservation
|
1427
|
-
# identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
|
1428
|
-
# * `:db_instance_class` - (String) The DB Instance class filter value.
|
1429
|
-
# Specify this parameter to show only the available offerings
|
1430
|
-
# matching the specified DB Instance class.
|
1431
|
-
# * `:duration` - (String) Duration filter value, specified in years or
|
1432
|
-
# seconds. Specify this parameter to show only reservations for this
|
1433
|
-
# duration. Valid Values: 1 | 3 | 31536000 | 94608000
|
1434
|
-
# * `:product_description` - (String) Product description filter value.
|
1435
|
-
# Specify this parameter to show only the available offerings
|
1436
|
-
# matching the specified product description.
|
1437
|
-
# * `:offering_type` - (String) The offering type filter value. Specify
|
1438
|
-
# this parameter to show only the available offerings matching the
|
1439
|
-
# specified offering type. Valid Values: "Light Utilization" |
|
1440
|
-
# "Medium Utilization" | "Heavy Utilization"
|
1441
|
-
# * `:multi_az` - (Boolean) The Multi-AZ filter value. Specify this
|
1442
|
-
# parameter to show only the available offerings matching the
|
1443
|
-
# specified Multi-AZ parameter.
|
1444
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
1445
|
-
# in the response. If more than the MaxRecords value is available, a
|
1446
|
-
# marker is included in the response so that the following results
|
1447
|
-
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
1448
|
-
# * `:marker` - (String) The marker provided in the previous request.
|
1449
|
-
# If this parameter is specified, the response includes records
|
1450
|
-
# beyond the marker only, up to MaxRecords.
|
1451
|
-
# @return [Core::Response]
|
1452
|
-
# The #data method of the response object returns
|
1453
|
-
# a hash with the following structure:
|
1454
|
-
#
|
1455
|
-
# * `:marker` - (String)
|
1456
|
-
# * `:reserved_db_instances_offerings` - (Array<Hash>)
|
1457
|
-
# * `:reserved_db_instances_offering_id` - (String)
|
1458
|
-
# * `:db_instance_class` - (String)
|
1459
|
-
# * `:duration` - (Integer)
|
1460
|
-
# * `:fixed_price` - (Numeric)
|
1461
|
-
# * `:usage_price` - (Numeric)
|
1462
|
-
# * `:currency_code` - (String)
|
1463
|
-
# * `:product_description` - (String)
|
1464
|
-
# * `:offering_type` - (String)
|
1465
|
-
# * `:multi_az` - (Boolean)
|
1466
|
-
# * `:recurring_charges` - (Array<Hash>)
|
1467
|
-
# * `:recurring_charge_amount` - (Numeric)
|
1468
|
-
# * `:recurring_charge_frequency` - (String)
|
1469
|
-
|
1470
|
-
# @!method download_db_log_file_portion(options = {})
|
1471
|
-
# Calls the DownloadDBLogFilePortion API operation.
|
1472
|
-
# @param [Hash] options
|
1473
|
-
#
|
1474
|
-
# * `:db_instance_identifier` - (String)
|
1475
|
-
# * `:log_file_name` - (String)
|
1476
|
-
# * `:marker` - (String) The pagination token provided in the previous
|
1477
|
-
# request. If this parameter is specified the response includes only
|
1478
|
-
# records beyond the marker, up to MaxRecords.
|
1479
|
-
# * `:number_of_lines` - (Integer) The number of lines remaining to be
|
1480
|
-
# downloaded.
|
1481
|
-
# @return [Core::Response]
|
1482
|
-
# The #data method of the response object returns
|
1483
|
-
# a hash with the following structure:
|
1484
|
-
#
|
1485
|
-
# * `:log_file_data` - (String)
|
1486
|
-
# * `:marker` - (String)
|
1487
|
-
# * `:additional_data_pending` - (Boolean)
|
1488
|
-
|
1489
|
-
# @!method list_tags_for_resource(options = {})
|
1490
|
-
# Calls the ListTagsForResource API operation.
|
1491
|
-
# @param [Hash] options
|
1492
|
-
#
|
1493
|
-
# * `:resource_name` - *required* - (String) The DB Instance with tags
|
1494
|
-
# to be listed.
|
1495
|
-
# @return [Core::Response]
|
1496
|
-
# The #data method of the response object returns
|
1497
|
-
# a hash with the following structure:
|
1498
|
-
#
|
1499
|
-
# * `:tag_list` - (Array<Hash>)
|
1500
|
-
# * `:key` - (String)
|
1501
|
-
# * `:value` - (String)
|
1502
|
-
|
1503
|
-
# @!method modify_db_instance(options = {})
|
1504
|
-
# Calls the ModifyDBInstance API operation.
|
1505
|
-
# @param [Hash] options
|
1506
|
-
#
|
1507
|
-
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
1508
|
-
# identifier. This value is stored as a lowercase string.
|
1509
|
-
# * `:allocated_storage` - (Integer) The new storage capacity of the
|
1510
|
-
# RDS instance. This change does not result in an outage and is
|
1511
|
-
# applied during the next maintenance window unless the
|
1512
|
-
# ApplyImmediately parameter is specified as `true` for this request.
|
1513
|
-
# * `:db_instance_class` - (String) The new compute and memory capacity
|
1514
|
-
# of the DB Instance. Passing a value for this parameter causes an
|
1515
|
-
# outage during the change and is applied during the next maintenance
|
1516
|
-
# window, unless the ApplyImmediately parameter is specified as
|
1517
|
-
# `true` for this request.
|
1518
|
-
# * `:db_security_groups` - (Array<String>) A list of DB Security
|
1519
|
-
# Groups to authorize on this DB Instance. This change is
|
1520
|
-
# asynchronously applied as soon as possible.
|
1521
|
-
# * `:vpc_security_group_ids` - (Array<String>) A list of Ec2 Vpc
|
1522
|
-
# Security Groups to authorize on this DB Instance. This change is
|
1523
|
-
# asynchronously applied as soon as possible. Constraints: Must be 1
|
1524
|
-
# to 255 alphanumeric characters First character must be a letter
|
1525
|
-
# Cannot end with a hyphen or contain two consecutive hyphens
|
1526
|
-
# * `:apply_immediately` - (Boolean) Specifies whether or not the
|
1527
|
-
# modifications in this request and any pending modifications are
|
1528
|
-
# asynchronously applied as soon as possible, regardless of the
|
1529
|
-
# PreferredMaintenanceWindow setting for the DB Instance. If this
|
1530
|
-
# parameter is passed as `false` , changes to the DB Instance are
|
1531
|
-
# applied on the next call to RebootDBInstance, the next maintenance
|
1532
|
-
# reboot, or the next failure reboot, whichever occurs first.
|
1533
|
-
# * `:master_user_password` - (String) The new password for the DB
|
1534
|
-
# Instance master user. This change is asynchronously applied as soon
|
1535
|
-
# as possible. Between the time of the request and the completion of
|
1536
|
-
# the request, the MasterUserPassword element exists in the
|
1537
|
-
# PendingModifiedValues element of the operation response.
|
1538
|
-
# * `:db_parameter_group_name` - (String) The name of the DB Parameter
|
1539
|
-
# Group to apply to this DB Instance. This change is asynchronously
|
1540
|
-
# applied as soon as possible for parameters when the
|
1541
|
-
# ApplyImmediately parameter is specified as `true` for this request.
|
1542
|
-
# * `:backup_retention_period` - (Integer) The number of days to retain
|
1543
|
-
# automated backups. Setting this parameter to a positive number
|
1544
|
-
# enables backups. Setting this parameter to 0 disables automated
|
1545
|
-
# backups.
|
1546
|
-
# * `:preferred_backup_window` - (String) The daily time range during
|
1547
|
-
# which automated backups are created if automated backups are
|
1548
|
-
# enabled, as determined by the BackupRetentionPeriod.
|
1549
|
-
# * `:preferred_maintenance_window` - (String) The weekly time range
|
1550
|
-
# (in UTC) during which system maintenance can occur, which may
|
1551
|
-
# result in an outage. This change is made immediately. If moving
|
1552
|
-
# this window to the current time, there must be at least 120 minutes
|
1553
|
-
# between the current time and end of the window to ensure pending
|
1554
|
-
# changes are applied.
|
1555
|
-
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
1556
|
-
# deployment. Constraints: Cannot be specified if the DB Instance is
|
1557
|
-
# a read replica.
|
1558
|
-
# * `:engine_version` - (String) The version number of the database
|
1559
|
-
# engine to upgrade to. For major version upgrades, if a nondefault
|
1560
|
-
# DB Parameter Group is currently in use, a new DB Parameter Group in
|
1561
|
-
# the DB Parameter Group Family for the new engine version must be
|
1562
|
-
# specified. The new DB Parameter Group can be the default for that
|
1563
|
-
# DB Parameter Group Family. Example: 5.1.42
|
1564
|
-
# * `:allow_major_version_upgrade` - (Boolean) Indicates that major
|
1565
|
-
# version upgrades are allowed. Constraints: This parameter must be
|
1566
|
-
# set to `true` when specifying a value for the EngineVersion
|
1567
|
-
# parameter that is a different major version than the DB Instance's
|
1568
|
-
# current version.
|
1569
|
-
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
1570
|
-
# version upgrades will be applied automatically to the DB Instance
|
1571
|
-
# during the maintenance window.
|
1572
|
-
# * `:iops` - (Integer) The new provisioned I/O operations per second
|
1573
|
-
# of the RDS instance. This change does not result in an outage and
|
1574
|
-
# is applied during the next maintenance window unless the
|
1575
|
-
# ApplyImmediately parameter is specified as `true` for this request.
|
1576
|
-
# Default: Uses existing setting Constraints: Value supplied must be
|
1577
|
-
# at least 10% greater than the current value. Values that are not at
|
1578
|
-
# least 10% greater than the existing value are rounded up so that
|
1579
|
-
# they are 10% greater than the current value. Type: Integer
|
1580
|
-
# * `:option_group_name` - (String) Indicates that the DB Instance
|
1581
|
-
# should be associated with the specified option group.
|
1582
|
-
# * `:new_db_instance_identifier` - (String) The new DB Instance
|
1583
|
-
# identifier for the DB Instance when renaming a DB Instance. This
|
1584
|
-
# value is stored as a lowercase string. Constraints: Must contain
|
1585
|
-
# from 1 to 63 alphanumeric characters or hyphens First character
|
1586
|
-
# must be a letter Cannot end with a hyphen or contain two
|
1587
|
-
# consecutive hyphens
|
1588
|
-
# @return [Core::Response]
|
1589
|
-
# The #data method of the response object returns
|
1590
|
-
# a hash with the following structure:
|
1591
|
-
#
|
1592
|
-
# * `:db_instance_identifier` - (String)
|
1593
|
-
# * `:db_instance_class` - (String)
|
1594
|
-
# * `:engine` - (String)
|
1595
|
-
# * `:db_instance_status` - (String)
|
1596
|
-
# * `:master_username` - (String)
|
1597
|
-
# * `:db_name` - (String)
|
1598
|
-
# * `:endpoint` - (Hash)
|
1599
|
-
# * `:address` - (String)
|
1600
|
-
# * `:port` - (Integer)
|
1601
|
-
# * `:allocated_storage` - (Integer)
|
1602
|
-
# * `:instance_create_time` - (Time)
|
1603
|
-
# * `:preferred_backup_window` - (String)
|
1604
|
-
# * `:backup_retention_period` - (Integer)
|
1605
|
-
# * `:db_security_groups` - (Array<Hash>)
|
1606
|
-
# * `:db_security_group_name` - (String)
|
1607
|
-
# * `:status` - (String)
|
1608
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
1609
|
-
# * `:vpc_security_group_id` - (String)
|
1610
|
-
# * `:status` - (String)
|
1611
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
1612
|
-
# * `:db_parameter_group_name` - (String)
|
1613
|
-
# * `:parameter_apply_status` - (String)
|
1614
|
-
# * `:availability_zone` - (String)
|
1615
|
-
# * `:db_subnet_group` - (Hash)
|
1616
|
-
# * `:db_subnet_group_name` - (String)
|
1617
|
-
# * `:db_subnet_group_description` - (String)
|
1618
|
-
# * `:vpc_id` - (String)
|
1619
|
-
# * `:subnet_group_status` - (String)
|
1620
|
-
# * `:subnets` - (Array<Hash>)
|
1621
|
-
# * `:subnet_identifier` - (String)
|
1622
|
-
# * `:subnet_availability_zone` - (Hash)
|
1623
|
-
# * `:name` - (String)
|
1624
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
1625
|
-
# * `:subnet_status` - (String)
|
1626
|
-
# * `:preferred_maintenance_window` - (String)
|
1627
|
-
# * `:pending_modified_values` - (Hash)
|
1628
|
-
# * `:db_instance_class` - (String)
|
1629
|
-
# * `:allocated_storage` - (Integer)
|
1630
|
-
# * `:master_user_password` - (String)
|
1631
|
-
# * `:port` - (Integer)
|
1632
|
-
# * `:backup_retention_period` - (Integer)
|
1633
|
-
# * `:multi_az` - (Boolean)
|
1634
|
-
# * `:engine_version` - (String)
|
1635
|
-
# * `:iops` - (Integer)
|
1636
|
-
# * `:db_instance_identifier` - (String)
|
1637
|
-
# * `:latest_restorable_time` - (Time)
|
1638
|
-
# * `:multi_az` - (Boolean)
|
1639
|
-
# * `:engine_version` - (String)
|
1640
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
1641
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
1642
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
1643
|
-
# * `:license_model` - (String)
|
1644
|
-
# * `:iops` - (Integer)
|
1645
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
1646
|
-
# * `:option_group_name` - (String)
|
1647
|
-
# * `:status` - (String)
|
1648
|
-
# * `:character_set_name` - (String)
|
1649
|
-
# * `:secondary_availability_zone` - (String)
|
1650
|
-
# * `:publicly_accessible` - (Boolean)
|
1651
|
-
# * `:status_infos` - (Array<Hash>)
|
1652
|
-
# * `:status_type` - (String)
|
1653
|
-
# * `:normal` - (Boolean)
|
1654
|
-
# * `:status` - (String)
|
1655
|
-
# * `:message` - (String)
|
1656
|
-
|
1657
|
-
# @!method modify_db_parameter_group(options = {})
|
1658
|
-
# Calls the ModifyDBParameterGroup API operation.
|
1659
|
-
# @param [Hash] options
|
1660
|
-
#
|
1661
|
-
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
1662
|
-
# database parameter group.
|
1663
|
-
# * `:parameters` - *required* - (Array<Hash>) An array of parameter
|
1664
|
-
# names, values, and the apply method for the parameter update. At
|
1665
|
-
# least one parameter name, value, and apply method must be supplied;
|
1666
|
-
# subsequent arguments are optional. A maximum of 20 parameters may
|
1667
|
-
# be modified in a single request.
|
1668
|
-
# * `:parameter_name` - (String) Specifies the name of the parameter.
|
1669
|
-
# * `:parameter_value` - (String) Specifies the value of the
|
1670
|
-
# parameter.
|
1671
|
-
# * `:description` - (String) Provides a description of the
|
1672
|
-
# parameter.
|
1673
|
-
# * `:source` - (String) Indicates the source of the parameter value.
|
1674
|
-
# * `:apply_type` - (String) Specifies the engine specific parameters
|
1675
|
-
# type.
|
1676
|
-
# * `:data_type` - (String) Specifies the valid data type for the
|
1677
|
-
# parameter.
|
1678
|
-
# * `:allowed_values` - (String) Specifies the valid range of values
|
1679
|
-
# for the parameter.
|
1680
|
-
# * `:is_modifiable` - (Boolean) Indicates whether ( `true` ) or not
|
1681
|
-
# ( `false` ) the parameter can be modified. Some parameters have
|
1682
|
-
# security or operational implications that prevent them from being
|
1683
|
-
# changed.
|
1684
|
-
# * `:minimum_engine_version` - (String) The earliest engine version
|
1685
|
-
# to which the parameter can apply.
|
1686
|
-
# * `:apply_method` - (String) Indicates when to apply parameter
|
1687
|
-
# updates. Valid values include:
|
1688
|
-
# * `immediate`
|
1689
|
-
# * `pending-reboot`
|
1690
|
-
# @return [Core::Response]
|
1691
|
-
# The #data method of the response object returns
|
1692
|
-
# a hash with the following structure:
|
1693
|
-
#
|
1694
|
-
# * `:db_parameter_group_name` - (String)
|
1695
|
-
|
1696
|
-
# @!method modify_db_subnet_group(options = {})
|
1697
|
-
# Calls the ModifyDBSubnetGroup API operation.
|
1698
|
-
# @param [Hash] options
|
1699
|
-
#
|
1700
|
-
# * `:db_subnet_group_name` - *required* - (String) The name for the DB
|
1701
|
-
# Subnet Group. This value is stored as a lowercase string.
|
1702
|
-
# Constraints: Must contain no more than 255 alphanumeric characters
|
1703
|
-
# or hyphens. Must not be "Default". Example: mySubnetgroup
|
1704
|
-
# * `:db_subnet_group_description` - (String) The description for the
|
1705
|
-
# DB Subnet Group.
|
1706
|
-
# * `:subnet_ids` - *required* - (Array<String>) The EC2 Subnet IDs for
|
1707
|
-
# the DB Subnet Group.
|
1708
|
-
# @return [Core::Response]
|
1709
|
-
# The #data method of the response object returns
|
1710
|
-
# a hash with the following structure:
|
1711
|
-
#
|
1712
|
-
# * `:db_subnet_group_name` - (String)
|
1713
|
-
# * `:db_subnet_group_description` - (String)
|
1714
|
-
# * `:vpc_id` - (String)
|
1715
|
-
# * `:subnet_group_status` - (String)
|
1716
|
-
# * `:subnets` - (Array<Hash>)
|
1717
|
-
# * `:subnet_identifier` - (String)
|
1718
|
-
# * `:subnet_availability_zone` - (Hash)
|
1719
|
-
# * `:name` - (String)
|
1720
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
1721
|
-
# * `:subnet_status` - (String)
|
1722
|
-
|
1723
|
-
# @!method modify_event_subscription(options = {})
|
1724
|
-
# Calls the ModifyEventSubscription API operation.
|
1725
|
-
# @param [Hash] options
|
1726
|
-
#
|
1727
|
-
# * `:subscription_name` - *required* - (String) The name of the RDS
|
1728
|
-
# event notification subscription.
|
1729
|
-
# * `:sns_topic_arn` - (String) The Amazon Resource Name (ARN) of the
|
1730
|
-
# SNS topic created for event notification. The ARN is created by
|
1731
|
-
# Amazon SNS when you create a topic and subscribe to it.
|
1732
|
-
# * `:source_type` - (String) The type of source that will be
|
1733
|
-
# generating the events. For example, if you want to be notified of
|
1734
|
-
# events generated by a DB instance, you would set this parameter to
|
1735
|
-
# db-instance. if this value is not specified, all events are
|
1736
|
-
# returned. Valid values: db-instance | db-parameter-group |
|
1737
|
-
# db-security-group | db-snapshot
|
1738
|
-
# * `:event_categories` - (Array<String>) A list of event categories
|
1739
|
-
# for a SourceType that you want to subscribe to. You can see a list
|
1740
|
-
# of the categories for a given SourceType in the Events topic in the
|
1741
|
-
# Amazon RDS User Guide or by using the DescribeEventCategories
|
1742
|
-
# action.
|
1743
|
-
# * `:enabled` - (Boolean) A Boolean value; set to `true` to activate
|
1744
|
-
# the subscription.
|
1745
|
-
# @return [Core::Response]
|
1746
|
-
# The #data method of the response object returns
|
1747
|
-
# a hash with the following structure:
|
1748
|
-
#
|
1749
|
-
# * `:customer_aws_id` - (String)
|
1750
|
-
# * `:cust_subscription_id` - (String)
|
1751
|
-
# * `:sns_topic_arn` - (String)
|
1752
|
-
# * `:status` - (String)
|
1753
|
-
# * `:subscription_creation_time` - (String)
|
1754
|
-
# * `:source_type` - (String)
|
1755
|
-
# * `:source_ids_list` - (Array<String>)
|
1756
|
-
# * `:event_categories_list` - (Array<String>)
|
1757
|
-
# * `:enabled` - (Boolean)
|
1758
|
-
|
1759
|
-
# @!method modify_option_group(options = {})
|
1760
|
-
# Calls the ModifyOptionGroup API operation.
|
1761
|
-
# @param [Hash] options
|
1762
|
-
#
|
1763
|
-
# * `:option_group_name` - *required* - (String) The name of the option
|
1764
|
-
# group to be modified.
|
1765
|
-
# * `:options_to_include` - (Array<Hash>) Options in this list are
|
1766
|
-
# added to the Option Group or, if already present, the specified
|
1767
|
-
# configuration is used to update the existing configuration.
|
1768
|
-
# * `:option_name` - *required* - (String) The configuration of
|
1769
|
-
# options to include in a group.
|
1770
|
-
# * `:port` - (Integer) The optional port for the option.
|
1771
|
-
# * `:db_security_group_memberships` - (Array<String>) A list of
|
1772
|
-
# DBSecurityGroupMemebrship name strings used for this option.
|
1773
|
-
# * `:vpc_security_group_memberships` - (Array<String>) A list of
|
1774
|
-
# VpcSecurityGroupMemebrship name strings used for this option.
|
1775
|
-
# * `:option_settings` - (Array<Hash>) The option settings to include
|
1776
|
-
# in an option group.
|
1777
|
-
# * `:name` - (String) The name of the option that has settings
|
1778
|
-
# that you can set.
|
1779
|
-
# * `:value` - (String) The current value of the option setting.
|
1780
|
-
# * `:default_value` - (String) The default value of the option
|
1781
|
-
# setting.
|
1782
|
-
# * `:description` - (String) The description of the option
|
1783
|
-
# setting.
|
1784
|
-
# * `:apply_type` - (String) The DB engine specific parameter type.
|
1785
|
-
# * `:data_type` - (String) The data type of the option setting.
|
1786
|
-
# * `:allowed_values` - (String) The allowed values of the option
|
1787
|
-
# setting.
|
1788
|
-
# * `:is_modifiable` - (Boolean) A Boolean value that, when `true`
|
1789
|
-
# , indicates the option setting can be modified from the
|
1790
|
-
# default.
|
1791
|
-
# * `:is_collection` - (Boolean) Indicates if the option setting is
|
1792
|
-
# part of a collection.
|
1793
|
-
# * `:options_to_remove` - (Array<String>) Options in this list are
|
1794
|
-
# removed from the Option Group.
|
1795
|
-
# * `:apply_immediately` - (Boolean) Indicates whether the changes
|
1796
|
-
# should be applied immediately, or during the next maintenance
|
1797
|
-
# window for each instance associated with the Option Group.
|
1798
|
-
# @return [Core::Response]
|
1799
|
-
# The #data method of the response object returns
|
1800
|
-
# a hash with the following structure:
|
1801
|
-
#
|
1802
|
-
# * `:option_group_name` - (String)
|
1803
|
-
# * `:option_group_description` - (String)
|
1804
|
-
# * `:engine_name` - (String)
|
1805
|
-
# * `:major_engine_version` - (String)
|
1806
|
-
# * `:options` - (Array<Hash>)
|
1807
|
-
# * `:option_name` - (String)
|
1808
|
-
# * `:option_description` - (String)
|
1809
|
-
# * `:persistent` - (Boolean)
|
1810
|
-
# * `:permanent` - (Boolean)
|
1811
|
-
# * `:port` - (Integer)
|
1812
|
-
# * `:option_settings` - (Array<Hash>)
|
1813
|
-
# * `:name` - (String)
|
1814
|
-
# * `:value` - (String)
|
1815
|
-
# * `:default_value` - (String)
|
1816
|
-
# * `:description` - (String)
|
1817
|
-
# * `:apply_type` - (String)
|
1818
|
-
# * `:data_type` - (String)
|
1819
|
-
# * `:allowed_values` - (String)
|
1820
|
-
# * `:is_modifiable` - (Boolean)
|
1821
|
-
# * `:is_collection` - (Boolean)
|
1822
|
-
# * `:db_security_group_memberships` - (Array<Hash>)
|
1823
|
-
# * `:db_security_group_name` - (String)
|
1824
|
-
# * `:status` - (String)
|
1825
|
-
# * `:vpc_security_group_memberships` - (Array<Hash>)
|
1826
|
-
# * `:vpc_security_group_id` - (String)
|
1827
|
-
# * `:status` - (String)
|
1828
|
-
# * `:allows_vpc_and_non_vpc_instance_memberships` - (Boolean)
|
1829
|
-
# * `:vpc_id` - (String)
|
1830
|
-
|
1831
|
-
# @!method promote_read_replica(options = {})
|
1832
|
-
# Calls the PromoteReadReplica API operation.
|
1833
|
-
# @param [Hash] options
|
1834
|
-
#
|
1835
|
-
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
1836
|
-
# identifier. This value is stored as a lowercase string.
|
1837
|
-
# Constraints: Must be the identifier for an existing Read Replica DB
|
1838
|
-
# Instance Must contain from 1 to 63 alphanumeric characters or
|
1839
|
-
# hyphens First character must be a letter Cannot end with a hyphen
|
1840
|
-
# or contain two consecutive hyphens Example: mydbinstance
|
1841
|
-
# * `:backup_retention_period` - (Integer) The number of days to retain
|
1842
|
-
# automated backups. Setting this parameter to a positive number
|
1843
|
-
# enables backups. Setting this parameter to 0 disables automated
|
1844
|
-
# backups. Default: 1 Constraints: Must be a value from 0 to 8
|
1845
|
-
# * `:preferred_backup_window` - (String) The daily time range during
|
1846
|
-
# which automated backups are created if automated backups are
|
1847
|
-
# enabled, using the BackupRetentionPeriod parameter. Default: A
|
1848
|
-
# 30-minute window selected at random from an 8-hour block of time
|
1849
|
-
# per region. The following list shows the time blocks for each
|
1850
|
-
# region from which the default backup windows are assigned. US-East
|
1851
|
-
# (Northern Virginia) Region: 03:00-11:00 UTC US-West (Northern
|
1852
|
-
# California) Region: 06:00-14:00 UTC EU (Ireland) Region:
|
1853
|
-
# 22:00-06:00 UTC Asia Pacific (Singapore) Region: 14:00-22:00 UTC
|
1854
|
-
# Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Constraints: Must be
|
1855
|
-
# in the format hh24:mi-hh24:mi. Times should be Universal Time
|
1856
|
-
# Coordinated (UTC). Must not conflict with the preferred maintenance
|
1857
|
-
# window. Must be at least 30 minutes.
|
1858
|
-
# @return [Core::Response]
|
1859
|
-
# The #data method of the response object returns
|
1860
|
-
# a hash with the following structure:
|
1861
|
-
#
|
1862
|
-
# * `:db_instance_identifier` - (String)
|
1863
|
-
# * `:db_instance_class` - (String)
|
1864
|
-
# * `:engine` - (String)
|
1865
|
-
# * `:db_instance_status` - (String)
|
1866
|
-
# * `:master_username` - (String)
|
1867
|
-
# * `:db_name` - (String)
|
1868
|
-
# * `:endpoint` - (Hash)
|
1869
|
-
# * `:address` - (String)
|
1870
|
-
# * `:port` - (Integer)
|
1871
|
-
# * `:allocated_storage` - (Integer)
|
1872
|
-
# * `:instance_create_time` - (Time)
|
1873
|
-
# * `:preferred_backup_window` - (String)
|
1874
|
-
# * `:backup_retention_period` - (Integer)
|
1875
|
-
# * `:db_security_groups` - (Array<Hash>)
|
1876
|
-
# * `:db_security_group_name` - (String)
|
1877
|
-
# * `:status` - (String)
|
1878
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
1879
|
-
# * `:vpc_security_group_id` - (String)
|
1880
|
-
# * `:status` - (String)
|
1881
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
1882
|
-
# * `:db_parameter_group_name` - (String)
|
1883
|
-
# * `:parameter_apply_status` - (String)
|
1884
|
-
# * `:availability_zone` - (String)
|
1885
|
-
# * `:db_subnet_group` - (Hash)
|
1886
|
-
# * `:db_subnet_group_name` - (String)
|
1887
|
-
# * `:db_subnet_group_description` - (String)
|
1888
|
-
# * `:vpc_id` - (String)
|
1889
|
-
# * `:subnet_group_status` - (String)
|
1890
|
-
# * `:subnets` - (Array<Hash>)
|
1891
|
-
# * `:subnet_identifier` - (String)
|
1892
|
-
# * `:subnet_availability_zone` - (Hash)
|
1893
|
-
# * `:name` - (String)
|
1894
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
1895
|
-
# * `:subnet_status` - (String)
|
1896
|
-
# * `:preferred_maintenance_window` - (String)
|
1897
|
-
# * `:pending_modified_values` - (Hash)
|
1898
|
-
# * `:db_instance_class` - (String)
|
1899
|
-
# * `:allocated_storage` - (Integer)
|
1900
|
-
# * `:master_user_password` - (String)
|
1901
|
-
# * `:port` - (Integer)
|
1902
|
-
# * `:backup_retention_period` - (Integer)
|
1903
|
-
# * `:multi_az` - (Boolean)
|
1904
|
-
# * `:engine_version` - (String)
|
1905
|
-
# * `:iops` - (Integer)
|
1906
|
-
# * `:db_instance_identifier` - (String)
|
1907
|
-
# * `:latest_restorable_time` - (Time)
|
1908
|
-
# * `:multi_az` - (Boolean)
|
1909
|
-
# * `:engine_version` - (String)
|
1910
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
1911
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
1912
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
1913
|
-
# * `:license_model` - (String)
|
1914
|
-
# * `:iops` - (Integer)
|
1915
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
1916
|
-
# * `:option_group_name` - (String)
|
1917
|
-
# * `:status` - (String)
|
1918
|
-
# * `:character_set_name` - (String)
|
1919
|
-
# * `:secondary_availability_zone` - (String)
|
1920
|
-
# * `:publicly_accessible` - (Boolean)
|
1921
|
-
# * `:status_infos` - (Array<Hash>)
|
1922
|
-
# * `:status_type` - (String)
|
1923
|
-
# * `:normal` - (Boolean)
|
1924
|
-
# * `:status` - (String)
|
1925
|
-
# * `:message` - (String)
|
1926
|
-
|
1927
|
-
# @!method purchase_reserved_db_instances_offering(options = {})
|
1928
|
-
# Calls the PurchaseReservedDBInstancesOffering API operation.
|
1929
|
-
# @param [Hash] options
|
1930
|
-
#
|
1931
|
-
# * `:reserved_db_instances_offering_id` - *required* - (String) The ID
|
1932
|
-
# of the Reserved DB Instance offering to purchase. Example:
|
1933
|
-
# 438012d3-4052-4cc7-b2e3-8d3372e0e706
|
1934
|
-
# * `:reserved_db_instance_id` - (String) Customer-specified identifier
|
1935
|
-
# to track this reservation. Example: myreservationID
|
1936
|
-
# * `:db_instance_count` - (Integer) The number of instances to
|
1937
|
-
# reserve. Default: 1
|
1938
|
-
# @return [Core::Response]
|
1939
|
-
# The #data method of the response object returns
|
1940
|
-
# a hash with the following structure:
|
1941
|
-
#
|
1942
|
-
# * `:reserved_db_instance_id` - (String)
|
1943
|
-
# * `:reserved_db_instances_offering_id` - (String)
|
1944
|
-
# * `:db_instance_class` - (String)
|
1945
|
-
# * `:start_time` - (Time)
|
1946
|
-
# * `:duration` - (Integer)
|
1947
|
-
# * `:fixed_price` - (Numeric)
|
1948
|
-
# * `:usage_price` - (Numeric)
|
1949
|
-
# * `:currency_code` - (String)
|
1950
|
-
# * `:db_instance_count` - (Integer)
|
1951
|
-
# * `:product_description` - (String)
|
1952
|
-
# * `:offering_type` - (String)
|
1953
|
-
# * `:multi_az` - (Boolean)
|
1954
|
-
# * `:state` - (String)
|
1955
|
-
# * `:recurring_charges` - (Array<Hash>)
|
1956
|
-
# * `:recurring_charge_amount` - (Numeric)
|
1957
|
-
# * `:recurring_charge_frequency` - (String)
|
1958
|
-
|
1959
|
-
# @!method reboot_db_instance(options = {})
|
1960
|
-
# Calls the RebootDBInstance API operation.
|
1961
|
-
# @param [Hash] options
|
1962
|
-
#
|
1963
|
-
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
1964
|
-
# identifier. This parameter is stored as a lowercase string.
|
1965
|
-
# * `:force_failover` - (Boolean) When `true` , the reboot will be
|
1966
|
-
# conducted through a MultiAZ failover. Constraint: You cannot
|
1967
|
-
# specify `true` if the instance is not configured for MultiAZ.
|
1968
|
-
# @return [Core::Response]
|
1969
|
-
# The #data method of the response object returns
|
1970
|
-
# a hash with the following structure:
|
1971
|
-
#
|
1972
|
-
# * `:db_instance_identifier` - (String)
|
1973
|
-
# * `:db_instance_class` - (String)
|
1974
|
-
# * `:engine` - (String)
|
1975
|
-
# * `:db_instance_status` - (String)
|
1976
|
-
# * `:master_username` - (String)
|
1977
|
-
# * `:db_name` - (String)
|
1978
|
-
# * `:endpoint` - (Hash)
|
1979
|
-
# * `:address` - (String)
|
1980
|
-
# * `:port` - (Integer)
|
1981
|
-
# * `:allocated_storage` - (Integer)
|
1982
|
-
# * `:instance_create_time` - (Time)
|
1983
|
-
# * `:preferred_backup_window` - (String)
|
1984
|
-
# * `:backup_retention_period` - (Integer)
|
1985
|
-
# * `:db_security_groups` - (Array<Hash>)
|
1986
|
-
# * `:db_security_group_name` - (String)
|
1987
|
-
# * `:status` - (String)
|
1988
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
1989
|
-
# * `:vpc_security_group_id` - (String)
|
1990
|
-
# * `:status` - (String)
|
1991
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
1992
|
-
# * `:db_parameter_group_name` - (String)
|
1993
|
-
# * `:parameter_apply_status` - (String)
|
1994
|
-
# * `:availability_zone` - (String)
|
1995
|
-
# * `:db_subnet_group` - (Hash)
|
1996
|
-
# * `:db_subnet_group_name` - (String)
|
1997
|
-
# * `:db_subnet_group_description` - (String)
|
1998
|
-
# * `:vpc_id` - (String)
|
1999
|
-
# * `:subnet_group_status` - (String)
|
2000
|
-
# * `:subnets` - (Array<Hash>)
|
2001
|
-
# * `:subnet_identifier` - (String)
|
2002
|
-
# * `:subnet_availability_zone` - (Hash)
|
2003
|
-
# * `:name` - (String)
|
2004
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
2005
|
-
# * `:subnet_status` - (String)
|
2006
|
-
# * `:preferred_maintenance_window` - (String)
|
2007
|
-
# * `:pending_modified_values` - (Hash)
|
2008
|
-
# * `:db_instance_class` - (String)
|
2009
|
-
# * `:allocated_storage` - (Integer)
|
2010
|
-
# * `:master_user_password` - (String)
|
2011
|
-
# * `:port` - (Integer)
|
2012
|
-
# * `:backup_retention_period` - (Integer)
|
2013
|
-
# * `:multi_az` - (Boolean)
|
2014
|
-
# * `:engine_version` - (String)
|
2015
|
-
# * `:iops` - (Integer)
|
2016
|
-
# * `:db_instance_identifier` - (String)
|
2017
|
-
# * `:latest_restorable_time` - (Time)
|
2018
|
-
# * `:multi_az` - (Boolean)
|
2019
|
-
# * `:engine_version` - (String)
|
2020
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
2021
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
2022
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
2023
|
-
# * `:license_model` - (String)
|
2024
|
-
# * `:iops` - (Integer)
|
2025
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
2026
|
-
# * `:option_group_name` - (String)
|
2027
|
-
# * `:status` - (String)
|
2028
|
-
# * `:character_set_name` - (String)
|
2029
|
-
# * `:secondary_availability_zone` - (String)
|
2030
|
-
# * `:publicly_accessible` - (Boolean)
|
2031
|
-
# * `:status_infos` - (Array<Hash>)
|
2032
|
-
# * `:status_type` - (String)
|
2033
|
-
# * `:normal` - (Boolean)
|
2034
|
-
# * `:status` - (String)
|
2035
|
-
# * `:message` - (String)
|
2036
|
-
|
2037
|
-
# @!method remove_source_identifier_from_subscription(options = {})
|
2038
|
-
# Calls the RemoveSourceIdentifierFromSubscription API operation.
|
2039
|
-
# @param [Hash] options
|
2040
|
-
#
|
2041
|
-
# * `:subscription_name` - *required* - (String) The name of the RDS
|
2042
|
-
# event notification subscription you want to remove a source
|
2043
|
-
# identifier from.
|
2044
|
-
# * `:source_identifier` - *required* - (String) The source identifier
|
2045
|
-
# to be removed from the subscription, such as the DB instance
|
2046
|
-
# identifier for a DB instance or the name of a security group.
|
2047
|
-
# @return [Core::Response]
|
2048
|
-
# The #data method of the response object returns
|
2049
|
-
# a hash with the following structure:
|
2050
|
-
#
|
2051
|
-
# * `:customer_aws_id` - (String)
|
2052
|
-
# * `:cust_subscription_id` - (String)
|
2053
|
-
# * `:sns_topic_arn` - (String)
|
2054
|
-
# * `:status` - (String)
|
2055
|
-
# * `:subscription_creation_time` - (String)
|
2056
|
-
# * `:source_type` - (String)
|
2057
|
-
# * `:source_ids_list` - (Array<String>)
|
2058
|
-
# * `:event_categories_list` - (Array<String>)
|
2059
|
-
# * `:enabled` - (Boolean)
|
2060
|
-
|
2061
|
-
# @!method remove_tags_from_resource(options = {})
|
2062
|
-
# Calls the RemoveTagsFromResource API operation.
|
2063
|
-
# @param [Hash] options
|
2064
|
-
#
|
2065
|
-
# * `:resource_name` - *required* - (String) The DB Instance the tags
|
2066
|
-
# will be removed from.
|
2067
|
-
# * `:tag_keys` - *required* - (Array<String>) The tag key (name) of
|
2068
|
-
# the tag to be removed.
|
2069
|
-
# @return [Core::Response]
|
2070
|
-
|
2071
|
-
# @!method reset_db_parameter_group(options = {})
|
2072
|
-
# Calls the ResetDBParameterGroup API operation.
|
2073
|
-
# @param [Hash] options
|
2074
|
-
#
|
2075
|
-
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
2076
|
-
# DB Parameter Group.
|
2077
|
-
# * `:reset_all_parameters` - (Boolean) Specifies whether ( `true` ) or
|
2078
|
-
# not ( `false` ) to reset all parameters in the DB Parameter Group
|
2079
|
-
# to default values.
|
2080
|
-
# * `:parameters` - (Array<Hash>) An array of parameter names, values,
|
2081
|
-
# and the apply method for the parameter update. At least one
|
2082
|
-
# parameter name, value, and apply method must be supplied;
|
2083
|
-
# subsequent arguments are optional. A maximum of 20 parameters may
|
2084
|
-
# be modified in a single request.
|
2085
|
-
# * `:parameter_name` - (String) Specifies the name of the parameter.
|
2086
|
-
# * `:parameter_value` - (String) Specifies the value of the
|
2087
|
-
# parameter.
|
2088
|
-
# * `:description` - (String) Provides a description of the
|
2089
|
-
# parameter.
|
2090
|
-
# * `:source` - (String) Indicates the source of the parameter value.
|
2091
|
-
# * `:apply_type` - (String) Specifies the engine specific parameters
|
2092
|
-
# type.
|
2093
|
-
# * `:data_type` - (String) Specifies the valid data type for the
|
2094
|
-
# parameter.
|
2095
|
-
# * `:allowed_values` - (String) Specifies the valid range of values
|
2096
|
-
# for the parameter.
|
2097
|
-
# * `:is_modifiable` - (Boolean) Indicates whether ( `true` ) or not
|
2098
|
-
# ( `false` ) the parameter can be modified. Some parameters have
|
2099
|
-
# security or operational implications that prevent them from being
|
2100
|
-
# changed.
|
2101
|
-
# * `:minimum_engine_version` - (String) The earliest engine version
|
2102
|
-
# to which the parameter can apply.
|
2103
|
-
# * `:apply_method` - (String) Indicates when to apply parameter
|
2104
|
-
# updates. Valid values include:
|
2105
|
-
# * `immediate`
|
2106
|
-
# * `pending-reboot`
|
2107
|
-
# @return [Core::Response]
|
2108
|
-
# The #data method of the response object returns
|
2109
|
-
# a hash with the following structure:
|
2110
|
-
#
|
2111
|
-
# * `:db_parameter_group_name` - (String)
|
2112
|
-
|
2113
|
-
# @!method restore_db_instance_from_db_snapshot(options = {})
|
2114
|
-
# Calls the RestoreDBInstanceFromDBSnapshot API operation.
|
2115
|
-
# @param [Hash] options
|
2116
|
-
#
|
2117
|
-
# * `:db_instance_identifier` - *required* - (String) The identifier
|
2118
|
-
# for the DB Snapshot to restore from.
|
2119
|
-
# * `:db_snapshot_identifier` - *required* - (String) Name of the DB
|
2120
|
-
# Instance to create from the DB Snapshot. This parameter isn't case
|
2121
|
-
# sensitive.
|
2122
|
-
# * `:db_instance_class` - (String) The compute and memory capacity of
|
2123
|
-
# the Amazon RDS DB instance.
|
2124
|
-
# * `:port` - (Integer) The port number on which the database accepts
|
2125
|
-
# connections.
|
2126
|
-
# * `:availability_zone` - (String) The EC2 Availability Zone that the
|
2127
|
-
# database instance will be created in.
|
2128
|
-
# * `:db_subnet_group_name` - (String) The DB Subnet Group name to use
|
2129
|
-
# for the new instance.
|
2130
|
-
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
2131
|
-
# deployment. Constraint: You cannot specify the AvailabilityZone
|
2132
|
-
# parameter if the MultiAZ parameter is set to `true` .
|
2133
|
-
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
2134
|
-
# options for the DB Instance. A value of `true` specifies an
|
2135
|
-
# Internet-facing instance with a publicly resolvable DNS name, which
|
2136
|
-
# resolves to a public IP address. A value of `false` specifies an
|
2137
|
-
# internal instance with a DNS name that resolves to a private IP
|
2138
|
-
# address. Default: The default behavior varies depending on whether
|
2139
|
-
# a VPC has been requested or not. The following list shows the
|
2140
|
-
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
2141
|
-
# no DB subnet group has been specified as part of the request and
|
2142
|
-
# the PubliclyAccessible value has not been set, the DB instance will
|
2143
|
-
# be publicly accessible. If a specific DB subnet group has been
|
2144
|
-
# specified as part of the request and the PubliclyAccessible value
|
2145
|
-
# has not been set, the DB instance will be private.
|
2146
|
-
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
2147
|
-
# version upgrades will be applied automatically to the DB Instance
|
2148
|
-
# during the maintenance window.
|
2149
|
-
# * `:license_model` - (String) License model information for the
|
2150
|
-
# restored DB Instance. Default: Same as source. Valid values:
|
2151
|
-
# license-included | bring-your-own-license | general-public-license
|
2152
|
-
# * `:db_name` - (String) The database name for the restored DB
|
2153
|
-
# Instance. This parameter doesn't apply to the MySQL engine.
|
2154
|
-
# * `:engine` - (String) The database engine to use for the new
|
2155
|
-
# instance. Default: The same as source Constraint: Must be
|
2156
|
-
# compatible with the engine of the source Example: oracle-ee
|
2157
|
-
# * `:iops` - (Integer) The amount of Provisioned IOPS (input/output
|
2158
|
-
# operations per second) to be initially allocated for the DB
|
2159
|
-
# Instance. Constraints: Must be an integer greater than 1000.
|
2160
|
-
# * `:option_group_name` - (String) The name of the option group to be
|
2161
|
-
# used for the restored DB instance. Permanent options, such as the
|
2162
|
-
# TDE option for Oracle Advanced Security TDE, cannot be removed from
|
2163
|
-
# an option group, and that option group cannot be removed from a DB
|
2164
|
-
# instance once it is associated with a DB instance
|
2165
|
-
# @return [Core::Response]
|
2166
|
-
# The #data method of the response object returns
|
2167
|
-
# a hash with the following structure:
|
2168
|
-
#
|
2169
|
-
# * `:db_instance_identifier` - (String)
|
2170
|
-
# * `:db_instance_class` - (String)
|
2171
|
-
# * `:engine` - (String)
|
2172
|
-
# * `:db_instance_status` - (String)
|
2173
|
-
# * `:master_username` - (String)
|
2174
|
-
# * `:db_name` - (String)
|
2175
|
-
# * `:endpoint` - (Hash)
|
2176
|
-
# * `:address` - (String)
|
2177
|
-
# * `:port` - (Integer)
|
2178
|
-
# * `:allocated_storage` - (Integer)
|
2179
|
-
# * `:instance_create_time` - (Time)
|
2180
|
-
# * `:preferred_backup_window` - (String)
|
2181
|
-
# * `:backup_retention_period` - (Integer)
|
2182
|
-
# * `:db_security_groups` - (Array<Hash>)
|
2183
|
-
# * `:db_security_group_name` - (String)
|
2184
|
-
# * `:status` - (String)
|
2185
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
2186
|
-
# * `:vpc_security_group_id` - (String)
|
2187
|
-
# * `:status` - (String)
|
2188
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
2189
|
-
# * `:db_parameter_group_name` - (String)
|
2190
|
-
# * `:parameter_apply_status` - (String)
|
2191
|
-
# * `:availability_zone` - (String)
|
2192
|
-
# * `:db_subnet_group` - (Hash)
|
2193
|
-
# * `:db_subnet_group_name` - (String)
|
2194
|
-
# * `:db_subnet_group_description` - (String)
|
2195
|
-
# * `:vpc_id` - (String)
|
2196
|
-
# * `:subnet_group_status` - (String)
|
2197
|
-
# * `:subnets` - (Array<Hash>)
|
2198
|
-
# * `:subnet_identifier` - (String)
|
2199
|
-
# * `:subnet_availability_zone` - (Hash)
|
2200
|
-
# * `:name` - (String)
|
2201
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
2202
|
-
# * `:subnet_status` - (String)
|
2203
|
-
# * `:preferred_maintenance_window` - (String)
|
2204
|
-
# * `:pending_modified_values` - (Hash)
|
2205
|
-
# * `:db_instance_class` - (String)
|
2206
|
-
# * `:allocated_storage` - (Integer)
|
2207
|
-
# * `:master_user_password` - (String)
|
2208
|
-
# * `:port` - (Integer)
|
2209
|
-
# * `:backup_retention_period` - (Integer)
|
2210
|
-
# * `:multi_az` - (Boolean)
|
2211
|
-
# * `:engine_version` - (String)
|
2212
|
-
# * `:iops` - (Integer)
|
2213
|
-
# * `:db_instance_identifier` - (String)
|
2214
|
-
# * `:latest_restorable_time` - (Time)
|
2215
|
-
# * `:multi_az` - (Boolean)
|
2216
|
-
# * `:engine_version` - (String)
|
2217
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
2218
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
2219
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
2220
|
-
# * `:license_model` - (String)
|
2221
|
-
# * `:iops` - (Integer)
|
2222
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
2223
|
-
# * `:option_group_name` - (String)
|
2224
|
-
# * `:status` - (String)
|
2225
|
-
# * `:character_set_name` - (String)
|
2226
|
-
# * `:secondary_availability_zone` - (String)
|
2227
|
-
# * `:publicly_accessible` - (Boolean)
|
2228
|
-
# * `:status_infos` - (Array<Hash>)
|
2229
|
-
# * `:status_type` - (String)
|
2230
|
-
# * `:normal` - (Boolean)
|
2231
|
-
# * `:status` - (String)
|
2232
|
-
# * `:message` - (String)
|
2233
|
-
|
2234
|
-
# @!method restore_db_instance_to_point_in_time(options = {})
|
2235
|
-
# Calls the RestoreDBInstanceToPointInTime API operation.
|
2236
|
-
# @param [Hash] options
|
2237
|
-
#
|
2238
|
-
# * `:source_db_instance_identifier` - *required* - (String) The
|
2239
|
-
# identifier of the source DB Instance from which to restore.
|
2240
|
-
# * `:target_db_instance_identifier` - *required* - (String) The name
|
2241
|
-
# of the new database instance to be created.
|
2242
|
-
# * `:restore_time` - (String<ISO8601 datetime>) The date and time from
|
2243
|
-
# to restore from.
|
2244
|
-
# * `:use_latest_restorable_time` - (Boolean) Specifies whether (
|
2245
|
-
# `true` ) or not ( `false` ) the DB Instance is restored from the
|
2246
|
-
# latest backup time.
|
2247
|
-
# * `:db_instance_class` - (String) The compute and memory capacity of
|
2248
|
-
# the Amazon RDS DB instance.
|
2249
|
-
# * `:port` - (Integer) The port number on which the database accepts
|
2250
|
-
# connections.
|
2251
|
-
# * `:availability_zone` - (String) The EC2 Availability Zone that the
|
2252
|
-
# database instance will be created in.
|
2253
|
-
# * `:db_subnet_group_name` - (String) The DB subnet group name to use
|
2254
|
-
# for the new instance.
|
2255
|
-
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
2256
|
-
# deployment. Constraint: You cannot specify the AvailabilityZone
|
2257
|
-
# parameter if the MultiAZ parameter is set to `true` .
|
2258
|
-
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
2259
|
-
# options for the DB Instance. A value of `true` specifies an
|
2260
|
-
# Internet-facing instance with a publicly resolvable DNS name, which
|
2261
|
-
# resolves to a public IP address. A value of `false` specifies an
|
2262
|
-
# internal instance with a DNS name that resolves to a private IP
|
2263
|
-
# address. Default: The default behavior varies depending on whether
|
2264
|
-
# a VPC has been requested or not. The following list shows the
|
2265
|
-
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
2266
|
-
# no DB subnet group has been specified as part of the request and
|
2267
|
-
# the PubliclyAccessible value has not been set, the DB instance will
|
2268
|
-
# be publicly accessible. If a specific DB subnet group has been
|
2269
|
-
# specified as part of the request and the PubliclyAccessible value
|
2270
|
-
# has not been set, the DB instance will be private.
|
2271
|
-
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
2272
|
-
# version upgrades will be applied automatically to the DB Instance
|
2273
|
-
# during the maintenance window.
|
2274
|
-
# * `:license_model` - (String) License model information for the
|
2275
|
-
# restored DB Instance. Default: Same as source. Valid values:
|
2276
|
-
# license-included | bring-your-own-license | general-public-license
|
2277
|
-
# * `:db_name` - (String) The database name for the restored DB
|
2278
|
-
# Instance. This parameter is not used for the MySQL engine.
|
2279
|
-
# * `:engine` - (String) The database engine to use for the new
|
2280
|
-
# instance. Default: The same as source Constraint: Must be
|
2281
|
-
# compatible with the engine of the source Example: oracle-ee
|
2282
|
-
# * `:iops` - (Integer) The amount of Provisioned IOPS (input/output
|
2283
|
-
# operations per second) to be initially allocated for the DB
|
2284
|
-
# Instance. Constraints: Must be an integer greater than 1000.
|
2285
|
-
# * `:option_group_name` - (String) The name of the option group to be
|
2286
|
-
# used for the restored DB instance. Permanent options, such as the
|
2287
|
-
# TDE option for Oracle Advanced Security TDE, cannot be removed from
|
2288
|
-
# an option group, and that option group cannot be removed from a DB
|
2289
|
-
# instance once it is associated with a DB instance
|
2290
|
-
# @return [Core::Response]
|
2291
|
-
# The #data method of the response object returns
|
2292
|
-
# a hash with the following structure:
|
2293
|
-
#
|
2294
|
-
# * `:db_instance_identifier` - (String)
|
2295
|
-
# * `:db_instance_class` - (String)
|
2296
|
-
# * `:engine` - (String)
|
2297
|
-
# * `:db_instance_status` - (String)
|
2298
|
-
# * `:master_username` - (String)
|
2299
|
-
# * `:db_name` - (String)
|
2300
|
-
# * `:endpoint` - (Hash)
|
2301
|
-
# * `:address` - (String)
|
2302
|
-
# * `:port` - (Integer)
|
2303
|
-
# * `:allocated_storage` - (Integer)
|
2304
|
-
# * `:instance_create_time` - (Time)
|
2305
|
-
# * `:preferred_backup_window` - (String)
|
2306
|
-
# * `:backup_retention_period` - (Integer)
|
2307
|
-
# * `:db_security_groups` - (Array<Hash>)
|
2308
|
-
# * `:db_security_group_name` - (String)
|
2309
|
-
# * `:status` - (String)
|
2310
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
2311
|
-
# * `:vpc_security_group_id` - (String)
|
2312
|
-
# * `:status` - (String)
|
2313
|
-
# * `:db_parameter_groups` - (Array<Hash>)
|
2314
|
-
# * `:db_parameter_group_name` - (String)
|
2315
|
-
# * `:parameter_apply_status` - (String)
|
2316
|
-
# * `:availability_zone` - (String)
|
2317
|
-
# * `:db_subnet_group` - (Hash)
|
2318
|
-
# * `:db_subnet_group_name` - (String)
|
2319
|
-
# * `:db_subnet_group_description` - (String)
|
2320
|
-
# * `:vpc_id` - (String)
|
2321
|
-
# * `:subnet_group_status` - (String)
|
2322
|
-
# * `:subnets` - (Array<Hash>)
|
2323
|
-
# * `:subnet_identifier` - (String)
|
2324
|
-
# * `:subnet_availability_zone` - (Hash)
|
2325
|
-
# * `:name` - (String)
|
2326
|
-
# * `:provisioned_iops_capable` - (Boolean)
|
2327
|
-
# * `:subnet_status` - (String)
|
2328
|
-
# * `:preferred_maintenance_window` - (String)
|
2329
|
-
# * `:pending_modified_values` - (Hash)
|
2330
|
-
# * `:db_instance_class` - (String)
|
2331
|
-
# * `:allocated_storage` - (Integer)
|
2332
|
-
# * `:master_user_password` - (String)
|
2333
|
-
# * `:port` - (Integer)
|
2334
|
-
# * `:backup_retention_period` - (Integer)
|
2335
|
-
# * `:multi_az` - (Boolean)
|
2336
|
-
# * `:engine_version` - (String)
|
2337
|
-
# * `:iops` - (Integer)
|
2338
|
-
# * `:db_instance_identifier` - (String)
|
2339
|
-
# * `:latest_restorable_time` - (Time)
|
2340
|
-
# * `:multi_az` - (Boolean)
|
2341
|
-
# * `:engine_version` - (String)
|
2342
|
-
# * `:auto_minor_version_upgrade` - (Boolean)
|
2343
|
-
# * `:read_replica_source_db_instance_identifier` - (String)
|
2344
|
-
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
2345
|
-
# * `:license_model` - (String)
|
2346
|
-
# * `:iops` - (Integer)
|
2347
|
-
# * `:option_group_memberships` - (Array<Hash>)
|
2348
|
-
# * `:option_group_name` - (String)
|
2349
|
-
# * `:status` - (String)
|
2350
|
-
# * `:character_set_name` - (String)
|
2351
|
-
# * `:secondary_availability_zone` - (String)
|
2352
|
-
# * `:publicly_accessible` - (Boolean)
|
2353
|
-
# * `:status_infos` - (Array<Hash>)
|
2354
|
-
# * `:status_type` - (String)
|
2355
|
-
# * `:normal` - (Boolean)
|
2356
|
-
# * `:status` - (String)
|
2357
|
-
# * `:message` - (String)
|
2358
|
-
|
2359
|
-
# @!method revoke_db_security_group_ingress(options = {})
|
2360
|
-
# Calls the RevokeDBSecurityGroupIngress API operation.
|
2361
|
-
# @param [Hash] options
|
2362
|
-
#
|
2363
|
-
# * `:db_security_group_name` - *required* - (String) The name of the
|
2364
|
-
# DB Security Group to revoke ingress from.
|
2365
|
-
# * `:cidrip` - (String) The IP range to revoke access from.
|
2366
|
-
# * `:ec2_security_group_name` - (String) The name of the EC2 Security
|
2367
|
-
# Group to revoke access from.
|
2368
|
-
# * `:ec2_security_group_id` - (String) The id of the EC2 Security
|
2369
|
-
# Group to revoke access from. For VPC DB Security Groups,
|
2370
|
-
# EC2SecurityGroupId must be provided. Otherwise,
|
2371
|
-
# EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
|
2372
|
-
# EC2SecurityGroupId must be provided.
|
2373
|
-
# * `:ec2_security_group_owner_id` - (String) The AWS Account Number of
|
2374
|
-
# the owner of the security group specified in the
|
2375
|
-
# EC2SecurityGroupName parameter. The AWS Access Key ID is not an
|
2376
|
-
# acceptable value.
|
2377
|
-
# @return [Core::Response]
|
2378
|
-
# The #data method of the response object returns
|
2379
|
-
# a hash with the following structure:
|
2380
|
-
#
|
2381
|
-
# * `:owner_id` - (String)
|
2382
|
-
# * `:db_security_group_name` - (String)
|
2383
|
-
# * `:db_security_group_description` - (String)
|
2384
|
-
# * `:vpc_id` - (String)
|
2385
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
2386
|
-
# * `:status` - (String)
|
2387
|
-
# * `:ec2_security_group_name` - (String)
|
2388
|
-
# * `:ec2_security_group_id` - (String)
|
2389
|
-
# * `:ec2_security_group_owner_id` - (String)
|
2390
|
-
# * `:ip_ranges` - (Array<Hash>)
|
2391
|
-
# * `:status` - (String)
|
2392
|
-
# * `:cidrip` - (String)
|
2393
|
-
|
2394
|
-
# end client methods #
|
2395
|
-
|
2396
29
|
define_client_methods('2013-05-15')
|
2397
30
|
|
2398
31
|
end
|