aws-sdk 1.6.9 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. data/README.rdoc +1 -1
  2. data/lib/aws.rb +8 -0
  3. data/lib/aws/api_config/CloudSearch-2011-02-01.yml +681 -0
  4. data/lib/aws/api_config/DynamoDB-2011-12-05.yml +4 -0
  5. data/lib/aws/api_config/EMR-2009-03-31.yml +18 -0
  6. data/lib/aws/api_config/ElastiCache-2012-03-09.yml +777 -0
  7. data/lib/aws/api_config/ElasticBeanstalk-2010-12-01.yml +823 -0
  8. data/lib/aws/api_config/RDS-2012-07-31.yml +1621 -0
  9. data/lib/aws/cloud_search.rb +31 -0
  10. data/lib/aws/cloud_search/client.rb +558 -0
  11. data/lib/aws/cloud_search/config.rb +18 -0
  12. data/lib/aws/cloud_search/errors.rb +22 -0
  13. data/lib/aws/cloud_search/request.rb +23 -0
  14. data/lib/aws/cloud_watch/alarm.rb +1 -1
  15. data/lib/aws/cloud_watch/metric.rb +3 -3
  16. data/lib/aws/core.rb +18 -3
  17. data/lib/aws/core/configuration.rb +11 -0
  18. data/lib/aws/core/inflection.rb +1 -0
  19. data/lib/aws/core/service_interface.rb +1 -1
  20. data/lib/aws/dynamo_db/batch_get.rb +19 -12
  21. data/lib/aws/dynamo_db/client.rb +27 -1
  22. data/lib/aws/dynamo_db/config.rb +2 -0
  23. data/lib/aws/dynamo_db/item_collection.rb +2 -2
  24. data/lib/aws/dynamo_db/table.rb +8 -2
  25. data/lib/aws/ec2/reserved_instances.rb +3 -0
  26. data/lib/aws/ec2/reserved_instances_offering.rb +3 -1
  27. data/lib/aws/elastic_beanstalk.rb +48 -0
  28. data/lib/aws/elastic_beanstalk/client.rb +867 -0
  29. data/lib/aws/elastic_beanstalk/config.rb +18 -0
  30. data/lib/aws/elastic_beanstalk/errors.rb +22 -0
  31. data/lib/aws/elastic_beanstalk/request.rb +23 -0
  32. data/lib/aws/elasticache.rb +48 -0
  33. data/lib/aws/elasticache/client.rb +758 -0
  34. data/lib/aws/elasticache/config.rb +18 -0
  35. data/lib/aws/elasticache/errors.rb +22 -0
  36. data/lib/aws/elasticache/request.rb +23 -0
  37. data/lib/aws/emr/client.rb +30 -6
  38. data/lib/aws/emr/job_flow.rb +10 -0
  39. data/lib/aws/rds.rb +69 -0
  40. data/lib/aws/rds/client.rb +1592 -0
  41. data/lib/aws/rds/config.rb +18 -0
  42. data/lib/aws/rds/db_instance.rb +201 -0
  43. data/lib/aws/rds/db_instance_collection.rb +75 -0
  44. data/lib/aws/rds/db_snapshot.rb +163 -0
  45. data/lib/aws/rds/db_snapshot_collection.rb +89 -0
  46. data/lib/aws/rds/errors.rb +22 -0
  47. data/lib/aws/rds/request.rb +23 -0
  48. data/lib/aws/s3/bucket_tag_collection.rb +1 -1
  49. data/lib/aws/s3/client.rb +4 -2
  50. data/lib/aws/s3/errors.rb +0 -1
  51. data/lib/aws/s3/object_collection.rb +40 -22
  52. data/lib/aws/s3/object_version.rb +7 -2
  53. data/lib/aws/s3/request.rb +1 -1
  54. data/lib/aws/s3/s3_object.rb +35 -11
  55. data/lib/aws/version.rb +1 -1
  56. metadata +33 -2
@@ -0,0 +1,18 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ AWS::Core::Configuration.module_eval do
15
+
16
+ add_service 'ElastiCache', 'elasticache', 'elasticache.us-east-1.amazonaws.com'
17
+
18
+ end
@@ -0,0 +1,22 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ module AWS
15
+ class ElastiCache
16
+ module Errors
17
+
18
+ extend Core::LazyErrorClasses
19
+
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,23 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ module AWS
15
+ class ElastiCache
16
+
17
+ # @private
18
+ class Request < Core::Http::Request
19
+ include Core::Signature::Version2
20
+ end
21
+
22
+ end
23
+ end
@@ -155,6 +155,7 @@ module AWS
155
155
  # * +:path+ - (String)
156
156
  # * +:args+ - (Array<String>)
157
157
  # * +:supported_products+ - (Array<String>)
158
+ # * +:visible_to_all_users+ - (Boolean)
158
159
 
159
160
  # @!method modify_instance_groups(options = {})
160
161
  # Calls the ModifyInstanceGroups API operation.
@@ -177,11 +178,11 @@ module AWS
177
178
  # additional features.
178
179
  # * +:ami_version+ - (String) The version of the Amazon Machine Image
179
180
  # (AMI) to use when launching Amazon EC2 instances in the job flow.
180
- # The following values ane valid: "latest" (latest AMI version;
181
+ # The following values are valid: "latest" (latest AMI version;
181
182
  # currently AMI 2.0, Hadoop 0.20.205) "2.0" (AMI 2.0, Hadoop
182
183
  # 0.20.205) "1.0" (AMI 1.0, Hadoop 0.18) If this value is not
183
184
  # specified, the job flow uses the default of (AMI 1.0, Hadoop 0.18).
184
- # If the AMI supports multiple verisons of Hadoop (for example, AMI
185
+ # If the AMI supports multiple versions of Hadoop (for example, AMI
185
186
  # 1.0 supports both Hadoop 0.18 and 0.20) you can use the
186
187
  # JobFlowInstancesConfig HadoopVersion parameter to modify the
187
188
  # version of Hadoop from the defaults shown above. For details about
@@ -266,10 +267,19 @@ module AWS
266
267
  # S3 or on a local file system.
267
268
  # * +:args+ - (Array<String>) A list of command line arguments to
268
269
  # pass to the bootstrap action script.
269
- # * +:supported_products+ - (Array<String>) A list of strings used by
270
- # third-party software to tag the job flow. Currently the only valid
271
- # value is "karmasphere-enterprise-utility", which tags the job flow
272
- # for management by Karmasphere.
270
+ # * +:supported_products+ - (Array<String>) A list of strings that
271
+ # indicates third-party software to use with the job flow. For more
272
+ # information, go to Use Third Party Applications with Amazon EMR.
273
+ # Currently supported values are: "karmasphere-enterprise-utility" -
274
+ # tag the job flow for management by Karmasphere. "mapr-m3" - launch
275
+ # the job flow using MapR M3 Edition. "mapr-m5" - launch the job flow
276
+ # using MapR M5 Edition.
277
+ # * +:visible_to_all_users+ - (Boolean) Whether the job flow is visible
278
+ # to all IAM users of the AWS account associated with the job flow.
279
+ # If this value is set to +true+ , all IAM users of that AWS account
280
+ # can view and (if they have the proper policy permissions set)
281
+ # manage the job flow. If it is set to +false+ , only the IAM user
282
+ # that created the job flow can view and manage it.
273
283
  # @return [Core::Response]
274
284
  # The #data method of the response object returns
275
285
  # a hash with the following structure:
@@ -288,6 +298,20 @@ module AWS
288
298
  # user intervention, or job-flow error.
289
299
  # @return [Core::Response]
290
300
 
301
+ # @!method set_visible_to_all_users(options = {})
302
+ # Calls the SetVisibleToAllUsers API operation.
303
+ # @param [Hash] options
304
+ # * +:job_flow_ids+ - *required* - (Array<String>) Identifiers of the
305
+ # job flows to receive the new visibility setting.
306
+ # * +:visible_to_all_users+ - *required* - (Boolean) Whether the
307
+ # specified job flows are visible to all IAM users of the AWS account
308
+ # associated with the job flow. If this value is set to True, all IAM
309
+ # users of that AWS account can view and, if they have the proper IAM
310
+ # policy permissions set, manage the job flows. If it is set to
311
+ # False, only the IAM user that created a job flow can view and
312
+ # manage it.
313
+ # @return [Core::Response]
314
+
291
315
  # @!method terminate_job_flows(options = {})
292
316
  # Calls the TerminateJobFlows API operation.
293
317
  # @param [Hash] options
@@ -268,6 +268,16 @@ module AWS
268
268
  nil
269
269
  end
270
270
 
271
+ # @param [Boolean] state
272
+ # @return [nil]
273
+ def set_visible_to_all_users state
274
+ options = {}
275
+ options[:visible_to_all_users] = state
276
+ options[:job_flow_ids] = [job_flow_id]
277
+ client.set_visible_to_all_users(options)
278
+ nil
279
+ end
280
+
271
281
  # Terminates the current job flow.
272
282
  # @return [nil]
273
283
  def terminate
@@ -0,0 +1,69 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ require 'aws/core'
15
+ require 'aws/rds/config'
16
+
17
+ module AWS
18
+
19
+ # This class is the starting point for working with Amazon Relational
20
+ # Database Service (RDS).
21
+ #
22
+ # For more information about RDS:
23
+ #
24
+ # * {Amazon RDS}[http://aws.amazon.com/rds/]
25
+ # * {Amazon RDS Documentation}[http://aws.amazon.com/documentation/rds/]
26
+ #
27
+ # = Credentials
28
+ #
29
+ # You can setup default credentials for all AWS services via
30
+ # AWS.config:
31
+ #
32
+ # AWS.config(
33
+ # :access_key_id => 'YOUR_ACCESS_KEY_ID',
34
+ # :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
35
+ #
36
+ # Or you can set them directly on the AWS::RDS interface:
37
+ #
38
+ # rds = AWS::RDS.new(
39
+ # :access_key_id => 'YOUR_ACCESS_KEY_ID',
40
+ # :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
41
+ #
42
+ class RDS
43
+
44
+ AWS.register_autoloads(self) do
45
+ autoload :Client, 'client'
46
+ autoload :Errors, 'errors'
47
+ autoload :DBInstance, 'db_instance'
48
+ autoload :DBInstanceCollection, 'db_instance_collection'
49
+ autoload :DBSnapshot, 'db_snapshot'
50
+ autoload :DBSnapshotCollection, 'db_snapshot_collection'
51
+ autoload :Request, 'request'
52
+ end
53
+
54
+ include Core::ServiceInterface
55
+
56
+ # @return [DBInstanceCollection]
57
+ def db_instances
58
+ DBInstanceCollection.new(:config => config)
59
+ end
60
+ alias_method :instances, :db_instances
61
+
62
+ # @return [DBSnapshotCollection]]
63
+ def db_snapshots
64
+ DBSnapshotCollection.new(:config => config)
65
+ end
66
+ alias_method :snapshots, :db_snapshots
67
+
68
+ end
69
+ end
@@ -0,0 +1,1592 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ module AWS
15
+ class RDS
16
+
17
+ # Client class for Amazon Relational Database Service (RDS).
18
+ class Client < Core::QueryClient
19
+
20
+ # @private
21
+ CACHEABLE_REQUESTS = Set[]
22
+
23
+ ## client methods ##
24
+
25
+ # @!method authorize_db_security_group_ingress(options = {})
26
+ # Calls the AuthorizeDBSecurityGroupIngress API operation.
27
+ # @param [Hash] options
28
+ # * +:db_security_group_name+ - *required* - (String) The name of the
29
+ # DB Security Group to authorize.
30
+ # * +:cidrip+ - (String) The IP range to authorize.
31
+ # * +:ec2_security_group_name+ - (String) Name of the EC2 Security
32
+ # Group to authorize.
33
+ # * +:ec2_security_group_id+ - (String) Id of the EC2 Security Group to
34
+ # authorize. For VPC DB Security Groups, EC2SecurityGroupId must be
35
+ # provided. Otherwise, EC2SecurityGroupOwnerId and either
36
+ # EC2SecurityGroupName or EC2SecurityGroupId must be provided.
37
+ # * +:ec2_security_group_owner_id+ - (String) AWS Account Number of the
38
+ # owner of the security group specified in the EC2SecurityGroupName
39
+ # parameter. The AWS Access Key ID is not an acceptable value.
40
+ # @return [Core::Response]
41
+ # The #data method of the response object returns
42
+ # a hash with the following structure:
43
+ # * +:owner_id+ - (String)
44
+ # * +:db_security_group_name+ - (String)
45
+ # * +:db_security_group_description+ - (String)
46
+ # * +:vpc_id+ - (String)
47
+ # * +:ec_2_security_groups+ - (Array<Hash>)
48
+ # * +:status+ - (String)
49
+ # * +:ec2_security_group_name+ - (String)
50
+ # * +:ec2_security_group_id+ - (String)
51
+ # * +:ec2_security_group_owner_id+ - (String)
52
+ # * +:ip_ranges+ - (Array<Hash>)
53
+ # * +:status+ - (String)
54
+ # * +:cidrip+ - (String)
55
+
56
+ # @!method copy_db_snapshot(options = {})
57
+ # Calls the CopyDBSnapshot API operation.
58
+ # @param [Hash] options
59
+ # * +:source_db_snapshot_identifier+ - *required* - (String) The
60
+ # identifier for the source DB snapshot. Constraints: Must be the
61
+ # identifier for a valid automated snapshot in the "available" state.
62
+ # Example: rds:mydb-2012-01-15-00-01
63
+ # * +:target_db_snapshot_identifier+ - *required* - (String) The
64
+ # identifier for the copied snapshot. Constraints: Cannot be null,
65
+ # empty, or blank Must contain from 1 to 255 alphanumeric characters
66
+ # or hyphens First character must be a letter Cannot end with a
67
+ # hyphen or contain two consecutive hyphens Example: my-db-snapshot
68
+ # @return [Core::Response]
69
+ # The #data method of the response object returns
70
+ # a hash with the following structure:
71
+ # * +:db_snapshot_identifier+ - (String)
72
+ # * +:db_instance_identifier+ - (String)
73
+ # * +:snapshot_create_time+ - (Time)
74
+ # * +:engine+ - (String)
75
+ # * +:allocated_storage+ - (Integer)
76
+ # * +:status+ - (String)
77
+ # * +:port+ - (Integer)
78
+ # * +:availability_zone+ - (String)
79
+ # * +:vpc_id+ - (String)
80
+ # * +:instance_create_time+ - (Time)
81
+ # * +:master_username+ - (String)
82
+ # * +:engine_version+ - (String)
83
+ # * +:license_model+ - (String)
84
+ # * +:snapshot_type+ - (String)
85
+
86
+ # @!method create_db_instance(options = {})
87
+ # Calls the CreateDBInstance API operation.
88
+ # @param [Hash] options
89
+ # * +:db_name+ - (String) The name of the database to create when the
90
+ # DB Instance is created. If this parameter is not specified, no
91
+ # database is created in the DB Instance.
92
+ # * +:db_instance_identifier+ - *required* - (String) The DB Instance
93
+ # identifier. This parameter is stored as a lowercase string.
94
+ # * +:allocated_storage+ - *required* - (Integer) The amount of storage
95
+ # (in gigabytes) to be initially allocated for the database instance.
96
+ # * +:db_instance_class+ - *required* - (String) The compute and memory
97
+ # capacity of the DB Instance.
98
+ # * +:engine+ - *required* - (String) The name of the database engine
99
+ # to be used for this instance.
100
+ # * +:master_username+ - *required* - (String) The name of master user
101
+ # for the client DB Instance.
102
+ # * +:master_user_password+ - *required* - (String) The password for
103
+ # the master DB Instance user.
104
+ # * +:db_security_groups+ - (Array<String>) A list of DB Security
105
+ # Groups to associate with this DB Instance.
106
+ # * +:availability_zone+ - (String) The EC2 Availability Zone that the
107
+ # database instance will be created in.
108
+ # * +:db_subnet_group_name+ - (String) A DB Subnet Group to associate
109
+ # with this DB Instance. If there is no DB Subnet Group, then it is a
110
+ # non-VPC DB instance.
111
+ # * +:preferred_maintenance_window+ - (String) The weekly time range
112
+ # (in UTC) during which system maintenance can occur.
113
+ # * +:db_parameter_group_name+ - (String) The name of the database
114
+ # parameter group to associate with this DB instance. If this
115
+ # argument is omitted, the default DBParameterGroup for the specified
116
+ # engine will be used.
117
+ # * +:backup_retention_period+ - (Integer) The number of days for which
118
+ # automated backups are retained. Setting this parameter to a
119
+ # positive number enables backups. Setting this parameter to 0
120
+ # disables automated backups.
121
+ # * +:preferred_backup_window+ - (String) The daily time range during
122
+ # which automated backups are created if automated backups are
123
+ # enabled, as determined by the BackupRetentionPeriod.
124
+ # * +:port+ - (Integer) The port number on which the database accepts
125
+ # connections.
126
+ # * +:multi_az+ - (Boolean) Specifies if the DB Instance is a Multi-AZ
127
+ # deployment. You cannot set the AvailabilityZone parameter if the
128
+ # MultiAZ parameter is set to +true+ .
129
+ # * +:engine_version+ - (String) The version number of the database
130
+ # engine to use. Example: 5.1.42
131
+ # * +:auto_minor_version_upgrade+ - (Boolean) Indicates that minor
132
+ # engine upgrades will be applied automatically to the DB Instance
133
+ # during the maintenance window. Default: +true+
134
+ # * +:license_model+ - (String) License model information for this DB
135
+ # Instance. Valid values: license-included | bring-your-own-license |
136
+ # general-public-license
137
+ # * +:option_group_name+ - (String) Indicates that the DB Instance
138
+ # should be associated with the specified option group.
139
+ # * +:character_set_name+ - (String) For supported engines, indicates
140
+ # that the DB Instance should be associated with the specified
141
+ # CharacterSet.
142
+ # @return [Core::Response]
143
+ # The #data method of the response object returns
144
+ # a hash with the following structure:
145
+ # * +:db_instance_identifier+ - (String)
146
+ # * +:db_instance_class+ - (String)
147
+ # * +:engine+ - (String)
148
+ # * +:db_instance_status+ - (String)
149
+ # * +:master_username+ - (String)
150
+ # * +:db_name+ - (String)
151
+ # * +:endpoint+ - (Hash)
152
+ # * +:address+ - (String)
153
+ # * +:port+ - (Integer)
154
+ # * +:allocated_storage+ - (Integer)
155
+ # * +:instance_create_time+ - (Time)
156
+ # * +:preferred_backup_window+ - (String)
157
+ # * +:backup_retention_period+ - (Integer)
158
+ # * +:db_security_groups+ - (Array<Hash>)
159
+ # * +:db_security_group_name+ - (String)
160
+ # * +:status+ - (String)
161
+ # * +:db_parameter_groups+ - (Array<Hash>)
162
+ # * +:db_parameter_group_name+ - (String)
163
+ # * +:parameter_apply_status+ - (String)
164
+ # * +:availability_zone+ - (String)
165
+ # * +:db_subnet_group+ - (Hash)
166
+ # * +:db_subnet_group_name+ - (String)
167
+ # * +:db_subnet_group_description+ - (String)
168
+ # * +:vpc_id+ - (String)
169
+ # * +:subnet_group_status+ - (String)
170
+ # * +:subnets+ - (Array<Hash>)
171
+ # * +:subnet_identifier+ - (String)
172
+ # * +:subnet_availability_zone+ - (Hash)
173
+ # * +:name+ - (String)
174
+ # * +:subnet_status+ - (String)
175
+ # * +:preferred_maintenance_window+ - (String)
176
+ # * +:pending_modified_values+ - (Hash)
177
+ # * +:db_instance_class+ - (String)
178
+ # * +:allocated_storage+ - (Integer)
179
+ # * +:master_user_password+ - (String)
180
+ # * +:port+ - (Integer)
181
+ # * +:backup_retention_period+ - (Integer)
182
+ # * +:multi_az+ - (Boolean)
183
+ # * +:engine_version+ - (String)
184
+ # * +:latest_restorable_time+ - (Time)
185
+ # * +:multi_az+ - (Boolean)
186
+ # * +:engine_version+ - (String)
187
+ # * +:auto_minor_version_upgrade+ - (Boolean)
188
+ # * +:read_replica_source_db_instance_identifier+ - (String)
189
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
190
+ # * +:license_model+ - (String)
191
+ # * +:option_group_membership+ - (Hash)
192
+ # * +:option_group_name+ - (String)
193
+ # * +:status+ - (String)
194
+ # * +:character_set_name+ - (String)
195
+
196
+ # @!method create_db_instance_read_replica(options = {})
197
+ # Calls the CreateDBInstanceReadReplica API operation.
198
+ # @param [Hash] options
199
+ # * +:db_instance_identifier+ - *required* - (String) The DB Instance
200
+ # identifier of the Read Replica. This is the unique key that
201
+ # identifies a DB Instance. This parameter is stored as a lowercase
202
+ # string.
203
+ # * +:source_db_instance_identifier+ - *required* - (String) The
204
+ # identifier of the DB Instance that will act as the source for the
205
+ # Read Replica. Each DB Instance can have up to five Read Replicas.
206
+ # Constraints: Must be the identifier of an existing DB Instance that
207
+ # is not already a Read Replica DB Instance.
208
+ # * +:db_instance_class+ - (String) The compute and memory capacity of
209
+ # the Read Replica. Valid Values: db.m1.small | db.m1.large |
210
+ # db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge Default:
211
+ # Inherits from the source DB Instance.
212
+ # * +:availability_zone+ - (String) The Amazon EC2 Availability Zone
213
+ # that the Read Replica will be created in. Default: A random,
214
+ # system-chosen Availability Zone in the endpoint's region. Example:
215
+ # us-east-1d
216
+ # * +:port+ - (Integer) The port number that the DB Instance uses for
217
+ # connections. Default: Inherits from the source DB Instance Valid
218
+ # Values: 1150-65535
219
+ # * +:auto_minor_version_upgrade+ - (Boolean) Indicates that minor
220
+ # engine upgrades will be applied automatically to the Read Replica
221
+ # during the maintenance window. Default: Inherits from the source DB
222
+ # Instance
223
+ # * +:option_group_name+ - (String)
224
+ # @return [Core::Response]
225
+ # The #data method of the response object returns
226
+ # a hash with the following structure:
227
+ # * +:db_instance_identifier+ - (String)
228
+ # * +:db_instance_class+ - (String)
229
+ # * +:engine+ - (String)
230
+ # * +:db_instance_status+ - (String)
231
+ # * +:master_username+ - (String)
232
+ # * +:db_name+ - (String)
233
+ # * +:endpoint+ - (Hash)
234
+ # * +:address+ - (String)
235
+ # * +:port+ - (Integer)
236
+ # * +:allocated_storage+ - (Integer)
237
+ # * +:instance_create_time+ - (Time)
238
+ # * +:preferred_backup_window+ - (String)
239
+ # * +:backup_retention_period+ - (Integer)
240
+ # * +:db_security_groups+ - (Array<Hash>)
241
+ # * +:db_security_group_name+ - (String)
242
+ # * +:status+ - (String)
243
+ # * +:db_parameter_groups+ - (Array<Hash>)
244
+ # * +:db_parameter_group_name+ - (String)
245
+ # * +:parameter_apply_status+ - (String)
246
+ # * +:availability_zone+ - (String)
247
+ # * +:db_subnet_group+ - (Hash)
248
+ # * +:db_subnet_group_name+ - (String)
249
+ # * +:db_subnet_group_description+ - (String)
250
+ # * +:vpc_id+ - (String)
251
+ # * +:subnet_group_status+ - (String)
252
+ # * +:subnets+ - (Array<Hash>)
253
+ # * +:subnet_identifier+ - (String)
254
+ # * +:subnet_availability_zone+ - (Hash)
255
+ # * +:name+ - (String)
256
+ # * +:subnet_status+ - (String)
257
+ # * +:preferred_maintenance_window+ - (String)
258
+ # * +:pending_modified_values+ - (Hash)
259
+ # * +:db_instance_class+ - (String)
260
+ # * +:allocated_storage+ - (Integer)
261
+ # * +:master_user_password+ - (String)
262
+ # * +:port+ - (Integer)
263
+ # * +:backup_retention_period+ - (Integer)
264
+ # * +:multi_az+ - (Boolean)
265
+ # * +:engine_version+ - (String)
266
+ # * +:latest_restorable_time+ - (Time)
267
+ # * +:multi_az+ - (Boolean)
268
+ # * +:engine_version+ - (String)
269
+ # * +:auto_minor_version_upgrade+ - (Boolean)
270
+ # * +:read_replica_source_db_instance_identifier+ - (String)
271
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
272
+ # * +:license_model+ - (String)
273
+ # * +:option_group_membership+ - (Hash)
274
+ # * +:option_group_name+ - (String)
275
+ # * +:status+ - (String)
276
+ # * +:character_set_name+ - (String)
277
+
278
+ # @!method create_db_parameter_group(options = {})
279
+ # Calls the CreateDBParameterGroup API operation.
280
+ # @param [Hash] options
281
+ # * +:db_parameter_group_name+ - *required* - (String) The name of the
282
+ # DB Parameter Group.
283
+ # * +:db_parameter_group_family+ - *required* - (String) The name of
284
+ # the DB Parameter Group Family the DB Parameter Group can be used
285
+ # with.
286
+ # * +:description+ - *required* - (String) The description for the DB
287
+ # Parameter Group.
288
+ # @return [Core::Response]
289
+ # The #data method of the response object returns
290
+ # a hash with the following structure:
291
+ # * +:db_parameter_group_name+ - (String)
292
+ # * +:db_parameter_group_family+ - (String)
293
+ # * +:description+ - (String)
294
+
295
+ # @!method create_db_security_group(options = {})
296
+ # Calls the CreateDBSecurityGroup API operation.
297
+ # @param [Hash] options
298
+ # * +:db_security_group_name+ - *required* - (String) The name for the
299
+ # DB Security Group. This value is stored as a lowercase string.
300
+ # * +:db_security_group_description+ - *required* - (String) The
301
+ # description for the DB Security Group.
302
+ # * +:ec2_vpc_id+ - (String) The Id of VPC. Indicates which VPC this DB
303
+ # Security Group should belong to. Must be specified to create a DB
304
+ # Security Group for a VPC; may not be specified otherwise.
305
+ # @return [Core::Response]
306
+ # The #data method of the response object returns
307
+ # a hash with the following structure:
308
+ # * +:owner_id+ - (String)
309
+ # * +:db_security_group_name+ - (String)
310
+ # * +:db_security_group_description+ - (String)
311
+ # * +:vpc_id+ - (String)
312
+ # * +:ec_2_security_groups+ - (Array<Hash>)
313
+ # * +:status+ - (String)
314
+ # * +:ec2_security_group_name+ - (String)
315
+ # * +:ec2_security_group_id+ - (String)
316
+ # * +:ec2_security_group_owner_id+ - (String)
317
+ # * +:ip_ranges+ - (Array<Hash>)
318
+ # * +:status+ - (String)
319
+ # * +:cidrip+ - (String)
320
+
321
+ # @!method create_db_snapshot(options = {})
322
+ # Calls the CreateDBSnapshot API operation.
323
+ # @param [Hash] options
324
+ # * +:db_snapshot_identifier+ - *required* - (String) The identifier
325
+ # for the DB Snapshot.
326
+ # * +:db_instance_identifier+ - *required* - (String) The DB Instance
327
+ # identifier. This is the unique key that identifies a DB Instance.
328
+ # This parameter isn't case sensitive.
329
+ # @return [Core::Response]
330
+ # The #data method of the response object returns
331
+ # a hash with the following structure:
332
+ # * +:db_snapshot_identifier+ - (String)
333
+ # * +:db_instance_identifier+ - (String)
334
+ # * +:snapshot_create_time+ - (Time)
335
+ # * +:engine+ - (String)
336
+ # * +:allocated_storage+ - (Integer)
337
+ # * +:status+ - (String)
338
+ # * +:port+ - (Integer)
339
+ # * +:availability_zone+ - (String)
340
+ # * +:vpc_id+ - (String)
341
+ # * +:instance_create_time+ - (Time)
342
+ # * +:master_username+ - (String)
343
+ # * +:engine_version+ - (String)
344
+ # * +:license_model+ - (String)
345
+ # * +:snapshot_type+ - (String)
346
+
347
+ # @!method create_db_subnet_group(options = {})
348
+ # Calls the CreateDBSubnetGroup API operation.
349
+ # @param [Hash] options
350
+ # * +:db_subnet_group_name+ - *required* - (String) The name for the DB
351
+ # Subnet Group. This value is stored as a lowercase string.
352
+ # Constraints: Must contain no more than 255 alphanumeric characters
353
+ # or hyphens. Must not be "Default". Example: mySubnetgroup
354
+ # * +:db_subnet_group_description+ - *required* - (String) The
355
+ # description for the DB Subnet Group.
356
+ # * +:subnet_ids+ - *required* - (Array<String>) The EC2 Subnet IDs for
357
+ # the DB Subnet Group.
358
+ # @return [Core::Response]
359
+ # The #data method of the response object returns
360
+ # a hash with the following structure:
361
+ # * +:db_subnet_group_name+ - (String)
362
+ # * +:db_subnet_group_description+ - (String)
363
+ # * +:vpc_id+ - (String)
364
+ # * +:subnet_group_status+ - (String)
365
+ # * +:subnets+ - (Array<Hash>)
366
+ # * +:subnet_identifier+ - (String)
367
+ # * +:subnet_availability_zone+ - (Hash)
368
+ # * +:name+ - (String)
369
+ # * +:subnet_status+ - (String)
370
+
371
+ # @!method create_option_group(options = {})
372
+ # Calls the CreateOptionGroup API operation.
373
+ # @param [Hash] options
374
+ # * +:option_group_name+ - *required* - (String) Specifies the name of
375
+ # the option group to be created. Constraints: Must be 1 to 255
376
+ # alphanumeric characters or hyphens First character must be a letter
377
+ # Cannot end with a hyphen or contain two consecutive hyphens
378
+ # Example: myOptiongroup
379
+ # * +:engine_name+ - *required* - (String) Specifies the name of the
380
+ # engine that this option group should be associated with.
381
+ # * +:major_engine_version+ - *required* - (String) Specifies the major
382
+ # version of the engine that this option group should be associated
383
+ # with.
384
+ # * +:option_group_description+ - *required* - (String) The description
385
+ # of the option group.
386
+ # @return [Core::Response]
387
+ # The #data method of the response object returns
388
+ # a hash with the following structure:
389
+ # * +:option_group_name+ - (String)
390
+ # * +:option_group_description+ - (String)
391
+ # * +:engine_name+ - (String)
392
+ # * +:major_engine_version+ - (String)
393
+ # * +:options+ - (Array<Hash>)
394
+ # * +:option_name+ - (String)
395
+ # * +:option_description+ - (String)
396
+ # * +:port+ - (Integer)
397
+ # * +:db_security_group_memberships+ - (Array<Hash>)
398
+ # * +:db_security_group_name+ - (String)
399
+ # * +:status+ - (String)
400
+
401
+ # @!method delete_db_instance(options = {})
402
+ # Calls the DeleteDBInstance API operation.
403
+ # @param [Hash] options
404
+ # * +:db_instance_identifier+ - *required* - (String) The DB Instance
405
+ # identifier for the DB Instance to be deleted. This parameter isn't
406
+ # case sensitive.
407
+ # * +:skip_final_snapshot+ - (Boolean)
408
+ # * +:final_db_snapshot_identifier+ - (String) Determines whether a
409
+ # final DB Snapshot is created before the DB Instance is deleted. If
410
+ # +true+ , no DBSnapshot is created. If +false+ , a DB Snapshot is
411
+ # created before the DB Instance is deleted.
412
+ # @return [Core::Response]
413
+ # The #data method of the response object returns
414
+ # a hash with the following structure:
415
+ # * +:db_instance_identifier+ - (String)
416
+ # * +:db_instance_class+ - (String)
417
+ # * +:engine+ - (String)
418
+ # * +:db_instance_status+ - (String)
419
+ # * +:master_username+ - (String)
420
+ # * +:db_name+ - (String)
421
+ # * +:endpoint+ - (Hash)
422
+ # * +:address+ - (String)
423
+ # * +:port+ - (Integer)
424
+ # * +:allocated_storage+ - (Integer)
425
+ # * +:instance_create_time+ - (Time)
426
+ # * +:preferred_backup_window+ - (String)
427
+ # * +:backup_retention_period+ - (Integer)
428
+ # * +:db_security_groups+ - (Array<Hash>)
429
+ # * +:db_security_group_name+ - (String)
430
+ # * +:status+ - (String)
431
+ # * +:db_parameter_groups+ - (Array<Hash>)
432
+ # * +:db_parameter_group_name+ - (String)
433
+ # * +:parameter_apply_status+ - (String)
434
+ # * +:availability_zone+ - (String)
435
+ # * +:db_subnet_group+ - (Hash)
436
+ # * +:db_subnet_group_name+ - (String)
437
+ # * +:db_subnet_group_description+ - (String)
438
+ # * +:vpc_id+ - (String)
439
+ # * +:subnet_group_status+ - (String)
440
+ # * +:subnets+ - (Array<Hash>)
441
+ # * +:subnet_identifier+ - (String)
442
+ # * +:subnet_availability_zone+ - (Hash)
443
+ # * +:name+ - (String)
444
+ # * +:subnet_status+ - (String)
445
+ # * +:preferred_maintenance_window+ - (String)
446
+ # * +:pending_modified_values+ - (Hash)
447
+ # * +:db_instance_class+ - (String)
448
+ # * +:allocated_storage+ - (Integer)
449
+ # * +:master_user_password+ - (String)
450
+ # * +:port+ - (Integer)
451
+ # * +:backup_retention_period+ - (Integer)
452
+ # * +:multi_az+ - (Boolean)
453
+ # * +:engine_version+ - (String)
454
+ # * +:latest_restorable_time+ - (Time)
455
+ # * +:multi_az+ - (Boolean)
456
+ # * +:engine_version+ - (String)
457
+ # * +:auto_minor_version_upgrade+ - (Boolean)
458
+ # * +:read_replica_source_db_instance_identifier+ - (String)
459
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
460
+ # * +:license_model+ - (String)
461
+ # * +:option_group_membership+ - (Hash)
462
+ # * +:option_group_name+ - (String)
463
+ # * +:status+ - (String)
464
+ # * +:character_set_name+ - (String)
465
+
466
+ # @!method delete_db_parameter_group(options = {})
467
+ # Calls the DeleteDBParameterGroup API operation.
468
+ # @param [Hash] options
469
+ # * +:db_parameter_group_name+ - *required* - (String) The name of the
470
+ # DB Parameter Group. The specified database security group must not
471
+ # be associated with any DB instances.
472
+ # @return [Core::Response]
473
+
474
+ # @!method delete_db_security_group(options = {})
475
+ # Calls the DeleteDBSecurityGroup API operation.
476
+ # @param [Hash] options
477
+ # * +:db_security_group_name+ - *required* - (String) The name of the
478
+ # database security group to delete.
479
+ # @return [Core::Response]
480
+
481
+ # @!method delete_db_snapshot(options = {})
482
+ # Calls the DeleteDBSnapshot API operation.
483
+ # @param [Hash] options
484
+ # * +:db_snapshot_identifier+ - *required* - (String) The DBSnapshot
485
+ # identifier.
486
+ # @return [Core::Response]
487
+ # The #data method of the response object returns
488
+ # a hash with the following structure:
489
+ # * +:db_snapshot_identifier+ - (String)
490
+ # * +:db_instance_identifier+ - (String)
491
+ # * +:snapshot_create_time+ - (Time)
492
+ # * +:engine+ - (String)
493
+ # * +:allocated_storage+ - (Integer)
494
+ # * +:status+ - (String)
495
+ # * +:port+ - (Integer)
496
+ # * +:availability_zone+ - (String)
497
+ # * +:vpc_id+ - (String)
498
+ # * +:instance_create_time+ - (Time)
499
+ # * +:master_username+ - (String)
500
+ # * +:engine_version+ - (String)
501
+ # * +:license_model+ - (String)
502
+ # * +:snapshot_type+ - (String)
503
+
504
+ # @!method delete_db_subnet_group(options = {})
505
+ # Calls the DeleteDBSubnetGroup API operation.
506
+ # @param [Hash] options
507
+ # * +:db_subnet_group_name+ - *required* - (String) The name of the
508
+ # database subnet group to delete. You cannot delete the default
509
+ # subnet group. Constraints: Must be 1 to 255 alphanumeric characters
510
+ # First character must be a letter Cannot end with a hyphen or
511
+ # contain two consecutive hyphens
512
+ # @return [Core::Response]
513
+
514
+ # @!method delete_option_group(options = {})
515
+ # Calls the DeleteOptionGroup API operation.
516
+ # @param [Hash] options
517
+ # * +:option_group_name+ - *required* - (String) The name of the option
518
+ # group to be deleted. You cannot delete default Option Groups.
519
+ # @return [Core::Response]
520
+
521
+ # @!method describe_db_engine_versions(options = {})
522
+ # Calls the DescribeDBEngineVersions API operation.
523
+ # @param [Hash] options
524
+ # * +:engine+ - (String) The database engine to return.
525
+ # * +:engine_version+ - (String) The database engine version to return.
526
+ # * +:db_parameter_group_family+ - (String) The name of a specific
527
+ # database parameter group family to return details for. Constraints:
528
+ # Must be 1 to 255 alphanumeric characters First character must be a
529
+ # letter Cannot end with a hyphen or contain two consecutive hyphens
530
+ # * +:max_records+ - (Integer) The maximum number of records to include
531
+ # in the response. If more than the MaxRecords value is available, a
532
+ # marker is included in the response so that the following results
533
+ # can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
534
+ # * +:marker+ - (String) The marker provided in the previous request.
535
+ # If this parameter is specified, the response includes records
536
+ # beyond the marker only, up to MaxRecords.
537
+ # * +:default_only+ - (Boolean) Indicates that only the default version
538
+ # of the specified engine or engine and major version combination is
539
+ # returned.
540
+ # * +:list_supported_character_sets+ - (Boolean) If this parameter is
541
+ # specified, and if the requested engine supports the
542
+ # CharacterSetName parameter for CreateDBInstance, the response
543
+ # includes a list of supported character sets for each engine
544
+ # version.
545
+ # @return [Core::Response]
546
+ # The #data method of the response object returns
547
+ # a hash with the following structure:
548
+ # * +:marker+ - (String)
549
+ # * +:db_engine_versions+ - (Array<Hash>)
550
+ # * +:engine+ - (String)
551
+ # * +:engine_version+ - (String)
552
+ # * +:db_parameter_group_family+ - (String)
553
+ # * +:db_engine_description+ - (String)
554
+ # * +:db_engine_version_description+ - (String)
555
+ # * +:supported_character_sets+ - (Array<Hash>)
556
+ # * +:character_set_name+ - (String)
557
+ # * +:character_set_description+ - (String)
558
+
559
+ # @!method describe_db_instances(options = {})
560
+ # Calls the DescribeDBInstances API operation.
561
+ # @param [Hash] options
562
+ # * +:db_instance_identifier+ - (String) The user-supplied instance
563
+ # identifier. If this parameter is specified, information from only
564
+ # the specific DB Instance is returned. This parameter isn't case
565
+ # sensitive.
566
+ # * +:max_records+ - (Integer) The maximum number of records to include
567
+ # in the response. If more records exist than the specified
568
+ # MaxRecords value, a marker is included in the response so that the
569
+ # remaining results may be retrieved.
570
+ # * +:marker+ - (String) An optional marker provided in the previous
571
+ # DescribeDBInstances request. If this parameter is specified, the
572
+ # response includes only records beyond the marker, up to the value
573
+ # specified by MaxRecords.
574
+ # @return [Core::Response]
575
+ # The #data method of the response object returns
576
+ # a hash with the following structure:
577
+ # * +:marker+ - (String)
578
+ # * +:db_instances+ - (Array<Hash>)
579
+ # * +:db_instance_identifier+ - (String)
580
+ # * +:db_instance_class+ - (String)
581
+ # * +:engine+ - (String)
582
+ # * +:db_instance_status+ - (String)
583
+ # * +:master_username+ - (String)
584
+ # * +:db_name+ - (String)
585
+ # * +:endpoint+ - (Hash)
586
+ # * +:address+ - (String)
587
+ # * +:port+ - (Integer)
588
+ # * +:allocated_storage+ - (Integer)
589
+ # * +:instance_create_time+ - (Time)
590
+ # * +:preferred_backup_window+ - (String)
591
+ # * +:backup_retention_period+ - (Integer)
592
+ # * +:db_security_groups+ - (Array<Hash>)
593
+ # * +:db_security_group_name+ - (String)
594
+ # * +:status+ - (String)
595
+ # * +:db_parameter_groups+ - (Array<Hash>)
596
+ # * +:db_parameter_group_name+ - (String)
597
+ # * +:parameter_apply_status+ - (String)
598
+ # * +:availability_zone+ - (String)
599
+ # * +:db_subnet_group+ - (Hash)
600
+ # * +:db_subnet_group_name+ - (String)
601
+ # * +:db_subnet_group_description+ - (String)
602
+ # * +:vpc_id+ - (String)
603
+ # * +:subnet_group_status+ - (String)
604
+ # * +:subnets+ - (Array<Hash>)
605
+ # * +:subnet_identifier+ - (String)
606
+ # * +:subnet_availability_zone+ - (Hash)
607
+ # * +:name+ - (String)
608
+ # * +:subnet_status+ - (String)
609
+ # * +:preferred_maintenance_window+ - (String)
610
+ # * +:pending_modified_values+ - (Hash)
611
+ # * +:db_instance_class+ - (String)
612
+ # * +:allocated_storage+ - (Integer)
613
+ # * +:master_user_password+ - (String)
614
+ # * +:port+ - (Integer)
615
+ # * +:backup_retention_period+ - (Integer)
616
+ # * +:multi_az+ - (Boolean)
617
+ # * +:engine_version+ - (String)
618
+ # * +:latest_restorable_time+ - (Time)
619
+ # * +:multi_az+ - (Boolean)
620
+ # * +:engine_version+ - (String)
621
+ # * +:auto_minor_version_upgrade+ - (Boolean)
622
+ # * +:read_replica_source_db_instance_identifier+ - (String)
623
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
624
+ # * +:license_model+ - (String)
625
+ # * +:option_group_membership+ - (Hash)
626
+ # * +:option_group_name+ - (String)
627
+ # * +:status+ - (String)
628
+ # * +:character_set_name+ - (String)
629
+
630
+ # @!method describe_db_parameter_groups(options = {})
631
+ # Calls the DescribeDBParameterGroups API operation.
632
+ # @param [Hash] options
633
+ # * +:db_parameter_group_name+ - (String) The name of a specific
634
+ # database parameter group to return details for.
635
+ # * +:max_records+ - (Integer) The maximum number of records to include
636
+ # in the response. If more records exist than the specified
637
+ # MaxRecords value, a marker is included in the response so that the
638
+ # remaining results may be retrieved.
639
+ # * +:marker+ - (String) An optional marker provided in the previous
640
+ # DescribeDBInstances request. If this parameter is specified, the
641
+ # response includes only records beyond the marker, up to the value
642
+ # specified by MaxRecords.
643
+ # @return [Core::Response]
644
+ # The #data method of the response object returns
645
+ # a hash with the following structure:
646
+ # * +:marker+ - (String)
647
+ # * +:db_parameter_groups+ - (Array<Hash>)
648
+ # * +:db_parameter_group_name+ - (String)
649
+ # * +:db_parameter_group_family+ - (String)
650
+ # * +:description+ - (String)
651
+
652
+ # @!method describe_db_parameters(options = {})
653
+ # Calls the DescribeDBParameters API operation.
654
+ # @param [Hash] options
655
+ # * +:db_parameter_group_name+ - *required* - (String) The name of a
656
+ # specific database parameter group to return details for.
657
+ # * +:source+ - (String) The parameter types to return.
658
+ # * +:max_records+ - (Integer) The maximum number of records to include
659
+ # in the response. If more records exist than the specified
660
+ # MaxRecords value, a marker is included in the response so that the
661
+ # remaining results may be retrieved.
662
+ # * +:marker+ - (String) An optional marker provided in the previous
663
+ # DescribeDBInstances request. If this parameter is specified, the
664
+ # response includes only records beyond the marker, up to the value
665
+ # specified by MaxRecords.
666
+ # @return [Core::Response]
667
+ # The #data method of the response object returns
668
+ # a hash with the following structure:
669
+ # * +:parameters+ - (Array<Hash>)
670
+ # * +:parameter_name+ - (String)
671
+ # * +:parameter_value+ - (String)
672
+ # * +:description+ - (String)
673
+ # * +:source+ - (String)
674
+ # * +:apply_type+ - (String)
675
+ # * +:data_type+ - (String)
676
+ # * +:allowed_values+ - (String)
677
+ # * +:is_modifiable+ - (Boolean)
678
+ # * +:minimum_engine_version+ - (String)
679
+ # * +:apply_method+ - (String)
680
+ # * +:marker+ - (String)
681
+
682
+ # @!method describe_db_security_groups(options = {})
683
+ # Calls the DescribeDBSecurityGroups API operation.
684
+ # @param [Hash] options
685
+ # * +:db_security_group_name+ - (String) The name of the DB Security
686
+ # Group to return details for.
687
+ # * +:max_records+ - (Integer) The maximum number of records to include
688
+ # in the response. If more records exist than the specified
689
+ # MaxRecords value, a marker is included in the response so that the
690
+ # remaining results may be retrieved.
691
+ # * +:marker+ - (String) An optional marker provided in the previous
692
+ # DescribeDBInstances request. If this parameter is specified, the
693
+ # response includes only records beyond the marker, up to the value
694
+ # specified by MaxRecords.
695
+ # @return [Core::Response]
696
+ # The #data method of the response object returns
697
+ # a hash with the following structure:
698
+ # * +:marker+ - (String)
699
+ # * +:db_security_groups+ - (Array<Hash>)
700
+ # * +:owner_id+ - (String)
701
+ # * +:db_security_group_name+ - (String)
702
+ # * +:db_security_group_description+ - (String)
703
+ # * +:vpc_id+ - (String)
704
+ # * +:ec_2_security_groups+ - (Array<Hash>)
705
+ # * +:status+ - (String)
706
+ # * +:ec2_security_group_name+ - (String)
707
+ # * +:ec2_security_group_id+ - (String)
708
+ # * +:ec2_security_group_owner_id+ - (String)
709
+ # * +:ip_ranges+ - (Array<Hash>)
710
+ # * +:status+ - (String)
711
+ # * +:cidrip+ - (String)
712
+
713
+ # @!method describe_db_snapshots(options = {})
714
+ # Calls the DescribeDBSnapshots API operation.
715
+ # @param [Hash] options
716
+ # * +:db_instance_identifier+ - (String) The unique identifier for the
717
+ # Amazon RDS DB snapshot. This value is stored as a lowercase string.
718
+ # * +:db_snapshot_identifier+ - (String) The DB Instance identifier.
719
+ # This parameter isn't case sensitive.
720
+ # * +:snapshot_type+ - (String) An optional snapshot type for which
721
+ # snapshots will be returned. If not specified, the returned results
722
+ # will include snapshots of all types.
723
+ # * +:max_records+ - (Integer) The maximum number of records to include
724
+ # in the response. If more records exist than the specified
725
+ # MaxRecords value, a marker is included in the response so that the
726
+ # remaining results may be retrieved.
727
+ # * +:marker+ - (String) An optional marker provided in the previous
728
+ # DescribeDBInstances request. If this parameter is specified, the
729
+ # response includes only records beyond the marker, up to the value
730
+ # specified by MaxRecords.
731
+ # @return [Core::Response]
732
+ # The #data method of the response object returns
733
+ # a hash with the following structure:
734
+ # * +:marker+ - (String)
735
+ # * +:db_snapshots+ - (Array<Hash>)
736
+ # * +:db_snapshot_identifier+ - (String)
737
+ # * +:db_instance_identifier+ - (String)
738
+ # * +:snapshot_create_time+ - (Time)
739
+ # * +:engine+ - (String)
740
+ # * +:allocated_storage+ - (Integer)
741
+ # * +:status+ - (String)
742
+ # * +:port+ - (Integer)
743
+ # * +:availability_zone+ - (String)
744
+ # * +:vpc_id+ - (String)
745
+ # * +:instance_create_time+ - (Time)
746
+ # * +:master_username+ - (String)
747
+ # * +:engine_version+ - (String)
748
+ # * +:license_model+ - (String)
749
+ # * +:snapshot_type+ - (String)
750
+
751
+ # @!method describe_db_subnet_groups(options = {})
752
+ # Calls the DescribeDBSubnetGroups API operation.
753
+ # @param [Hash] options
754
+ # * +:db_subnet_group_name+ - (String) The name of the DB Subnet Group
755
+ # to return details for.
756
+ # * +:max_records+ - (Integer) The maximum number of records to include
757
+ # in the response. If more records exist than the specified
758
+ # MaxRecords value, a marker is included in the response so that the
759
+ # remaining results may be retrieved. Default: 100 Constraints:
760
+ # minimum 20, maximum 100
761
+ # * +:marker+ - (String) An optional marker provided in the previous
762
+ # DescribeDBSubnetGroups request. If this parameter is specified, the
763
+ # response includes only records beyond the marker, up to the value
764
+ # specified by MaxRecords.
765
+ # @return [Core::Response]
766
+ # The #data method of the response object returns
767
+ # a hash with the following structure:
768
+ # * +:marker+ - (String)
769
+ # * +:db_subnet_groups+ - (Array<Hash>)
770
+ # * +:db_subnet_group_name+ - (String)
771
+ # * +:db_subnet_group_description+ - (String)
772
+ # * +:vpc_id+ - (String)
773
+ # * +:subnet_group_status+ - (String)
774
+ # * +:subnets+ - (Array<Hash>)
775
+ # * +:subnet_identifier+ - (String)
776
+ # * +:subnet_availability_zone+ - (Hash)
777
+ # * +:name+ - (String)
778
+ # * +:subnet_status+ - (String)
779
+
780
+ # @!method describe_engine_default_parameters(options = {})
781
+ # Calls the DescribeEngineDefaultParameters API operation.
782
+ # @param [Hash] options
783
+ # * +:db_parameter_group_family+ - *required* - (String) The name of
784
+ # the DB Parameter Group Family.
785
+ # * +:max_records+ - (Integer) The maximum number of records to include
786
+ # in the response. If more records exist than the specified
787
+ # MaxRecords value, a marker is included in the response so that the
788
+ # remaining results may be retrieved.
789
+ # * +:marker+ - (String) An optional marker provided in the previous
790
+ # DescribeDBInstances request. If this parameter is specified, the
791
+ # response includes only records beyond the marker, up to the value
792
+ # specified by MaxRecords.
793
+ # @return [Core::Response]
794
+ # The #data method of the response object returns
795
+ # a hash with the following structure:
796
+ # * +:db_parameter_group_family+ - (String)
797
+ # * +:marker+ - (String)
798
+ # * +:parameters+ - (Array<Hash>)
799
+ # * +:parameter_name+ - (String)
800
+ # * +:parameter_value+ - (String)
801
+ # * +:description+ - (String)
802
+ # * +:source+ - (String)
803
+ # * +:apply_type+ - (String)
804
+ # * +:data_type+ - (String)
805
+ # * +:allowed_values+ - (String)
806
+ # * +:is_modifiable+ - (Boolean)
807
+ # * +:minimum_engine_version+ - (String)
808
+ # * +:apply_method+ - (String)
809
+
810
+ # @!method describe_events(options = {})
811
+ # Calls the DescribeEvents API operation.
812
+ # @param [Hash] options
813
+ # * +:source_identifier+ - (String) The identifier of the event source
814
+ # for which events will be returned. If not specified, then all
815
+ # sources are included in the response.
816
+ # * +:source_type+ - (String) The event source to retrieve events for.
817
+ # If no value is specified, all events are returned.
818
+ # * +:start_time+ - (String<ISO8601 datetime>) The beginning of the
819
+ # time interval to retrieve events for, specified in ISO 8601 format.
820
+ # * +:end_time+ - (String<ISO8601 datetime>) The end of the time
821
+ # interval for which to retrieve events, specified in ISO 8601
822
+ # format.
823
+ # * +:duration+ - (Integer) The number of minutes to retrieve events
824
+ # for.
825
+ # * +:max_records+ - (Integer) The maximum number of records to include
826
+ # in the response. If more records exist than the specified
827
+ # MaxRecords value, a marker is included in the response so that the
828
+ # remaining results may be retrieved.
829
+ # * +:marker+ - (String) An optional marker provided in the previous
830
+ # DescribeDBInstances request. If this parameter is specified, the
831
+ # response includes only records beyond the marker, up to the value
832
+ # specified by MaxRecords.
833
+ # @return [Core::Response]
834
+ # The #data method of the response object returns
835
+ # a hash with the following structure:
836
+ # * +:marker+ - (String)
837
+ # * +:events+ - (Array<Hash>)
838
+ # * +:source_identifier+ - (String)
839
+ # * +:source_type+ - (String)
840
+ # * +:message+ - (String)
841
+ # * +:date+ - (Time)
842
+
843
+ # @!method describe_option_group_options(options = {})
844
+ # Calls the DescribeOptionGroupOptions API operation.
845
+ # @param [Hash] options
846
+ # * +:engine_name+ - *required* - (String) A required parameter.
847
+ # Options available for the given Engine name will be described.
848
+ # * +:major_engine_version+ - (String) If specified, filters the
849
+ # results to include only options for the specified major engine
850
+ # version.
851
+ # * +:max_records+ - (Integer)
852
+ # * +:marker+ - (String)
853
+ # @return [Core::Response]
854
+ # The #data method of the response object returns
855
+ # a hash with the following structure:
856
+ # * +:option_group_options+ - (Array<Hash>)
857
+ # * +:name+ - (String)
858
+ # * +:description+ - (String)
859
+ # * +:engine_name+ - (String)
860
+ # * +:major_engine_version+ - (String)
861
+ # * +:minimum_required_minor_engine_version+ - (String)
862
+ # * +:port_required+ - (Boolean)
863
+ # * +:default_port+ - (Integer)
864
+ # * +:options_depended_on+ - (Array<String>)
865
+ # * +:marker+ - (String)
866
+
867
+ # @!method describe_option_groups(options = {})
868
+ # Calls the DescribeOptionGroups API operation.
869
+ # @param [Hash] options
870
+ # * +:option_group_name+ - (String) The name of the option group to
871
+ # describe. Cannot be supplied together with EngineName or
872
+ # MajorEngineVersion.
873
+ # * +:marker+ - (String)
874
+ # * +:max_records+ - (Integer)
875
+ # * +:engine_name+ - (String) Filters the list of option groups to only
876
+ # include groups associated with a specific database engine.
877
+ # * +:major_engine_version+ - (String) Filters the list of option
878
+ # groups to only include groups associated with a specific database
879
+ # engine version. If specified, then EngineName must also be
880
+ # specified.
881
+ # @return [Core::Response]
882
+ # The #data method of the response object returns
883
+ # a hash with the following structure:
884
+ # * +:option_groups_list+ - (Array<Hash>)
885
+ # * +:option_group_name+ - (String)
886
+ # * +:option_group_description+ - (String)
887
+ # * +:engine_name+ - (String)
888
+ # * +:major_engine_version+ - (String)
889
+ # * +:options+ - (Array<Hash>)
890
+ # * +:option_name+ - (String)
891
+ # * +:option_description+ - (String)
892
+ # * +:port+ - (Integer)
893
+ # * +:db_security_group_memberships+ - (Array<Hash>)
894
+ # * +:db_security_group_name+ - (String)
895
+ # * +:status+ - (String)
896
+ # * +:marker+ - (String)
897
+
898
+ # @!method describe_orderable_db_instance_options(options = {})
899
+ # Calls the DescribeOrderableDBInstanceOptions API operation.
900
+ # @param [Hash] options
901
+ # * +:engine+ - *required* - (String) The name of the engine to
902
+ # retrieve DB Instance options for.
903
+ # * +:engine_version+ - (String) The engine version filter value.
904
+ # Specify this parameter to show only the available offerings
905
+ # matching the specified engine version.
906
+ # * +:db_instance_class+ - (String) The DB Instance class filter value.
907
+ # Specify this parameter to show only the available offerings
908
+ # matching the specified DB Instance class.
909
+ # * +:license_model+ - (String) The license model filter value. Specify
910
+ # this parameter to show only the available offerings matching the
911
+ # specified license model.
912
+ # * +:max_records+ - (Integer) The maximum number of records to include
913
+ # in the response. If more records exist than the specified
914
+ # MaxRecords value, a marker is included in the response so that the
915
+ # remaining results may be retrieved. Default: 100 Constraints:
916
+ # minimum 20, maximum 100
917
+ # * +:marker+ - (String) An optional marker provided in the previous
918
+ # DescribeOrderableDBInstanceOptions request. If this parameter is
919
+ # specified, the response includes only records beyond the marker, up
920
+ # to the value specified by MaxRecords .
921
+ # @return [Core::Response]
922
+ # The #data method of the response object returns
923
+ # a hash with the following structure:
924
+ # * +:orderable_db_instance_options+ - (Array<Hash>)
925
+ # * +:engine+ - (String)
926
+ # * +:engine_version+ - (String)
927
+ # * +:db_instance_class+ - (String)
928
+ # * +:license_model+ - (String)
929
+ # * +:availability_zones+ - (Array<Hash>)
930
+ # * +:name+ - (String)
931
+ # * +:multi_az_capable+ - (Boolean)
932
+ # * +:read_replica_capable+ - (Boolean)
933
+ # * +:vpc_capable+ - (Boolean)
934
+ # * +:vpc_multi_az_capable+ - (Boolean)
935
+ # * +:vpc_read_replica_capable+ - (Boolean)
936
+ # * +:marker+ - (String)
937
+
938
+ # @!method describe_reserved_db_instances(options = {})
939
+ # Calls the DescribeReservedDBInstances API operation.
940
+ # @param [Hash] options
941
+ # * +:reserved_db_instance_id+ - (String) The reserved DB Instance
942
+ # identifier filter value. Specify this parameter to show only the
943
+ # reservation that matches the specified reservation ID.
944
+ # * +:reserved_db_instances_offering_id+ - (String) The offering
945
+ # identifier filter value. Specify this parameter to show only
946
+ # purchased reservations matching the specified offering identifier.
947
+ # * +:db_instance_class+ - (String) The DB Instance class filter value.
948
+ # Specify this parameter to show only those reservations matching the
949
+ # specified DB Instances class.
950
+ # * +:duration+ - (String) The duration filter value, specified in
951
+ # years or seconds. Specify this parameter to show only reservations
952
+ # for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
953
+ # * +:product_description+ - (String) The product description filter
954
+ # value. Specify this parameter to show only those reservations
955
+ # matching the specified product description.
956
+ # * +:offering_type+ - (String) The offering type filter value. Specify
957
+ # this parameter to show only the available offerings matching the
958
+ # specified offering type. Valid Values: "Light Utilization" |
959
+ # "Medium Utilization" | "Heavy Utilization"
960
+ # * +:multi_az+ - (Boolean) The Multi-AZ filter value. Specify this
961
+ # parameter to show only those reservations matching the specified
962
+ # Multi-AZ parameter.
963
+ # * +:max_records+ - (Integer) The maximum number of records to include
964
+ # in the response. If more than the MaxRecords value is available, a
965
+ # marker is included in the response so that the following results
966
+ # can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
967
+ # * +:marker+ - (String) The marker provided in the previous request.
968
+ # If this parameter is specified, the response includes records
969
+ # beyond the marker only, up to MaxRecords.
970
+ # @return [Core::Response]
971
+ # The #data method of the response object returns
972
+ # a hash with the following structure:
973
+ # * +:marker+ - (String)
974
+ # * +:reserved_db_instances+ - (Array<Hash>)
975
+ # * +:reserved_db_instance_id+ - (String)
976
+ # * +:reserved_db_instances_offering_id+ - (String)
977
+ # * +:db_instance_class+ - (String)
978
+ # * +:start_time+ - (Time)
979
+ # * +:duration+ - (Integer)
980
+ # * +:fixed_price+ - (Numeric)
981
+ # * +:usage_price+ - (Numeric)
982
+ # * +:currency_code+ - (String)
983
+ # * +:db_instance_count+ - (Integer)
984
+ # * +:product_description+ - (String)
985
+ # * +:offering_type+ - (String)
986
+ # * +:multi_az+ - (Boolean)
987
+ # * +:state+ - (String)
988
+ # * +:recurring_charges+ - (Array<Hash>)
989
+ # * +:recurring_charge_amount+ - (Numeric)
990
+ # * +:recurring_charge_frequency+ - (String)
991
+
992
+ # @!method describe_reserved_db_instances_offerings(options = {})
993
+ # Calls the DescribeReservedDBInstancesOfferings API operation.
994
+ # @param [Hash] options
995
+ # * +:reserved_db_instances_offering_id+ - (String) The offering
996
+ # identifier filter value. Specify this parameter to show only the
997
+ # available offering that matches the specified reservation
998
+ # identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
999
+ # * +:db_instance_class+ - (String) The DB Instance class filter value.
1000
+ # Specify this parameter to show only the available offerings
1001
+ # matching the specified DB Instance class.
1002
+ # * +:duration+ - (String) Duration filter value, specified in years or
1003
+ # seconds. Specify this parameter to show only reservations for this
1004
+ # duration. Valid Values: 1 | 3 | 31536000 | 94608000
1005
+ # * +:product_description+ - (String) Product description filter value.
1006
+ # Specify this parameter to show only the available offerings
1007
+ # matching the specified product description.
1008
+ # * +:offering_type+ - (String) The offering type filter value. Specify
1009
+ # this parameter to show only the available offerings matching the
1010
+ # specified offering type. Valid Values: "Light Utilization" |
1011
+ # "Medium Utilization" | "Heavy Utilization"
1012
+ # * +:multi_az+ - (Boolean) The Multi-AZ filter value. Specify this
1013
+ # parameter to show only the available offerings matching the
1014
+ # specified Multi-AZ parameter.
1015
+ # * +:max_records+ - (Integer) The maximum number of records to include
1016
+ # in the response. If more than the MaxRecords value is available, a
1017
+ # marker is included in the response so that the following results
1018
+ # can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
1019
+ # * +:marker+ - (String) The marker provided in the previous request.
1020
+ # If this parameter is specified, the response includes records
1021
+ # beyond the marker only, up to MaxRecords.
1022
+ # @return [Core::Response]
1023
+ # The #data method of the response object returns
1024
+ # a hash with the following structure:
1025
+ # * +:marker+ - (String)
1026
+ # * +:reserved_db_instances_offerings+ - (Array<Hash>)
1027
+ # * +:reserved_db_instances_offering_id+ - (String)
1028
+ # * +:db_instance_class+ - (String)
1029
+ # * +:duration+ - (Integer)
1030
+ # * +:fixed_price+ - (Numeric)
1031
+ # * +:usage_price+ - (Numeric)
1032
+ # * +:currency_code+ - (String)
1033
+ # * +:product_description+ - (String)
1034
+ # * +:offering_type+ - (String)
1035
+ # * +:multi_az+ - (Boolean)
1036
+ # * +:recurring_charges+ - (Array<Hash>)
1037
+ # * +:recurring_charge_amount+ - (Numeric)
1038
+ # * +:recurring_charge_frequency+ - (String)
1039
+
1040
+ # @!method modify_db_instance(options = {})
1041
+ # Calls the ModifyDBInstance API operation.
1042
+ # @param [Hash] options
1043
+ # * +:db_instance_identifier+ - *required* - (String) The DB Instance
1044
+ # identifier. This value is stored as a lowercase string.
1045
+ # * +:allocated_storage+ - (Integer) The new storage capacity of the
1046
+ # RDS instance. This change does not result in an outage and is
1047
+ # applied during the next maintenance window unless the
1048
+ # ApplyImmediately parameter is specified as +true+ for this request.
1049
+ # * +:db_instance_class+ - (String) The new compute and memory capacity
1050
+ # of the DB Instance. Passing a value for this parameter causes an
1051
+ # outage during the change and is applied during the next maintenance
1052
+ # window, unless the ApplyImmediately parameter is specified as
1053
+ # +true+ for this request.
1054
+ # * +:db_security_groups+ - (Array<String>) A list of DB Security
1055
+ # Groups to authorize on this DB Instance. This change is
1056
+ # asynchronously applied as soon as possible.
1057
+ # * +:apply_immediately+ - (Boolean) Specifies whether or not the
1058
+ # modifications in this request and any pending modifications are
1059
+ # asynchronously applied as soon as possible, regardless of the
1060
+ # PreferredMaintenanceWindow setting for the DB Instance. If this
1061
+ # parameter is passed as +false+ , changes to the DB Instance are
1062
+ # applied on the next call to RebootDBInstance, the next maintenance
1063
+ # reboot, or the next failure reboot, whichever occurs first.
1064
+ # * +:master_user_password+ - (String) The new password for the DB
1065
+ # Instance master user. This change is asynchronously applied as soon
1066
+ # as possible. Between the time of the request and the completion of
1067
+ # the request, the MasterUserPassword element exists in the
1068
+ # PendingModifiedValues element of the operation response.
1069
+ # * +:db_parameter_group_name+ - (String) The name of the DB Parameter
1070
+ # Group to apply to this DB Instance. This change is asynchronously
1071
+ # applied as soon as possible for parameters when the
1072
+ # ApplyImmediately parameter is specified as +true+ for this request.
1073
+ # * +:backup_retention_period+ - (Integer) The number of days to retain
1074
+ # automated backups. Setting this parameter to a positive number
1075
+ # enables backups. Setting this parameter to 0 disables automated
1076
+ # backups.
1077
+ # * +:preferred_backup_window+ - (String) The daily time range during
1078
+ # which automated backups are created if automated backups are
1079
+ # enabled, as determined by the BackupRetentionPeriod.
1080
+ # * +:preferred_maintenance_window+ - (String) The weekly time range
1081
+ # (in UTC) during which system maintenance can occur, which may
1082
+ # result in an outage. This change is made immediately. If moving
1083
+ # this window to the current time, there must be at least 120 minutes
1084
+ # between the current time and end of the window to ensure pending
1085
+ # changes are applied.
1086
+ # * +:multi_az+ - (Boolean) Specifies if the DB Instance is a Multi-AZ
1087
+ # deployment. Constraints: Cannot be specified if the DB Instance is
1088
+ # a read replica.
1089
+ # * +:engine_version+ - (String) The version number of the database
1090
+ # engine to upgrade to. For major version upgrades, if a nondefault
1091
+ # DB Parameter Group is currently in use, a new DB Parameter Group in
1092
+ # the DB Parameter Group Family for the new engine version must be
1093
+ # specified. The new DB Parameter Group can be the default for that
1094
+ # DB Parameter Group Family. Example: 5.1.42
1095
+ # * +:allow_major_version_upgrade+ - (Boolean) Indicates that major
1096
+ # version upgrades are allowed. Constraints: This parameter must be
1097
+ # set to +true+ when specifying a value for the EngineVersion
1098
+ # parameter that is a different major version than the DB Instance's
1099
+ # current version.
1100
+ # * +:auto_minor_version_upgrade+ - (Boolean) Indicates that minor
1101
+ # version upgrades will be applied automatically to the DB Instance
1102
+ # during the maintenance window.
1103
+ # * +:option_group_name+ - (String) Indicates that the DB Instance
1104
+ # should be associated with the specified option group.
1105
+ # @return [Core::Response]
1106
+ # The #data method of the response object returns
1107
+ # a hash with the following structure:
1108
+ # * +:db_instance_identifier+ - (String)
1109
+ # * +:db_instance_class+ - (String)
1110
+ # * +:engine+ - (String)
1111
+ # * +:db_instance_status+ - (String)
1112
+ # * +:master_username+ - (String)
1113
+ # * +:db_name+ - (String)
1114
+ # * +:endpoint+ - (Hash)
1115
+ # * +:address+ - (String)
1116
+ # * +:port+ - (Integer)
1117
+ # * +:allocated_storage+ - (Integer)
1118
+ # * +:instance_create_time+ - (Time)
1119
+ # * +:preferred_backup_window+ - (String)
1120
+ # * +:backup_retention_period+ - (Integer)
1121
+ # * +:db_security_groups+ - (Array<Hash>)
1122
+ # * +:db_security_group_name+ - (String)
1123
+ # * +:status+ - (String)
1124
+ # * +:db_parameter_groups+ - (Array<Hash>)
1125
+ # * +:db_parameter_group_name+ - (String)
1126
+ # * +:parameter_apply_status+ - (String)
1127
+ # * +:availability_zone+ - (String)
1128
+ # * +:db_subnet_group+ - (Hash)
1129
+ # * +:db_subnet_group_name+ - (String)
1130
+ # * +:db_subnet_group_description+ - (String)
1131
+ # * +:vpc_id+ - (String)
1132
+ # * +:subnet_group_status+ - (String)
1133
+ # * +:subnets+ - (Array<Hash>)
1134
+ # * +:subnet_identifier+ - (String)
1135
+ # * +:subnet_availability_zone+ - (Hash)
1136
+ # * +:name+ - (String)
1137
+ # * +:subnet_status+ - (String)
1138
+ # * +:preferred_maintenance_window+ - (String)
1139
+ # * +:pending_modified_values+ - (Hash)
1140
+ # * +:db_instance_class+ - (String)
1141
+ # * +:allocated_storage+ - (Integer)
1142
+ # * +:master_user_password+ - (String)
1143
+ # * +:port+ - (Integer)
1144
+ # * +:backup_retention_period+ - (Integer)
1145
+ # * +:multi_az+ - (Boolean)
1146
+ # * +:engine_version+ - (String)
1147
+ # * +:latest_restorable_time+ - (Time)
1148
+ # * +:multi_az+ - (Boolean)
1149
+ # * +:engine_version+ - (String)
1150
+ # * +:auto_minor_version_upgrade+ - (Boolean)
1151
+ # * +:read_replica_source_db_instance_identifier+ - (String)
1152
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
1153
+ # * +:license_model+ - (String)
1154
+ # * +:option_group_membership+ - (Hash)
1155
+ # * +:option_group_name+ - (String)
1156
+ # * +:status+ - (String)
1157
+ # * +:character_set_name+ - (String)
1158
+
1159
+ # @!method modify_db_parameter_group(options = {})
1160
+ # Calls the ModifyDBParameterGroup API operation.
1161
+ # @param [Hash] options
1162
+ # * +:db_parameter_group_name+ - *required* - (String) The name of the
1163
+ # database parameter group.
1164
+ # * +:parameters+ - *required* - (Array<Hash>) An array of parameter
1165
+ # names, values, and the apply method for the parameter update. At
1166
+ # least one parameter name, value, and apply method must be supplied;
1167
+ # subsequent arguments are optional. A maximum of 20 parameters may
1168
+ # be modified in a single request.
1169
+ # * +:parameter_name+ - (String) Specifies the name of the parameter.
1170
+ # * +:parameter_value+ - (String) Specifies the value of the
1171
+ # parameter.
1172
+ # * +:description+ - (String) Provides a description of the
1173
+ # parameter.
1174
+ # * +:source+ - (String) Indicates the source of the parameter value.
1175
+ # * +:apply_type+ - (String) Specifies the engine specific parameters
1176
+ # type.
1177
+ # * +:data_type+ - (String) Specifies the valid data type for the
1178
+ # parameter.
1179
+ # * +:allowed_values+ - (String) Specifies the valid range of values
1180
+ # for the parameter.
1181
+ # * +:is_modifiable+ - (Boolean) Indicates whether ( +true+ ) or not
1182
+ # ( +false+ ) the parameter can be modified. Some parameters have
1183
+ # security or operational implications that prevent them from being
1184
+ # changed.
1185
+ # * +:minimum_engine_version+ - (String) The earliest engine version
1186
+ # to which the parameter can apply.
1187
+ # * +:apply_method+ - (String) Indicates when to apply parameter
1188
+ # updates.
1189
+ # @return [Core::Response]
1190
+ # The #data method of the response object returns
1191
+ # a hash with the following structure:
1192
+ # * +:db_parameter_group_name+ - (String)
1193
+
1194
+ # @!method modify_db_subnet_group(options = {})
1195
+ # Calls the ModifyDBSubnetGroup API operation.
1196
+ # @param [Hash] options
1197
+ # * +:db_subnet_group_name+ - *required* - (String) The name for the DB
1198
+ # Subnet Group. This value is stored as a lowercase string.
1199
+ # Constraints: Must contain no more than 255 alphanumeric characters
1200
+ # or hyphens. Must not be "Default". Example: mySubnetgroup
1201
+ # * +:db_subnet_group_description+ - (String) The description for the
1202
+ # DB Subnet Group.
1203
+ # * +:subnet_ids+ - *required* - (Array<String>) The EC2 Subnet IDs for
1204
+ # the DB Subnet Group.
1205
+ # @return [Core::Response]
1206
+ # The #data method of the response object returns
1207
+ # a hash with the following structure:
1208
+ # * +:db_subnet_group_name+ - (String)
1209
+ # * +:db_subnet_group_description+ - (String)
1210
+ # * +:vpc_id+ - (String)
1211
+ # * +:subnet_group_status+ - (String)
1212
+ # * +:subnets+ - (Array<Hash>)
1213
+ # * +:subnet_identifier+ - (String)
1214
+ # * +:subnet_availability_zone+ - (Hash)
1215
+ # * +:name+ - (String)
1216
+ # * +:subnet_status+ - (String)
1217
+
1218
+ # @!method modify_option_group(options = {})
1219
+ # Calls the ModifyOptionGroup API operation.
1220
+ # @param [Hash] options
1221
+ # * +:option_group_name+ - *required* - (String) The name of the option
1222
+ # group to be modified.
1223
+ # * +:options_to_include+ - (Array<Hash>) Options in this list are
1224
+ # added to the Option Group or, if already present, the specified
1225
+ # configuration is used to update the existing configuration.
1226
+ # * +:option_name+ - *required* - (String)
1227
+ # * +:port+ - (Integer)
1228
+ # * +:db_security_group_memberships+ - (Array<String>)
1229
+ # * +:options_to_remove+ - (Array<String>) Options in this list are
1230
+ # removed from the Option Group.
1231
+ # * +:apply_immediately+ - (Boolean) Indicates whether the changes
1232
+ # should be applied immediately, or during the next maintenance
1233
+ # window for each instance associated with the Option Group.
1234
+ # @return [Core::Response]
1235
+ # The #data method of the response object returns
1236
+ # a hash with the following structure:
1237
+ # * +:option_group_name+ - (String)
1238
+ # * +:option_group_description+ - (String)
1239
+ # * +:engine_name+ - (String)
1240
+ # * +:major_engine_version+ - (String)
1241
+ # * +:options+ - (Array<Hash>)
1242
+ # * +:option_name+ - (String)
1243
+ # * +:option_description+ - (String)
1244
+ # * +:port+ - (Integer)
1245
+ # * +:db_security_group_memberships+ - (Array<Hash>)
1246
+ # * +:db_security_group_name+ - (String)
1247
+ # * +:status+ - (String)
1248
+
1249
+ # @!method purchase_reserved_db_instances_offering(options = {})
1250
+ # Calls the PurchaseReservedDBInstancesOffering API operation.
1251
+ # @param [Hash] options
1252
+ # * +:reserved_db_instances_offering_id+ - *required* - (String) The ID
1253
+ # of the Reserved DB Instance offering to purchase. Example:
1254
+ # 438012d3-4052-4cc7-b2e3-8d3372e0e706
1255
+ # * +:reserved_db_instance_id+ - (String) Customer-specified identifier
1256
+ # to track this reservation. Example: myreservationID
1257
+ # * +:db_instance_count+ - (Integer) The number of instances to
1258
+ # reserve. Default: 1
1259
+ # @return [Core::Response]
1260
+ # The #data method of the response object returns
1261
+ # a hash with the following structure:
1262
+ # * +:reserved_db_instance_id+ - (String)
1263
+ # * +:reserved_db_instances_offering_id+ - (String)
1264
+ # * +:db_instance_class+ - (String)
1265
+ # * +:start_time+ - (Time)
1266
+ # * +:duration+ - (Integer)
1267
+ # * +:fixed_price+ - (Numeric)
1268
+ # * +:usage_price+ - (Numeric)
1269
+ # * +:currency_code+ - (String)
1270
+ # * +:db_instance_count+ - (Integer)
1271
+ # * +:product_description+ - (String)
1272
+ # * +:offering_type+ - (String)
1273
+ # * +:multi_az+ - (Boolean)
1274
+ # * +:state+ - (String)
1275
+ # * +:recurring_charges+ - (Array<Hash>)
1276
+ # * +:recurring_charge_amount+ - (Numeric)
1277
+ # * +:recurring_charge_frequency+ - (String)
1278
+
1279
+ # @!method reboot_db_instance(options = {})
1280
+ # Calls the RebootDBInstance API operation.
1281
+ # @param [Hash] options
1282
+ # * +:db_instance_identifier+ - *required* - (String) The DB Instance
1283
+ # identifier. This parameter is stored as a lowercase string.
1284
+ # * +:force_failover+ - (Boolean) When +true+ , the reboot will be
1285
+ # conducted through a MultiAZ failover. Constraint: You cannot
1286
+ # specify +true+ if the instance is not configured for MultiAZ.
1287
+ # @return [Core::Response]
1288
+ # The #data method of the response object returns
1289
+ # a hash with the following structure:
1290
+ # * +:db_instance_identifier+ - (String)
1291
+ # * +:db_instance_class+ - (String)
1292
+ # * +:engine+ - (String)
1293
+ # * +:db_instance_status+ - (String)
1294
+ # * +:master_username+ - (String)
1295
+ # * +:db_name+ - (String)
1296
+ # * +:endpoint+ - (Hash)
1297
+ # * +:address+ - (String)
1298
+ # * +:port+ - (Integer)
1299
+ # * +:allocated_storage+ - (Integer)
1300
+ # * +:instance_create_time+ - (Time)
1301
+ # * +:preferred_backup_window+ - (String)
1302
+ # * +:backup_retention_period+ - (Integer)
1303
+ # * +:db_security_groups+ - (Array<Hash>)
1304
+ # * +:db_security_group_name+ - (String)
1305
+ # * +:status+ - (String)
1306
+ # * +:db_parameter_groups+ - (Array<Hash>)
1307
+ # * +:db_parameter_group_name+ - (String)
1308
+ # * +:parameter_apply_status+ - (String)
1309
+ # * +:availability_zone+ - (String)
1310
+ # * +:db_subnet_group+ - (Hash)
1311
+ # * +:db_subnet_group_name+ - (String)
1312
+ # * +:db_subnet_group_description+ - (String)
1313
+ # * +:vpc_id+ - (String)
1314
+ # * +:subnet_group_status+ - (String)
1315
+ # * +:subnets+ - (Array<Hash>)
1316
+ # * +:subnet_identifier+ - (String)
1317
+ # * +:subnet_availability_zone+ - (Hash)
1318
+ # * +:name+ - (String)
1319
+ # * +:subnet_status+ - (String)
1320
+ # * +:preferred_maintenance_window+ - (String)
1321
+ # * +:pending_modified_values+ - (Hash)
1322
+ # * +:db_instance_class+ - (String)
1323
+ # * +:allocated_storage+ - (Integer)
1324
+ # * +:master_user_password+ - (String)
1325
+ # * +:port+ - (Integer)
1326
+ # * +:backup_retention_period+ - (Integer)
1327
+ # * +:multi_az+ - (Boolean)
1328
+ # * +:engine_version+ - (String)
1329
+ # * +:latest_restorable_time+ - (Time)
1330
+ # * +:multi_az+ - (Boolean)
1331
+ # * +:engine_version+ - (String)
1332
+ # * +:auto_minor_version_upgrade+ - (Boolean)
1333
+ # * +:read_replica_source_db_instance_identifier+ - (String)
1334
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
1335
+ # * +:license_model+ - (String)
1336
+ # * +:option_group_membership+ - (Hash)
1337
+ # * +:option_group_name+ - (String)
1338
+ # * +:status+ - (String)
1339
+ # * +:character_set_name+ - (String)
1340
+
1341
+ # @!method reset_db_parameter_group(options = {})
1342
+ # Calls the ResetDBParameterGroup API operation.
1343
+ # @param [Hash] options
1344
+ # * +:db_parameter_group_name+ - *required* - (String) The name of the
1345
+ # DB Parameter Group.
1346
+ # * +:reset_all_parameters+ - (Boolean) Specifies whether ( +true+ ) or
1347
+ # not ( +false+ ) to reset all parameters in the DB Parameter Group
1348
+ # to default values.
1349
+ # * +:parameters+ - (Array<Hash>) An array of parameter names, values,
1350
+ # and the apply method for the parameter update. At least one
1351
+ # parameter name, value, and apply method must be supplied;
1352
+ # subsequent arguments are optional. A maximum of 20 parameters may
1353
+ # be modified in a single request.
1354
+ # * +:parameter_name+ - (String) Specifies the name of the parameter.
1355
+ # * +:parameter_value+ - (String) Specifies the value of the
1356
+ # parameter.
1357
+ # * +:description+ - (String) Provides a description of the
1358
+ # parameter.
1359
+ # * +:source+ - (String) Indicates the source of the parameter value.
1360
+ # * +:apply_type+ - (String) Specifies the engine specific parameters
1361
+ # type.
1362
+ # * +:data_type+ - (String) Specifies the valid data type for the
1363
+ # parameter.
1364
+ # * +:allowed_values+ - (String) Specifies the valid range of values
1365
+ # for the parameter.
1366
+ # * +:is_modifiable+ - (Boolean) Indicates whether ( +true+ ) or not
1367
+ # ( +false+ ) the parameter can be modified. Some parameters have
1368
+ # security or operational implications that prevent them from being
1369
+ # changed.
1370
+ # * +:minimum_engine_version+ - (String) The earliest engine version
1371
+ # to which the parameter can apply.
1372
+ # * +:apply_method+ - (String) Indicates when to apply parameter
1373
+ # updates.
1374
+ # @return [Core::Response]
1375
+ # The #data method of the response object returns
1376
+ # a hash with the following structure:
1377
+ # * +:db_parameter_group_name+ - (String)
1378
+
1379
+ # @!method restore_db_instance_from_db_snapshot(options = {})
1380
+ # Calls the RestoreDBInstanceFromDBSnapshot API operation.
1381
+ # @param [Hash] options
1382
+ # * +:db_instance_identifier+ - *required* - (String) The identifier
1383
+ # for the DB Snapshot to restore from.
1384
+ # * +:db_snapshot_identifier+ - *required* - (String) Name of the DB
1385
+ # Instance to create from the DB Snapshot. This parameter isn't case
1386
+ # sensitive.
1387
+ # * +:db_instance_class+ - (String) The compute and memory capacity of
1388
+ # the Amazon RDS DB instance.
1389
+ # * +:port+ - (Integer) The port number on which the database accepts
1390
+ # connections.
1391
+ # * +:availability_zone+ - (String) The EC2 Availability Zone that the
1392
+ # database instance will be created in.
1393
+ # * +:db_subnet_group_name+ - (String) The DB Subnet Group name to use
1394
+ # for the new instance.
1395
+ # * +:multi_az+ - (Boolean) Specifies if the DB Instance is a Multi-AZ
1396
+ # deployment. Constraint: You cannot specify the AvailabilityZone
1397
+ # parameter if the MultiAZ parameter is set to +true+ .
1398
+ # * +:auto_minor_version_upgrade+ - (Boolean) Indicates that minor
1399
+ # version upgrades will be applied automatically to the DB Instance
1400
+ # during the maintenance window.
1401
+ # * +:license_model+ - (String) License model information for the
1402
+ # restored DB Instance. Default: Same as source. Valid values:
1403
+ # license-included | bring-your-own-license | general-public-license
1404
+ # * +:db_name+ - (String) The database name for the restored DB
1405
+ # Instance. This parameter doesn't apply to the MySQL engine.
1406
+ # * +:engine+ - (String) The database engine to use for the new
1407
+ # instance. Default: The same as source Constraint: Must be
1408
+ # compatible with the engine of the source Example: oracle-ee
1409
+ # * +:option_group_name+ - (String)
1410
+ # @return [Core::Response]
1411
+ # The #data method of the response object returns
1412
+ # a hash with the following structure:
1413
+ # * +:db_instance_identifier+ - (String)
1414
+ # * +:db_instance_class+ - (String)
1415
+ # * +:engine+ - (String)
1416
+ # * +:db_instance_status+ - (String)
1417
+ # * +:master_username+ - (String)
1418
+ # * +:db_name+ - (String)
1419
+ # * +:endpoint+ - (Hash)
1420
+ # * +:address+ - (String)
1421
+ # * +:port+ - (Integer)
1422
+ # * +:allocated_storage+ - (Integer)
1423
+ # * +:instance_create_time+ - (Time)
1424
+ # * +:preferred_backup_window+ - (String)
1425
+ # * +:backup_retention_period+ - (Integer)
1426
+ # * +:db_security_groups+ - (Array<Hash>)
1427
+ # * +:db_security_group_name+ - (String)
1428
+ # * +:status+ - (String)
1429
+ # * +:db_parameter_groups+ - (Array<Hash>)
1430
+ # * +:db_parameter_group_name+ - (String)
1431
+ # * +:parameter_apply_status+ - (String)
1432
+ # * +:availability_zone+ - (String)
1433
+ # * +:db_subnet_group+ - (Hash)
1434
+ # * +:db_subnet_group_name+ - (String)
1435
+ # * +:db_subnet_group_description+ - (String)
1436
+ # * +:vpc_id+ - (String)
1437
+ # * +:subnet_group_status+ - (String)
1438
+ # * +:subnets+ - (Array<Hash>)
1439
+ # * +:subnet_identifier+ - (String)
1440
+ # * +:subnet_availability_zone+ - (Hash)
1441
+ # * +:name+ - (String)
1442
+ # * +:subnet_status+ - (String)
1443
+ # * +:preferred_maintenance_window+ - (String)
1444
+ # * +:pending_modified_values+ - (Hash)
1445
+ # * +:db_instance_class+ - (String)
1446
+ # * +:allocated_storage+ - (Integer)
1447
+ # * +:master_user_password+ - (String)
1448
+ # * +:port+ - (Integer)
1449
+ # * +:backup_retention_period+ - (Integer)
1450
+ # * +:multi_az+ - (Boolean)
1451
+ # * +:engine_version+ - (String)
1452
+ # * +:latest_restorable_time+ - (Time)
1453
+ # * +:multi_az+ - (Boolean)
1454
+ # * +:engine_version+ - (String)
1455
+ # * +:auto_minor_version_upgrade+ - (Boolean)
1456
+ # * +:read_replica_source_db_instance_identifier+ - (String)
1457
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
1458
+ # * +:license_model+ - (String)
1459
+ # * +:option_group_membership+ - (Hash)
1460
+ # * +:option_group_name+ - (String)
1461
+ # * +:status+ - (String)
1462
+ # * +:character_set_name+ - (String)
1463
+
1464
+ # @!method restore_db_instance_to_point_in_time(options = {})
1465
+ # Calls the RestoreDBInstanceToPointInTime API operation.
1466
+ # @param [Hash] options
1467
+ # * +:source_db_instance_identifier+ - *required* - (String) The
1468
+ # identifier of the source DB Instance from which to restore.
1469
+ # * +:target_db_instance_identifier+ - *required* - (String) The name
1470
+ # of the new database instance to be created.
1471
+ # * +:restore_time+ - (String<ISO8601 datetime>) The date and time from
1472
+ # to restore from.
1473
+ # * +:use_latest_restorable_time+ - (Boolean) Specifies whether (
1474
+ # +true+ ) or not ( +false+ ) the DB Instance is restored from the
1475
+ # latest backup time.
1476
+ # * +:db_instance_class+ - (String) The compute and memory capacity of
1477
+ # the Amazon RDS DB instance.
1478
+ # * +:port+ - (Integer) The port number on which the database accepts
1479
+ # connections.
1480
+ # * +:availability_zone+ - (String) The EC2 Availability Zone that the
1481
+ # database instance will be created in.
1482
+ # * +:db_subnet_group_name+ - (String) The DB subnet group name to use
1483
+ # for the new instance.
1484
+ # * +:multi_az+ - (Boolean) Specifies if the DB Instance is a Multi-AZ
1485
+ # deployment. Constraint: You cannot specify the AvailabilityZone
1486
+ # parameter if the MultiAZ parameter is set to +true+ .
1487
+ # * +:auto_minor_version_upgrade+ - (Boolean) Indicates that minor
1488
+ # version upgrades will be applied automatically to the DB Instance
1489
+ # during the maintenance window.
1490
+ # * +:license_model+ - (String) License model information for the
1491
+ # restored DB Instance. Default: Same as source. Valid values:
1492
+ # license-included | bring-your-own-license | general-public-license
1493
+ # * +:db_name+ - (String) The database name for the restored DB
1494
+ # Instance. This parameter is not used for the MySQL engine.
1495
+ # * +:engine+ - (String) The database engine to use for the new
1496
+ # instance. Default: The same as source Constraint: Must be
1497
+ # compatible with the engine of the source Example: oracle-ee
1498
+ # * +:option_group_name+ - (String)
1499
+ # @return [Core::Response]
1500
+ # The #data method of the response object returns
1501
+ # a hash with the following structure:
1502
+ # * +:db_instance_identifier+ - (String)
1503
+ # * +:db_instance_class+ - (String)
1504
+ # * +:engine+ - (String)
1505
+ # * +:db_instance_status+ - (String)
1506
+ # * +:master_username+ - (String)
1507
+ # * +:db_name+ - (String)
1508
+ # * +:endpoint+ - (Hash)
1509
+ # * +:address+ - (String)
1510
+ # * +:port+ - (Integer)
1511
+ # * +:allocated_storage+ - (Integer)
1512
+ # * +:instance_create_time+ - (Time)
1513
+ # * +:preferred_backup_window+ - (String)
1514
+ # * +:backup_retention_period+ - (Integer)
1515
+ # * +:db_security_groups+ - (Array<Hash>)
1516
+ # * +:db_security_group_name+ - (String)
1517
+ # * +:status+ - (String)
1518
+ # * +:db_parameter_groups+ - (Array<Hash>)
1519
+ # * +:db_parameter_group_name+ - (String)
1520
+ # * +:parameter_apply_status+ - (String)
1521
+ # * +:availability_zone+ - (String)
1522
+ # * +:db_subnet_group+ - (Hash)
1523
+ # * +:db_subnet_group_name+ - (String)
1524
+ # * +:db_subnet_group_description+ - (String)
1525
+ # * +:vpc_id+ - (String)
1526
+ # * +:subnet_group_status+ - (String)
1527
+ # * +:subnets+ - (Array<Hash>)
1528
+ # * +:subnet_identifier+ - (String)
1529
+ # * +:subnet_availability_zone+ - (Hash)
1530
+ # * +:name+ - (String)
1531
+ # * +:subnet_status+ - (String)
1532
+ # * +:preferred_maintenance_window+ - (String)
1533
+ # * +:pending_modified_values+ - (Hash)
1534
+ # * +:db_instance_class+ - (String)
1535
+ # * +:allocated_storage+ - (Integer)
1536
+ # * +:master_user_password+ - (String)
1537
+ # * +:port+ - (Integer)
1538
+ # * +:backup_retention_period+ - (Integer)
1539
+ # * +:multi_az+ - (Boolean)
1540
+ # * +:engine_version+ - (String)
1541
+ # * +:latest_restorable_time+ - (Time)
1542
+ # * +:multi_az+ - (Boolean)
1543
+ # * +:engine_version+ - (String)
1544
+ # * +:auto_minor_version_upgrade+ - (Boolean)
1545
+ # * +:read_replica_source_db_instance_identifier+ - (String)
1546
+ # * +:read_replica_db_instance_identifiers+ - (Array<String>)
1547
+ # * +:license_model+ - (String)
1548
+ # * +:option_group_membership+ - (Hash)
1549
+ # * +:option_group_name+ - (String)
1550
+ # * +:status+ - (String)
1551
+ # * +:character_set_name+ - (String)
1552
+
1553
+ # @!method revoke_db_security_group_ingress(options = {})
1554
+ # Calls the RevokeDBSecurityGroupIngress API operation.
1555
+ # @param [Hash] options
1556
+ # * +:db_security_group_name+ - *required* - (String) The name of the
1557
+ # DB Security Group to revoke ingress from.
1558
+ # * +:cidrip+ - (String) The IP range to revoke access from.
1559
+ # * +:ec2_security_group_name+ - (String) The name of the EC2 Security
1560
+ # Group to revoke access from.
1561
+ # * +:ec2_security_group_id+ - (String) The id of the EC2 Security
1562
+ # Group to revoke access from. For VPC DB Security Groups,
1563
+ # EC2SecurityGroupId must be provided. Otherwise,
1564
+ # EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
1565
+ # EC2SecurityGroupId must be provided.
1566
+ # * +:ec2_security_group_owner_id+ - (String) The AWS Account Number of
1567
+ # the owner of the security group specified in the
1568
+ # EC2SecurityGroupName parameter. The AWS Access Key ID is not an
1569
+ # acceptable value.
1570
+ # @return [Core::Response]
1571
+ # The #data method of the response object returns
1572
+ # a hash with the following structure:
1573
+ # * +:owner_id+ - (String)
1574
+ # * +:db_security_group_name+ - (String)
1575
+ # * +:db_security_group_description+ - (String)
1576
+ # * +:vpc_id+ - (String)
1577
+ # * +:ec_2_security_groups+ - (Array<Hash>)
1578
+ # * +:status+ - (String)
1579
+ # * +:ec2_security_group_name+ - (String)
1580
+ # * +:ec2_security_group_id+ - (String)
1581
+ # * +:ec2_security_group_owner_id+ - (String)
1582
+ # * +:ip_ranges+ - (Array<Hash>)
1583
+ # * +:status+ - (String)
1584
+ # * +:cidrip+ - (String)
1585
+
1586
+ ## end client methods ##
1587
+
1588
+ define_client_methods('2012-07-31')
1589
+
1590
+ end
1591
+ end
1592
+ end