aws-sdk-rds 1.80.0 → 1.85.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/account_quota.rb +13 -11
- data/lib/aws-sdk-rds/certificate.rb +13 -11
- data/lib/aws-sdk-rds/client.rb +280 -151
- data/lib/aws-sdk-rds/client_api.rb +18 -1
- data/lib/aws-sdk-rds/customizations/auth_token_generator.rb +6 -3
- data/lib/aws-sdk-rds/db_cluster.rb +41 -24
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +13 -11
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +14 -12
- data/lib/aws-sdk-rds/db_engine.rb +13 -11
- data/lib/aws-sdk-rds/db_engine_version.rb +20 -12
- data/lib/aws-sdk-rds/db_instance.rb +98 -76
- data/lib/aws-sdk-rds/db_log_file.rb +13 -11
- data/lib/aws-sdk-rds/db_parameter_group.rb +13 -11
- data/lib/aws-sdk-rds/db_parameter_group_family.rb +13 -11
- data/lib/aws-sdk-rds/db_security_group.rb +13 -11
- data/lib/aws-sdk-rds/db_snapshot.rb +13 -11
- data/lib/aws-sdk-rds/db_snapshot_attribute.rb +13 -11
- data/lib/aws-sdk-rds/db_subnet_group.rb +13 -11
- data/lib/aws-sdk-rds/event.rb +13 -11
- data/lib/aws-sdk-rds/event_category_map.rb +13 -11
- data/lib/aws-sdk-rds/event_subscription.rb +13 -11
- data/lib/aws-sdk-rds/option_group.rb +13 -11
- data/lib/aws-sdk-rds/option_group_option.rb +13 -11
- data/lib/aws-sdk-rds/parameter.rb +13 -11
- data/lib/aws-sdk-rds/pending_maintenance_action.rb +13 -11
- data/lib/aws-sdk-rds/reserved_db_instance.rb +13 -11
- data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +13 -11
- data/lib/aws-sdk-rds/resource.rb +29 -20
- data/lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb +13 -11
- data/lib/aws-sdk-rds/types.rb +261 -143
- data/lib/aws-sdk-rds/waiters.rb +66 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 76e9b510f084d2bb4f1518b9071d27a8484c6b9f3f39869b6669e3e7dfbdca19
|
4
|
+
data.tar.gz: cf688bc2584f7b79710b0fcfe6eee5b772a90fa202e69c03050369125cf47320
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 530fed5135252cc2560b41597d99148193576ff2f048506b146d52370b9e2b0da885ca1d783faab1198ba84e43c313f965303e414f7e688baeab095ec79a4daf
|
7
|
+
data.tar.gz: 5eb0236a995a452f54e21e6b2da9bea721790c6400d81a21ae17e0c4196a1fc8abf46627ddeb0e3c418c2d2211a4d01827ea5c83c7d59d7251314a14054fe463
|
data/lib/aws-sdk-rds.rb
CHANGED
@@ -80,7 +80,8 @@ module Aws::RDS
|
|
80
80
|
# Waiter polls an API operation until a resource enters a desired
|
81
81
|
# state.
|
82
82
|
#
|
83
|
-
# @note The waiting operation is performed on a copy. The original resource
|
83
|
+
# @note The waiting operation is performed on a copy. The original resource
|
84
|
+
# remains unchanged.
|
84
85
|
#
|
85
86
|
# ## Basic Usage
|
86
87
|
#
|
@@ -93,13 +94,15 @@ module Aws::RDS
|
|
93
94
|
#
|
94
95
|
# ## Example
|
95
96
|
#
|
96
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
97
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
98
|
+
# instance.state.name == 'running'
|
99
|
+
# end
|
97
100
|
#
|
98
101
|
# ## Configuration
|
99
102
|
#
|
100
103
|
# You can configure the maximum number of polling attempts, and the
|
101
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
102
|
-
# by passing a block to {#wait_until}:
|
104
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
105
|
+
# set by passing a block to {#wait_until}:
|
103
106
|
#
|
104
107
|
# # poll for ~25 seconds
|
105
108
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -130,17 +133,16 @@ module Aws::RDS
|
|
130
133
|
# # resource did not enter the desired state in time
|
131
134
|
# end
|
132
135
|
#
|
136
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
133
137
|
#
|
134
|
-
# @
|
135
|
-
#
|
136
|
-
#
|
137
|
-
# because the waiter has entered a state that it will not transition
|
138
|
-
# out of, preventing success.
|
138
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
139
|
+
# terminates because the waiter has entered a state that it will not
|
140
|
+
# transition out of, preventing success.
|
139
141
|
#
|
140
142
|
# yet successful.
|
141
143
|
#
|
142
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
143
|
-
# while polling for a resource that is not expected.
|
144
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
145
|
+
# encountered while polling for a resource that is not expected.
|
144
146
|
#
|
145
147
|
# @raise [NotImplementedError] Raised when the resource does not
|
146
148
|
#
|
@@ -116,7 +116,8 @@ module Aws::RDS
|
|
116
116
|
# Waiter polls an API operation until a resource enters a desired
|
117
117
|
# state.
|
118
118
|
#
|
119
|
-
# @note The waiting operation is performed on a copy. The original resource
|
119
|
+
# @note The waiting operation is performed on a copy. The original resource
|
120
|
+
# remains unchanged.
|
120
121
|
#
|
121
122
|
# ## Basic Usage
|
122
123
|
#
|
@@ -129,13 +130,15 @@ module Aws::RDS
|
|
129
130
|
#
|
130
131
|
# ## Example
|
131
132
|
#
|
132
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
133
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
134
|
+
# instance.state.name == 'running'
|
135
|
+
# end
|
133
136
|
#
|
134
137
|
# ## Configuration
|
135
138
|
#
|
136
139
|
# You can configure the maximum number of polling attempts, and the
|
137
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
138
|
-
# by passing a block to {#wait_until}:
|
140
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
141
|
+
# set by passing a block to {#wait_until}:
|
139
142
|
#
|
140
143
|
# # poll for ~25 seconds
|
141
144
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -166,17 +169,16 @@ module Aws::RDS
|
|
166
169
|
# # resource did not enter the desired state in time
|
167
170
|
# end
|
168
171
|
#
|
172
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
169
173
|
#
|
170
|
-
# @
|
171
|
-
#
|
172
|
-
#
|
173
|
-
# because the waiter has entered a state that it will not transition
|
174
|
-
# out of, preventing success.
|
174
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
175
|
+
# terminates because the waiter has entered a state that it will not
|
176
|
+
# transition out of, preventing success.
|
175
177
|
#
|
176
178
|
# yet successful.
|
177
179
|
#
|
178
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
179
|
-
# while polling for a resource that is not expected.
|
180
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
181
|
+
# encountered while polling for a resource that is not expected.
|
180
182
|
#
|
181
183
|
# @raise [NotImplementedError] Raised when the resource does not
|
182
184
|
#
|
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -107,7 +107,7 @@ module Aws::RDS
|
|
107
107
|
# @option options [required, String] :region
|
108
108
|
# The AWS region to connect to. The configured `:region` is
|
109
109
|
# used to determine the service `:endpoint`. When not passed,
|
110
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
111
111
|
#
|
112
112
|
# * `Aws.config[:region]`
|
113
113
|
# * `ENV['AWS_REGION']`
|
@@ -163,7 +163,7 @@ module Aws::RDS
|
|
163
163
|
# @option options [String] :endpoint
|
164
164
|
# The client endpoint is normally constructed from the `:region`
|
165
165
|
# option. You should only configure an `:endpoint` when connecting
|
166
|
-
# to test endpoints. This should be
|
166
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
167
167
|
#
|
168
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
169
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -178,7 +178,7 @@ module Aws::RDS
|
|
178
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
179
179
|
#
|
180
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
181
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
182
182
|
#
|
183
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
184
184
|
# The log formatter.
|
@@ -271,8 +271,7 @@ module Aws::RDS
|
|
271
271
|
#
|
272
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
273
273
|
# number of seconds to wait for response data. This value can
|
274
|
-
# safely be set
|
275
|
-
# per-request on the session yielded by {#session_for}.
|
274
|
+
# safely be set per-request on the session.
|
276
275
|
#
|
277
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
278
277
|
# seconds a connection is allowed to sit idle before it is
|
@@ -284,7 +283,7 @@ module Aws::RDS
|
|
284
283
|
# request body. This option has no effect unless the request has
|
285
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
286
285
|
# disables this behaviour. This value can safely be set per
|
287
|
-
# request on the session
|
286
|
+
# request on the session.
|
288
287
|
#
|
289
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
290
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -1140,7 +1139,7 @@ module Aws::RDS
|
|
1140
1139
|
# encrypted DB cluster snapshot in the same AWS Region.
|
1141
1140
|
#
|
1142
1141
|
# The pre-signed URL must be a valid request for the
|
1143
|
-
# `
|
1142
|
+
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
1144
1143
|
# AWS Region that contains the encrypted DB cluster snapshot to be
|
1145
1144
|
# copied. The pre-signed URL request must contain the following
|
1146
1145
|
# parameter values:
|
@@ -1804,7 +1803,7 @@ module Aws::RDS
|
|
1804
1803
|
# Creates a new Amazon Aurora DB cluster.
|
1805
1804
|
#
|
1806
1805
|
# You can use the `ReplicationSourceIdentifier` parameter to create the
|
1807
|
-
# DB cluster as a
|
1806
|
+
# DB cluster as a read replica of another DB cluster or Amazon RDS MySQL
|
1808
1807
|
# DB instance. For cross-region replication where the DB cluster
|
1809
1808
|
# identified by `ReplicationSourceIdentifier` is encrypted, you must
|
1810
1809
|
# also specify the `PreSignedUrl` parameter.
|
@@ -2001,7 +2000,7 @@ module Aws::RDS
|
|
2001
2000
|
#
|
2002
2001
|
# @option params [String] :replication_source_identifier
|
2003
2002
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
2004
|
-
# if this DB cluster is created as a
|
2003
|
+
# if this DB cluster is created as a read replica.
|
2005
2004
|
#
|
2006
2005
|
# @option params [Array<Types::Tag>] :tags
|
2007
2006
|
# Tags to assign to the DB cluster.
|
@@ -2032,9 +2031,9 @@ module Aws::RDS
|
|
2032
2031
|
# AWS account has a different default encryption key for each AWS
|
2033
2032
|
# Region.
|
2034
2033
|
#
|
2035
|
-
# If you create a
|
2034
|
+
# If you create a read replica of an encrypted DB cluster in another AWS
|
2036
2035
|
# Region, you must set `KmsKeyId` to a KMS key ID that is valid in the
|
2037
|
-
# destination AWS Region. This key is used to encrypt the
|
2036
|
+
# destination AWS Region. This key is used to encrypt the read replica
|
2038
2037
|
# in that AWS Region.
|
2039
2038
|
#
|
2040
2039
|
# @option params [String] :pre_signed_url
|
@@ -2057,8 +2056,8 @@ module Aws::RDS
|
|
2057
2056
|
# action that is called in the destination AWS Region, and the action
|
2058
2057
|
# contained in the pre-signed URL.
|
2059
2058
|
#
|
2060
|
-
# * `DestinationRegion` - The name of the AWS Region that Aurora
|
2061
|
-
#
|
2059
|
+
# * `DestinationRegion` - The name of the AWS Region that Aurora read
|
2060
|
+
# replica will be created in.
|
2062
2061
|
#
|
2063
2062
|
# * `ReplicationSourceIdentifier` - The DB cluster identifier for the
|
2064
2063
|
# encrypted DB cluster to be copied. This identifier must be in the
|
@@ -2124,6 +2123,12 @@ module Aws::RDS
|
|
2124
2123
|
# The DB engine mode of the DB cluster, either `provisioned`,
|
2125
2124
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
2126
2125
|
#
|
2126
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters created
|
2127
|
+
# with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions,
|
2128
|
+
# the clusters in a global database use `provisioned` engine mode.
|
2129
|
+
#
|
2130
|
+
# </note>
|
2131
|
+
#
|
2127
2132
|
# Limitations and requirements apply to some DB engine modes. For more
|
2128
2133
|
# information, see the following sections in the *Amazon Aurora User
|
2129
2134
|
# Guide*\:
|
@@ -2182,12 +2187,12 @@ module Aws::RDS
|
|
2182
2187
|
#
|
2183
2188
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
2184
2189
|
# Authentication to authenticate users that connect to the DB cluster.
|
2185
|
-
# For more information, see [
|
2186
|
-
#
|
2190
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
2191
|
+
# Aurora User Guide*.
|
2187
2192
|
#
|
2188
2193
|
#
|
2189
2194
|
#
|
2190
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
2195
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
2191
2196
|
#
|
2192
2197
|
# @option params [String] :domain_iam_role_name
|
2193
2198
|
# Specify the name of the IAM role to be used when making API calls to
|
@@ -3096,7 +3101,7 @@ module Aws::RDS
|
|
3096
3101
|
#
|
3097
3102
|
# * Must be a value from 0 to 35
|
3098
3103
|
#
|
3099
|
-
# * Can't be set to 0 if the DB instance is a source to
|
3104
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas
|
3100
3105
|
#
|
3101
3106
|
# @option params [String] :preferred_backup_window
|
3102
3107
|
# The daily time range during which automated backups are created if
|
@@ -3136,7 +3141,7 @@ module Aws::RDS
|
|
3136
3141
|
#
|
3137
3142
|
# Default: `3306`
|
3138
3143
|
#
|
3139
|
-
# Valid
|
3144
|
+
# Valid values: `1150-65535`
|
3140
3145
|
#
|
3141
3146
|
# Type: Integer
|
3142
3147
|
#
|
@@ -3144,7 +3149,7 @@ module Aws::RDS
|
|
3144
3149
|
#
|
3145
3150
|
# Default: `3306`
|
3146
3151
|
#
|
3147
|
-
# Valid
|
3152
|
+
# Valid values: `1150-65535`
|
3148
3153
|
#
|
3149
3154
|
# Type: Integer
|
3150
3155
|
#
|
@@ -3152,7 +3157,7 @@ module Aws::RDS
|
|
3152
3157
|
#
|
3153
3158
|
# Default: `5432`
|
3154
3159
|
#
|
3155
|
-
# Valid
|
3160
|
+
# Valid values: `1150-65535`
|
3156
3161
|
#
|
3157
3162
|
# Type: Integer
|
3158
3163
|
#
|
@@ -3160,20 +3165,20 @@ module Aws::RDS
|
|
3160
3165
|
#
|
3161
3166
|
# Default: `1521`
|
3162
3167
|
#
|
3163
|
-
# Valid
|
3168
|
+
# Valid values: `1150-65535`
|
3164
3169
|
#
|
3165
3170
|
# **SQL Server**
|
3166
3171
|
#
|
3167
3172
|
# Default: `1433`
|
3168
3173
|
#
|
3169
|
-
# Valid
|
3170
|
-
# `
|
3174
|
+
# Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
|
3175
|
+
# `3389`, `47001`, and `49152-49156`.
|
3171
3176
|
#
|
3172
3177
|
# **Amazon Aurora**
|
3173
3178
|
#
|
3174
3179
|
# Default: `3306`
|
3175
3180
|
#
|
3176
|
-
# Valid
|
3181
|
+
# Valid values: `1150-65535`
|
3177
3182
|
#
|
3178
3183
|
# Type: Integer
|
3179
3184
|
#
|
@@ -3366,15 +3371,13 @@ module Aws::RDS
|
|
3366
3371
|
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
3367
3372
|
# RDS User Guide*.
|
3368
3373
|
#
|
3369
|
-
# For Oracle DB
|
3374
|
+
# For Oracle DB instances, Amazon RDS can use Kerberos Authentication to
|
3370
3375
|
# authenticate users that connect to the DB instance. For more
|
3371
3376
|
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
3372
3377
|
# Oracle][2] in the *Amazon RDS User Guide*.
|
3373
3378
|
#
|
3374
3379
|
#
|
3375
3380
|
#
|
3376
|
-
#
|
3377
|
-
#
|
3378
3381
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
3379
3382
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
3380
3383
|
#
|
@@ -3745,19 +3748,20 @@ module Aws::RDS
|
|
3745
3748
|
req.send_request(options)
|
3746
3749
|
end
|
3747
3750
|
|
3748
|
-
# Creates a new DB instance that acts as a
|
3749
|
-
# source DB instance. You can create a
|
3750
|
-
# running MySQL, MariaDB, Oracle, or
|
3751
|
-
# see [Working with Read Replicas][1] in the *Amazon RDS
|
3751
|
+
# Creates a new DB instance that acts as a read replica for an existing
|
3752
|
+
# source DB instance. You can create a read replica for a DB instance
|
3753
|
+
# running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more
|
3754
|
+
# information, see [Working with Read Replicas][1] in the *Amazon RDS
|
3755
|
+
# User Guide*.
|
3752
3756
|
#
|
3753
|
-
# Amazon Aurora doesn't support this action.
|
3757
|
+
# Amazon Aurora doesn't support this action. Call the
|
3754
3758
|
# `CreateDBInstance` action to create a DB instance for an Aurora DB
|
3755
3759
|
# cluster.
|
3756
3760
|
#
|
3757
|
-
# All
|
3761
|
+
# All read replica DB instances are created with backups disabled. All
|
3758
3762
|
# other DB instance attributes (including DB security groups and DB
|
3759
3763
|
# parameter groups) are inherited from the source DB instance, except as
|
3760
|
-
# specified
|
3764
|
+
# specified.
|
3761
3765
|
#
|
3762
3766
|
# Your source DB instance must have backup retention enabled.
|
3763
3767
|
#
|
@@ -3766,47 +3770,53 @@ module Aws::RDS
|
|
3766
3770
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html
|
3767
3771
|
#
|
3768
3772
|
# @option params [required, String] :db_instance_identifier
|
3769
|
-
# The DB instance identifier of the
|
3773
|
+
# The DB instance identifier of the read replica. This identifier is the
|
3770
3774
|
# unique key that identifies a DB instance. This parameter is stored as
|
3771
3775
|
# a lowercase string.
|
3772
3776
|
#
|
3773
3777
|
# @option params [required, String] :source_db_instance_identifier
|
3774
3778
|
# The identifier of the DB instance that will act as the source for the
|
3775
|
-
#
|
3779
|
+
# read replica. Each DB instance can have up to five read replicas.
|
3776
3780
|
#
|
3777
3781
|
# Constraints:
|
3778
3782
|
#
|
3779
|
-
# * Must be the identifier of an existing MySQL, MariaDB, Oracle,
|
3780
|
-
# PostgreSQL DB instance.
|
3783
|
+
# * Must be the identifier of an existing MySQL, MariaDB, Oracle,
|
3784
|
+
# PostgreSQL, or SQL Server DB instance.
|
3781
3785
|
#
|
3782
|
-
# * Can specify a DB instance that is a MySQL
|
3786
|
+
# * Can specify a DB instance that is a MySQL read replica only if the
|
3783
3787
|
# source is running MySQL 5.6 or later.
|
3784
3788
|
#
|
3785
|
-
# * For the limitations of Oracle
|
3789
|
+
# * For the limitations of Oracle read replicas, see [Read Replica
|
3786
3790
|
# Limitations with Oracle][1] in the *Amazon RDS User Guide*.
|
3787
3791
|
#
|
3788
|
-
# *
|
3789
|
-
#
|
3790
|
-
#
|
3792
|
+
# * For the limitations of SQL Server read replicas, see [Read Replica
|
3793
|
+
# Limitations with Microsoft SQL Server][2] in the *Amazon RDS User
|
3794
|
+
# Guide*.
|
3791
3795
|
#
|
3792
|
-
# *
|
3793
|
-
#
|
3796
|
+
# * Can specify a PostgreSQL DB instance only if the source is running
|
3797
|
+
# PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region
|
3798
|
+
# replication).
|
3794
3799
|
#
|
3795
|
-
# *
|
3796
|
-
#
|
3800
|
+
# * The specified DB instance must have automatic backups enabled, that
|
3801
|
+
# is, its backup retention period must be greater than 0.
|
3797
3802
|
#
|
3798
|
-
# * If the source DB instance is in
|
3799
|
-
#
|
3800
|
-
#
|
3801
|
-
#
|
3803
|
+
# * If the source DB instance is in the same AWS Region as the read
|
3804
|
+
# replica, specify a valid DB instance identifier.
|
3805
|
+
#
|
3806
|
+
# * If the source DB instance is in a different AWS Region from the read
|
3807
|
+
# replica, specify a valid DB instance ARN. For more information, see
|
3808
|
+
# [Constructing an ARN for Amazon RDS][3] in the *Amazon RDS User
|
3809
|
+
# Guide*. This doesn't apply to SQL Server, which doesn't support
|
3810
|
+
# cross-region replicas.
|
3802
3811
|
#
|
3803
3812
|
#
|
3804
3813
|
#
|
3805
3814
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
3806
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
3815
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html
|
3816
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
|
3807
3817
|
#
|
3808
3818
|
# @option params [String] :db_instance_class
|
3809
|
-
# The compute and memory capacity of the
|
3819
|
+
# The compute and memory capacity of the read replica, for example,
|
3810
3820
|
# `db.m4.large`. Not all DB instance classes are available in all AWS
|
3811
3821
|
# Regions, or for all database engines. For the full list of DB instance
|
3812
3822
|
# classes, and availability for your engine, see [DB Instance Class][1]
|
@@ -3819,7 +3829,7 @@ module Aws::RDS
|
|
3819
3829
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
3820
3830
|
#
|
3821
3831
|
# @option params [String] :availability_zone
|
3822
|
-
# The Availability Zone (AZ) where the
|
3832
|
+
# The Availability Zone (AZ) where the read replica will be created.
|
3823
3833
|
#
|
3824
3834
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
3825
3835
|
# AWS Region.
|
@@ -3834,18 +3844,18 @@ module Aws::RDS
|
|
3834
3844
|
# Valid Values: `1150-65535`
|
3835
3845
|
#
|
3836
3846
|
# @option params [Boolean] :multi_az
|
3837
|
-
# A value that indicates whether the
|
3847
|
+
# A value that indicates whether the read replica is in a Multi-AZ
|
3838
3848
|
# deployment.
|
3839
3849
|
#
|
3840
|
-
# You can create a
|
3850
|
+
# You can create a read replica as a Multi-AZ DB instance. RDS creates a
|
3841
3851
|
# standby of your replica in another Availability Zone for failover
|
3842
|
-
# support for the replica. Creating your
|
3852
|
+
# support for the replica. Creating your read replica as a Multi-AZ DB
|
3843
3853
|
# instance is independent of whether the source database is a Multi-AZ
|
3844
3854
|
# DB instance.
|
3845
3855
|
#
|
3846
3856
|
# @option params [Boolean] :auto_minor_version_upgrade
|
3847
3857
|
# A value that indicates whether minor engine upgrades are applied
|
3848
|
-
# automatically to the
|
3858
|
+
# automatically to the read replica during the maintenance window.
|
3849
3859
|
#
|
3850
3860
|
# Default: Inherits from the source DB instance
|
3851
3861
|
#
|
@@ -3857,13 +3867,18 @@ module Aws::RDS
|
|
3857
3867
|
# The option group the DB instance is associated with. If omitted, the
|
3858
3868
|
# option group associated with the source instance is used.
|
3859
3869
|
#
|
3870
|
+
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
3871
|
+
# source instance.
|
3872
|
+
#
|
3873
|
+
# </note>
|
3874
|
+
#
|
3860
3875
|
# @option params [String] :db_parameter_group_name
|
3861
3876
|
# The name of the DB parameter group to associate with this DB instance.
|
3862
3877
|
#
|
3863
3878
|
# If you do not specify a value for `DBParameterGroupName`, then Amazon
|
3864
3879
|
# RDS uses the `DBParameterGroup` of source DB instance for a same
|
3865
|
-
# region
|
3866
|
-
# specified DB engine for a cross region
|
3880
|
+
# region read replica, or the default `DBParameterGroup` for the
|
3881
|
+
# specified DB engine for a cross region read replica.
|
3867
3882
|
#
|
3868
3883
|
# <note markdown="1"> Currently, specifying a parameter group for this operation is only
|
3869
3884
|
# supported for Oracle DB instances.
|
@@ -3910,25 +3925,25 @@ module Aws::RDS
|
|
3910
3925
|
# * The specified DB subnet group must be in the same AWS Region in
|
3911
3926
|
# which the operation is running.
|
3912
3927
|
#
|
3913
|
-
# * All
|
3928
|
+
# * All read replicas in one AWS Region that are created from the same
|
3914
3929
|
# source DB instance must either:>
|
3915
3930
|
#
|
3916
|
-
# * Specify DB subnet groups from the same VPC. All these
|
3917
|
-
#
|
3931
|
+
# * Specify DB subnet groups from the same VPC. All these read
|
3932
|
+
# replicas are created in the same VPC.
|
3918
3933
|
#
|
3919
|
-
# * Not specify a DB subnet group. All these
|
3934
|
+
# * Not specify a DB subnet group. All these read replicas are created
|
3920
3935
|
# outside of any VPC.
|
3921
3936
|
#
|
3922
3937
|
# Example: `mySubnetgroup`
|
3923
3938
|
#
|
3924
3939
|
# @option params [Array<String>] :vpc_security_group_ids
|
3925
|
-
# A list of EC2 VPC security groups to associate with the
|
3940
|
+
# A list of EC2 VPC security groups to associate with the read replica.
|
3926
3941
|
#
|
3927
3942
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
3928
3943
|
# VPC.
|
3929
3944
|
#
|
3930
3945
|
# @option params [String] :storage_type
|
3931
|
-
# Specifies the storage type to be associated with the
|
3946
|
+
# Specifies the storage type to be associated with the read replica.
|
3932
3947
|
#
|
3933
3948
|
# Valid values: `standard | gp2 | io1`
|
3934
3949
|
#
|
@@ -3938,12 +3953,12 @@ module Aws::RDS
|
|
3938
3953
|
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
3939
3954
|
#
|
3940
3955
|
# @option params [Boolean] :copy_tags_to_snapshot
|
3941
|
-
# A value that indicates whether to copy all tags from the
|
3942
|
-
# to snapshots of the
|
3956
|
+
# A value that indicates whether to copy all tags from the read replica
|
3957
|
+
# to snapshots of the read replica. By default, tags are not copied.
|
3943
3958
|
#
|
3944
3959
|
# @option params [Integer] :monitoring_interval
|
3945
3960
|
# The interval, in seconds, between points when Enhanced Monitoring
|
3946
|
-
# metrics are collected for the
|
3961
|
+
# metrics are collected for the read replica. To disable collecting
|
3947
3962
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
3948
3963
|
#
|
3949
3964
|
# If `MonitoringRoleArn` is specified, then you must also set
|
@@ -3966,22 +3981,22 @@ module Aws::RDS
|
|
3966
3981
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
3967
3982
|
#
|
3968
3983
|
# @option params [String] :kms_key_id
|
3969
|
-
# The AWS KMS key ID for an encrypted
|
3984
|
+
# The AWS KMS key ID for an encrypted read replica. The KMS key ID is
|
3970
3985
|
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
3971
3986
|
# alias for the KMS encryption key.
|
3972
3987
|
#
|
3973
|
-
# If you create an encrypted
|
3988
|
+
# If you create an encrypted read replica in the same AWS Region as the
|
3974
3989
|
# source DB instance, then you do not have to specify a value for this
|
3975
|
-
# parameter. The
|
3990
|
+
# parameter. The read replica is encrypted with the same KMS key as the
|
3976
3991
|
# source DB instance.
|
3977
3992
|
#
|
3978
|
-
# If you create an encrypted
|
3993
|
+
# If you create an encrypted read replica in a different AWS Region,
|
3979
3994
|
# then you must specify a KMS key for the destination AWS Region. KMS
|
3980
3995
|
# encryption keys are specific to the AWS Region that they are created
|
3981
3996
|
# in, and you can't use encryption keys from one AWS Region in another
|
3982
3997
|
# AWS Region.
|
3983
3998
|
#
|
3984
|
-
# You can't create an encrypted
|
3999
|
+
# You can't create an encrypted read replica from an unencrypted DB
|
3985
4000
|
# instance.
|
3986
4001
|
#
|
3987
4002
|
# @option params [String] :pre_signed_url
|
@@ -3989,9 +4004,9 @@ module Aws::RDS
|
|
3989
4004
|
# `CreateDBInstanceReadReplica` API action in the source AWS Region that
|
3990
4005
|
# contains the source DB instance.
|
3991
4006
|
#
|
3992
|
-
# You must specify this parameter when you create an encrypted
|
3993
|
-
#
|
3994
|
-
# specify `PreSignedUrl` when you are creating an encrypted
|
4007
|
+
# You must specify this parameter when you create an encrypted read
|
4008
|
+
# replica from another AWS Region by using the Amazon RDS API. Don't
|
4009
|
+
# specify `PreSignedUrl` when you are creating an encrypted read replica
|
3995
4010
|
# in the same AWS Region.
|
3996
4011
|
#
|
3997
4012
|
# The presigned URL must be a valid request for the
|
@@ -3999,7 +4014,7 @@ module Aws::RDS
|
|
3999
4014
|
# source AWS Region that contains the encrypted source DB instance. The
|
4000
4015
|
# presigned URL request must contain the following parameter values:
|
4001
4016
|
#
|
4002
|
-
# * `DestinationRegion` - The AWS Region that the encrypted
|
4017
|
+
# * `DestinationRegion` - The AWS Region that the encrypted read replica
|
4003
4018
|
# is created in. This AWS Region is the same one where the
|
4004
4019
|
# `CreateDBInstanceReadReplica` action is called that contains this
|
4005
4020
|
# presigned URL.
|
@@ -4013,7 +4028,7 @@ module Aws::RDS
|
|
4013
4028
|
# presigned URL must be set to the us-east-1 AWS Region.
|
4014
4029
|
#
|
4015
4030
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
4016
|
-
# encrypt the
|
4031
|
+
# encrypt the read replica in the destination AWS Region. This is the
|
4017
4032
|
# same identifier for both the `CreateDBInstanceReadReplica` action
|
4018
4033
|
# that is called in the destination AWS Region, and the action
|
4019
4034
|
# contained in the presigned URL.
|
@@ -4021,7 +4036,7 @@ module Aws::RDS
|
|
4021
4036
|
# * `SourceDBInstanceIdentifier` - The DB instance identifier for the
|
4022
4037
|
# encrypted DB instance to be replicated. This identifier must be in
|
4023
4038
|
# the Amazon Resource Name (ARN) format for the source AWS Region. For
|
4024
|
-
# example, if you are creating an encrypted
|
4039
|
+
# example, if you are creating an encrypted read replica from a DB
|
4025
4040
|
# instance in the us-west-2 AWS Region, then your
|
4026
4041
|
# `SourceDBInstanceIdentifier` looks like the following example:
|
4027
4042
|
# `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
|
@@ -4033,9 +4048,12 @@ module Aws::RDS
|
|
4033
4048
|
# <note markdown="1"> If you are using an AWS SDK tool or the AWS CLI, you can specify
|
4034
4049
|
# `SourceRegion` (or `--source-region` for the AWS CLI) instead of
|
4035
4050
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
4036
|
-
# autogenerates a
|
4051
|
+
# autogenerates a presigned URL that is a valid request for the
|
4037
4052
|
# operation that can be executed in the source AWS Region.
|
4038
4053
|
#
|
4054
|
+
# `SourceRegion` isn't supported for SQL Server, because SQL Server on
|
4055
|
+
# Amazon RDS doesn't support cross-region read replicas.
|
4056
|
+
#
|
4039
4057
|
# </note>
|
4040
4058
|
#
|
4041
4059
|
#
|
@@ -4059,7 +4077,7 @@ module Aws::RDS
|
|
4059
4077
|
#
|
4060
4078
|
# @option params [Boolean] :enable_performance_insights
|
4061
4079
|
# A value that indicates whether to enable Performance Insights for the
|
4062
|
-
#
|
4080
|
+
# read replica.
|
4063
4081
|
#
|
4064
4082
|
# For more information, see [Using Amazon Performance Insights][1] in
|
4065
4083
|
# the *Amazon RDS User Guide*.
|
@@ -4118,9 +4136,16 @@ module Aws::RDS
|
|
4118
4136
|
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
4119
4137
|
# Oracle][1] in the *Amazon RDS User Guide*.
|
4120
4138
|
#
|
4139
|
+
# For Microsoft SQL Server DB instances, Amazon RDS can use Windows
|
4140
|
+
# Authentication to authenticate users that connect to the DB instance.
|
4141
|
+
# For more information, see [ Using Windows Authentication with an
|
4142
|
+
# Amazon RDS DB Instance Running Microsoft SQL Server][2] in the *Amazon
|
4143
|
+
# RDS User Guide*.
|
4144
|
+
#
|
4121
4145
|
#
|
4122
4146
|
#
|
4123
4147
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
4148
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
4124
4149
|
#
|
4125
4150
|
# @option params [String] :domain_iam_role_name
|
4126
4151
|
# Specify the name of the IAM role to be used when making API calls to
|
@@ -4465,9 +4490,8 @@ module Aws::RDS
|
|
4465
4490
|
# @option params [required, String] :engine_family
|
4466
4491
|
# The kinds of databases that the proxy can connect to. This value
|
4467
4492
|
# determines which database network protocol the proxy recognizes when
|
4468
|
-
# it interprets network traffic to and from the database.
|
4469
|
-
#
|
4470
|
-
# MySQL and Aurora MySQL.
|
4493
|
+
# it interprets network traffic to and from the database. The engine
|
4494
|
+
# family applies to MySQL and PostgreSQL for both RDS and Aurora.
|
4471
4495
|
#
|
4472
4496
|
# @option params [required, Array<Types::UserAuthConfig>] :auth
|
4473
4497
|
# The authorization mechanism that the proxy uses.
|
@@ -4513,7 +4537,7 @@ module Aws::RDS
|
|
4513
4537
|
#
|
4514
4538
|
# resp = client.create_db_proxy({
|
4515
4539
|
# db_proxy_name: "String", # required
|
4516
|
-
# engine_family: "MYSQL", # required, accepts MYSQL
|
4540
|
+
# engine_family: "MYSQL", # required, accepts MYSQL, POSTGRESQL
|
4517
4541
|
# auth: [ # required
|
4518
4542
|
# {
|
4519
4543
|
# description: "String",
|
@@ -4541,7 +4565,7 @@ module Aws::RDS
|
|
4541
4565
|
#
|
4542
4566
|
# resp.db_proxy.db_proxy_name #=> String
|
4543
4567
|
# resp.db_proxy.db_proxy_arn #=> String
|
4544
|
-
# resp.db_proxy.status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting"
|
4568
|
+
# resp.db_proxy.status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting", "suspended", "suspending", "reactivating"
|
4545
4569
|
# resp.db_proxy.engine_family #=> String
|
4546
4570
|
# resp.db_proxy.vpc_security_group_ids #=> Array
|
4547
4571
|
# resp.db_proxy.vpc_security_group_ids[0] #=> String
|
@@ -5631,14 +5655,14 @@ module Aws::RDS
|
|
5631
5655
|
# you can't delete the DB instance if both of the following conditions
|
5632
5656
|
# are true:
|
5633
5657
|
#
|
5634
|
-
# * The DB cluster is a
|
5658
|
+
# * The DB cluster is a read replica of another Amazon Aurora DB
|
5635
5659
|
# cluster.
|
5636
5660
|
#
|
5637
5661
|
# * The DB instance is the only instance in the DB cluster.
|
5638
5662
|
#
|
5639
5663
|
# To delete a DB instance in this case, first call the
|
5640
5664
|
# `PromoteReadReplicaDBCluster` API action to promote the DB cluster so
|
5641
|
-
# it's no longer a
|
5665
|
+
# it's no longer a read replica. After the promotion completes, then
|
5642
5666
|
# call the `DeleteDBInstance` API action to delete the final instance in
|
5643
5667
|
# the DB cluster.
|
5644
5668
|
#
|
@@ -5663,7 +5687,7 @@ module Aws::RDS
|
|
5663
5687
|
# 'failed', 'incompatible-restore', or 'incompatible-network', it
|
5664
5688
|
# can only be deleted when skip is specified.
|
5665
5689
|
#
|
5666
|
-
# Specify skip when deleting a
|
5690
|
+
# Specify skip when deleting a read replica.
|
5667
5691
|
#
|
5668
5692
|
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip
|
5669
5693
|
# isn't specified.
|
@@ -5687,7 +5711,7 @@ module Aws::RDS
|
|
5687
5711
|
#
|
5688
5712
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
5689
5713
|
#
|
5690
|
-
# * Can't be specified when deleting a
|
5714
|
+
# * Can't be specified when deleting a read replica.
|
5691
5715
|
#
|
5692
5716
|
# @option params [Boolean] :delete_automated_backups
|
5693
5717
|
# A value that indicates whether to remove automated backups immediately
|
@@ -5966,7 +5990,7 @@ module Aws::RDS
|
|
5966
5990
|
#
|
5967
5991
|
# resp.db_proxy.db_proxy_name #=> String
|
5968
5992
|
# resp.db_proxy.db_proxy_arn #=> String
|
5969
|
-
# resp.db_proxy.status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting"
|
5993
|
+
# resp.db_proxy.status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting", "suspended", "suspending", "reactivating"
|
5970
5994
|
# resp.db_proxy.engine_family #=> String
|
5971
5995
|
# resp.db_proxy.vpc_security_group_ids #=> Array
|
5972
5996
|
# resp.db_proxy.vpc_security_group_ids[0] #=> String
|
@@ -6559,6 +6583,8 @@ module Aws::RDS
|
|
6559
6583
|
# * {Types::CustomAvailabilityZoneMessage#marker #marker} => String
|
6560
6584
|
# * {Types::CustomAvailabilityZoneMessage#custom_availability_zones #custom_availability_zones} => Array<Types::CustomAvailabilityZone>
|
6561
6585
|
#
|
6586
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6587
|
+
#
|
6562
6588
|
# @example Request syntax with placeholder values
|
6563
6589
|
#
|
6564
6590
|
# resp = client.describe_custom_availability_zones({
|
@@ -7254,6 +7280,12 @@ module Aws::RDS
|
|
7254
7280
|
# resp.db_cluster_snapshots[0].source_db_cluster_snapshot_arn #=> String
|
7255
7281
|
# resp.db_cluster_snapshots[0].iam_database_authentication_enabled #=> Boolean
|
7256
7282
|
#
|
7283
|
+
#
|
7284
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
7285
|
+
#
|
7286
|
+
# * db_cluster_snapshot_available
|
7287
|
+
# * db_cluster_snapshot_deleted
|
7288
|
+
#
|
7257
7289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterSnapshots AWS API Documentation
|
7258
7290
|
#
|
7259
7291
|
# @overload describe_db_cluster_snapshots(params = {})
|
@@ -7325,6 +7357,8 @@ module Aws::RDS
|
|
7325
7357
|
# * {Types::DBClusterMessage#marker #marker} => String
|
7326
7358
|
# * {Types::DBClusterMessage#db_clusters #db_clusters} => Array<Types::DBCluster>
|
7327
7359
|
#
|
7360
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7361
|
+
#
|
7328
7362
|
#
|
7329
7363
|
# @example Example: To list DB clusters
|
7330
7364
|
#
|
@@ -7510,6 +7544,8 @@ module Aws::RDS
|
|
7510
7544
|
# * {Types::DBEngineVersionMessage#marker #marker} => String
|
7511
7545
|
# * {Types::DBEngineVersionMessage#db_engine_versions #db_engine_versions} => Array<Types::DBEngineVersion>
|
7512
7546
|
#
|
7547
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7548
|
+
#
|
7513
7549
|
#
|
7514
7550
|
# @example Example: To list DB engine version settings
|
7515
7551
|
#
|
@@ -7650,6 +7686,8 @@ module Aws::RDS
|
|
7650
7686
|
# * {Types::DBInstanceAutomatedBackupMessage#marker #marker} => String
|
7651
7687
|
# * {Types::DBInstanceAutomatedBackupMessage#db_instance_automated_backups #db_instance_automated_backups} => Array<Types::DBInstanceAutomatedBackup>
|
7652
7688
|
#
|
7689
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7690
|
+
#
|
7653
7691
|
# @example Request syntax with placeholder values
|
7654
7692
|
#
|
7655
7693
|
# resp = client.describe_db_instance_automated_backups({
|
@@ -7768,6 +7806,8 @@ module Aws::RDS
|
|
7768
7806
|
# * {Types::DBInstanceMessage#marker #marker} => String
|
7769
7807
|
# * {Types::DBInstanceMessage#db_instances #db_instances} => Array<Types::DBInstance>
|
7770
7808
|
#
|
7809
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7810
|
+
#
|
7771
7811
|
#
|
7772
7812
|
# @example Example: To list DB instance settings
|
7773
7813
|
#
|
@@ -7913,6 +7953,12 @@ module Aws::RDS
|
|
7913
7953
|
# resp.db_instances[0].listener_endpoint.hosted_zone_id #=> String
|
7914
7954
|
# resp.db_instances[0].max_allocated_storage #=> Integer
|
7915
7955
|
#
|
7956
|
+
#
|
7957
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
7958
|
+
#
|
7959
|
+
# * db_instance_available
|
7960
|
+
# * db_instance_deleted
|
7961
|
+
#
|
7916
7962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstances AWS API Documentation
|
7917
7963
|
#
|
7918
7964
|
# @overload describe_db_instances(params = {})
|
@@ -7965,6 +8011,8 @@ module Aws::RDS
|
|
7965
8011
|
# * {Types::DescribeDBLogFilesResponse#describe_db_log_files #describe_db_log_files} => Array<Types::DescribeDBLogFilesDetails>
|
7966
8012
|
# * {Types::DescribeDBLogFilesResponse#marker #marker} => String
|
7967
8013
|
#
|
8014
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8015
|
+
#
|
7968
8016
|
#
|
7969
8017
|
# @example Example: To list DB log file names
|
7970
8018
|
#
|
@@ -8054,6 +8102,8 @@ module Aws::RDS
|
|
8054
8102
|
# * {Types::DBParameterGroupsMessage#marker #marker} => String
|
8055
8103
|
# * {Types::DBParameterGroupsMessage#db_parameter_groups #db_parameter_groups} => Array<Types::DBParameterGroup>
|
8056
8104
|
#
|
8105
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8106
|
+
#
|
8057
8107
|
#
|
8058
8108
|
# @example Example: To list information about DB parameter groups
|
8059
8109
|
#
|
@@ -8142,6 +8192,8 @@ module Aws::RDS
|
|
8142
8192
|
# * {Types::DBParameterGroupDetails#parameters #parameters} => Array<Types::Parameter>
|
8143
8193
|
# * {Types::DBParameterGroupDetails#marker #marker} => String
|
8144
8194
|
#
|
8195
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8196
|
+
#
|
8145
8197
|
#
|
8146
8198
|
# @example Example: To list information about DB parameters
|
8147
8199
|
#
|
@@ -8231,6 +8283,8 @@ module Aws::RDS
|
|
8231
8283
|
# * {Types::DescribeDBProxiesResponse#db_proxies #db_proxies} => Array<Types::DBProxy>
|
8232
8284
|
# * {Types::DescribeDBProxiesResponse#marker #marker} => String
|
8233
8285
|
#
|
8286
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8287
|
+
#
|
8234
8288
|
# @example Request syntax with placeholder values
|
8235
8289
|
#
|
8236
8290
|
# resp = client.describe_db_proxies({
|
@@ -8250,7 +8304,7 @@ module Aws::RDS
|
|
8250
8304
|
# resp.db_proxies #=> Array
|
8251
8305
|
# resp.db_proxies[0].db_proxy_name #=> String
|
8252
8306
|
# resp.db_proxies[0].db_proxy_arn #=> String
|
8253
|
-
# resp.db_proxies[0].status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting"
|
8307
|
+
# resp.db_proxies[0].status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting", "suspended", "suspending", "reactivating"
|
8254
8308
|
# resp.db_proxies[0].engine_family #=> String
|
8255
8309
|
# resp.db_proxies[0].vpc_security_group_ids #=> Array
|
8256
8310
|
# resp.db_proxies[0].vpc_security_group_ids[0] #=> String
|
@@ -8317,6 +8371,8 @@ module Aws::RDS
|
|
8317
8371
|
# * {Types::DescribeDBProxyTargetGroupsResponse#target_groups #target_groups} => Array<Types::DBProxyTargetGroup>
|
8318
8372
|
# * {Types::DescribeDBProxyTargetGroupsResponse#marker #marker} => String
|
8319
8373
|
#
|
8374
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8375
|
+
#
|
8320
8376
|
# @example Request syntax with placeholder values
|
8321
8377
|
#
|
8322
8378
|
# resp = client.describe_db_proxy_target_groups({
|
@@ -8396,6 +8452,8 @@ module Aws::RDS
|
|
8396
8452
|
# * {Types::DescribeDBProxyTargetsResponse#targets #targets} => Array<Types::DBProxyTarget>
|
8397
8453
|
# * {Types::DescribeDBProxyTargetsResponse#marker #marker} => String
|
8398
8454
|
#
|
8455
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8456
|
+
#
|
8399
8457
|
# @example Request syntax with placeholder values
|
8400
8458
|
#
|
8401
8459
|
# resp = client.describe_db_proxy_targets({
|
@@ -8420,6 +8478,9 @@ module Aws::RDS
|
|
8420
8478
|
# resp.targets[0].rds_resource_id #=> String
|
8421
8479
|
# resp.targets[0].port #=> Integer
|
8422
8480
|
# resp.targets[0].type #=> String, one of "RDS_INSTANCE", "RDS_SERVERLESS_ENDPOINT", "TRACKED_CLUSTER"
|
8481
|
+
# resp.targets[0].target_health.state #=> String, one of "REGISTERING", "AVAILABLE", "UNAVAILABLE"
|
8482
|
+
# resp.targets[0].target_health.reason #=> String, one of "UNREACHABLE", "CONNECTION_FAILED", "AUTH_FAILURE", "PENDING_PROXY_CAPACITY"
|
8483
|
+
# resp.targets[0].target_health.description #=> String
|
8423
8484
|
# resp.marker #=> String
|
8424
8485
|
#
|
8425
8486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargets AWS API Documentation
|
@@ -8462,6 +8523,8 @@ module Aws::RDS
|
|
8462
8523
|
# * {Types::DBSecurityGroupMessage#marker #marker} => String
|
8463
8524
|
# * {Types::DBSecurityGroupMessage#db_security_groups #db_security_groups} => Array<Types::DBSecurityGroup>
|
8464
8525
|
#
|
8526
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8527
|
+
#
|
8465
8528
|
#
|
8466
8529
|
# @example Example: To list DB security group settings
|
8467
8530
|
#
|
@@ -8699,6 +8762,8 @@ module Aws::RDS
|
|
8699
8762
|
# * {Types::DBSnapshotMessage#marker #marker} => String
|
8700
8763
|
# * {Types::DBSnapshotMessage#db_snapshots #db_snapshots} => Array<Types::DBSnapshot>
|
8701
8764
|
#
|
8765
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8766
|
+
#
|
8702
8767
|
#
|
8703
8768
|
# @example Example: To list DB snapshot attributes
|
8704
8769
|
#
|
@@ -8769,6 +8834,12 @@ module Aws::RDS
|
|
8769
8834
|
# resp.db_snapshots[0].processor_features[0].value #=> String
|
8770
8835
|
# resp.db_snapshots[0].dbi_resource_id #=> String
|
8771
8836
|
#
|
8837
|
+
#
|
8838
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
8839
|
+
#
|
8840
|
+
# * db_snapshot_available
|
8841
|
+
# * db_snapshot_deleted
|
8842
|
+
#
|
8772
8843
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshots AWS API Documentation
|
8773
8844
|
#
|
8774
8845
|
# @overload describe_db_snapshots(params = {})
|
@@ -8815,6 +8886,8 @@ module Aws::RDS
|
|
8815
8886
|
# * {Types::DBSubnetGroupMessage#marker #marker} => String
|
8816
8887
|
# * {Types::DBSubnetGroupMessage#db_subnet_groups #db_subnet_groups} => Array<Types::DBSubnetGroup>
|
8817
8888
|
#
|
8889
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8890
|
+
#
|
8818
8891
|
#
|
8819
8892
|
# @example Example: To list information about DB subnet groups
|
8820
8893
|
#
|
@@ -8987,6 +9060,8 @@ module Aws::RDS
|
|
8987
9060
|
#
|
8988
9061
|
# * {Types::DescribeEngineDefaultParametersResult#engine_defaults #engine_defaults} => Types::EngineDefaults
|
8989
9062
|
#
|
9063
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9064
|
+
#
|
8990
9065
|
#
|
8991
9066
|
# @example Example: To list default parameters for a DB engine
|
8992
9067
|
#
|
@@ -9141,6 +9216,8 @@ module Aws::RDS
|
|
9141
9216
|
# * {Types::EventSubscriptionsMessage#marker #marker} => String
|
9142
9217
|
# * {Types::EventSubscriptionsMessage#event_subscriptions_list #event_subscriptions_list} => Array<Types::EventSubscription>
|
9143
9218
|
#
|
9219
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9220
|
+
#
|
9144
9221
|
#
|
9145
9222
|
# @example Example: To list information about DB event notification subscriptions
|
9146
9223
|
#
|
@@ -9280,6 +9357,8 @@ module Aws::RDS
|
|
9280
9357
|
# * {Types::EventsMessage#marker #marker} => String
|
9281
9358
|
# * {Types::EventsMessage#events #events} => Array<Types::Event>
|
9282
9359
|
#
|
9360
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9361
|
+
#
|
9283
9362
|
#
|
9284
9363
|
# @example Example: To list information about events
|
9285
9364
|
#
|
@@ -9386,6 +9465,8 @@ module Aws::RDS
|
|
9386
9465
|
# * {Types::ExportTasksMessage#marker #marker} => String
|
9387
9466
|
# * {Types::ExportTasksMessage#export_tasks #export_tasks} => Array<Types::ExportTask>
|
9388
9467
|
#
|
9468
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9469
|
+
#
|
9389
9470
|
# @example Request syntax with placeholder values
|
9390
9471
|
#
|
9391
9472
|
# resp = client.describe_export_tasks({
|
@@ -9488,6 +9569,8 @@ module Aws::RDS
|
|
9488
9569
|
# * {Types::GlobalClustersMessage#marker #marker} => String
|
9489
9570
|
# * {Types::GlobalClustersMessage#global_clusters #global_clusters} => Array<Types::GlobalCluster>
|
9490
9571
|
#
|
9572
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9573
|
+
#
|
9491
9574
|
# @example Request syntax with placeholder values
|
9492
9575
|
#
|
9493
9576
|
# resp = client.describe_global_clusters({
|
@@ -9568,6 +9651,8 @@ module Aws::RDS
|
|
9568
9651
|
# * {Types::InstallationMediaMessage#marker #marker} => String
|
9569
9652
|
# * {Types::InstallationMediaMessage#installation_media #installation_media} => Array<Types::InstallationMedia>
|
9570
9653
|
#
|
9654
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9655
|
+
#
|
9571
9656
|
# @example Request syntax with placeholder values
|
9572
9657
|
#
|
9573
9658
|
# resp = client.describe_installation_media({
|
@@ -9637,6 +9722,8 @@ module Aws::RDS
|
|
9637
9722
|
# * {Types::OptionGroupOptionsMessage#option_group_options #option_group_options} => Array<Types::OptionGroupOption>
|
9638
9723
|
# * {Types::OptionGroupOptionsMessage#marker #marker} => String
|
9639
9724
|
#
|
9725
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9726
|
+
#
|
9640
9727
|
#
|
9641
9728
|
# @example Example: To list information about DB option group options
|
9642
9729
|
#
|
@@ -9749,6 +9836,8 @@ module Aws::RDS
|
|
9749
9836
|
# * {Types::OptionGroups#option_groups_list #option_groups_list} => Array<Types::OptionGroup>
|
9750
9837
|
# * {Types::OptionGroups#marker #marker} => String
|
9751
9838
|
#
|
9839
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9840
|
+
#
|
9752
9841
|
#
|
9753
9842
|
# @example Example: To list information about DB option groups
|
9754
9843
|
#
|
@@ -9841,6 +9930,14 @@ module Aws::RDS
|
|
9841
9930
|
# The license model filter value. Specify this parameter to show only
|
9842
9931
|
# the available offerings matching the specified license model.
|
9843
9932
|
#
|
9933
|
+
# @option params [String] :availability_zone_group
|
9934
|
+
# The Availability Zone group associated with a Local Zone. Specify this
|
9935
|
+
# parameter to retrieve available offerings for the Local Zones in the
|
9936
|
+
# group.
|
9937
|
+
#
|
9938
|
+
# Omit this parameter to show the available offerings in the specified
|
9939
|
+
# AWS Region.
|
9940
|
+
#
|
9844
9941
|
# @option params [Boolean] :vpc
|
9845
9942
|
# A value that indicates whether to show only VPC or non-VPC offerings.
|
9846
9943
|
#
|
@@ -9868,6 +9965,8 @@ module Aws::RDS
|
|
9868
9965
|
# * {Types::OrderableDBInstanceOptionsMessage#orderable_db_instance_options #orderable_db_instance_options} => Array<Types::OrderableDBInstanceOption>
|
9869
9966
|
# * {Types::OrderableDBInstanceOptionsMessage#marker #marker} => String
|
9870
9967
|
#
|
9968
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9969
|
+
#
|
9871
9970
|
#
|
9872
9971
|
# @example Example: To list information about orderable DB instance options
|
9873
9972
|
#
|
@@ -9893,6 +9992,7 @@ module Aws::RDS
|
|
9893
9992
|
# engine_version: "String",
|
9894
9993
|
# db_instance_class: "String",
|
9895
9994
|
# license_model: "String",
|
9995
|
+
# availability_zone_group: "String",
|
9896
9996
|
# vpc: false,
|
9897
9997
|
# filters: [
|
9898
9998
|
# {
|
@@ -9911,6 +10011,7 @@ module Aws::RDS
|
|
9911
10011
|
# resp.orderable_db_instance_options[0].engine_version #=> String
|
9912
10012
|
# resp.orderable_db_instance_options[0].db_instance_class #=> String
|
9913
10013
|
# resp.orderable_db_instance_options[0].license_model #=> String
|
10014
|
+
# resp.orderable_db_instance_options[0].availability_zone_group #=> String
|
9914
10015
|
# resp.orderable_db_instance_options[0].availability_zones #=> Array
|
9915
10016
|
# resp.orderable_db_instance_options[0].availability_zones[0].name #=> String
|
9916
10017
|
# resp.orderable_db_instance_options[0].multi_az_capable #=> Boolean
|
@@ -10107,6 +10208,8 @@ module Aws::RDS
|
|
10107
10208
|
# * {Types::ReservedDBInstanceMessage#marker #marker} => String
|
10108
10209
|
# * {Types::ReservedDBInstanceMessage#reserved_db_instances #reserved_db_instances} => Array<Types::ReservedDBInstance>
|
10109
10210
|
#
|
10211
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
10212
|
+
#
|
10110
10213
|
#
|
10111
10214
|
# @example Example: To list information about reserved DB instances
|
10112
10215
|
#
|
@@ -10239,6 +10342,8 @@ module Aws::RDS
|
|
10239
10342
|
# * {Types::ReservedDBInstancesOfferingMessage#marker #marker} => String
|
10240
10343
|
# * {Types::ReservedDBInstancesOfferingMessage#reserved_db_instances_offerings #reserved_db_instances_offerings} => Array<Types::ReservedDBInstancesOffering>
|
10241
10344
|
#
|
10345
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
10346
|
+
#
|
10242
10347
|
#
|
10243
10348
|
# @example Example: To list information about reserved DB instance offerings
|
10244
10349
|
#
|
@@ -10303,7 +10408,7 @@ module Aws::RDS
|
|
10303
10408
|
end
|
10304
10409
|
|
10305
10410
|
# Returns a list of the source AWS Regions where the current AWS Region
|
10306
|
-
# can create a
|
10411
|
+
# can create a read replica or copy a DB snapshot from. This API action
|
10307
10412
|
# supports pagination.
|
10308
10413
|
#
|
10309
10414
|
# @option params [String] :region_name
|
@@ -10534,6 +10639,8 @@ module Aws::RDS
|
|
10534
10639
|
# * {Types::DownloadDBLogFilePortionDetails#marker #marker} => String
|
10535
10640
|
# * {Types::DownloadDBLogFilePortionDetails#additional_data_pending #additional_data_pending} => Boolean
|
10536
10641
|
#
|
10642
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
10643
|
+
#
|
10537
10644
|
#
|
10538
10645
|
# @example Example: To list information about DB log files
|
10539
10646
|
#
|
@@ -11956,13 +12063,13 @@ module Aws::RDS
|
|
11956
12063
|
#
|
11957
12064
|
# * Must be a value from 0 to 35
|
11958
12065
|
#
|
11959
|
-
# * Can be specified for a MySQL
|
12066
|
+
# * Can be specified for a MySQL read replica only if the source is
|
11960
12067
|
# running MySQL 5.6 or later
|
11961
12068
|
#
|
11962
|
-
# * Can be specified for a PostgreSQL
|
12069
|
+
# * Can be specified for a PostgreSQL read replica only if the source is
|
11963
12070
|
# running PostgreSQL 9.3.5
|
11964
12071
|
#
|
11965
|
-
# * Can't be set to 0 if the DB instance is a source to
|
12072
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas
|
11966
12073
|
#
|
11967
12074
|
# @option params [String] :preferred_backup_window
|
11968
12075
|
# The daily time range during which automated backups are created if
|
@@ -12073,7 +12180,7 @@ module Aws::RDS
|
|
12073
12180
|
# performance degradation. While the migration takes place, nightly
|
12074
12181
|
# backups for the instance are suspended. No other Amazon RDS operations
|
12075
12182
|
# can take place for the instance, including modifying the instance,
|
12076
|
-
# rebooting the instance, deleting the instance, creating a
|
12183
|
+
# rebooting the instance, deleting the instance, creating a read replica
|
12077
12184
|
# for the instance, and creating a DB snapshot of the instance.
|
12078
12185
|
#
|
12079
12186
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value
|
@@ -12133,7 +12240,7 @@ module Aws::RDS
|
|
12133
12240
|
# performance degradation. While the migration takes place, nightly
|
12134
12241
|
# backups for the instance are suspended. No other Amazon RDS operations
|
12135
12242
|
# can take place for the instance, including modifying the instance,
|
12136
|
-
# rebooting the instance, deleting the instance, creating a
|
12243
|
+
# rebooting the instance, deleting the instance, creating a read replica
|
12137
12244
|
# for the instance, and creating a DB snapshot of the instance.
|
12138
12245
|
#
|
12139
12246
|
# Valid values: `standard | gp2 | io1`
|
@@ -12209,19 +12316,19 @@ module Aws::RDS
|
|
12209
12316
|
#
|
12210
12317
|
# Default: `3306`
|
12211
12318
|
#
|
12212
|
-
# Valid
|
12319
|
+
# Valid values: `1150-65535`
|
12213
12320
|
#
|
12214
12321
|
# **MariaDB**
|
12215
12322
|
#
|
12216
12323
|
# Default: `3306`
|
12217
12324
|
#
|
12218
|
-
# Valid
|
12325
|
+
# Valid values: `1150-65535`
|
12219
12326
|
#
|
12220
12327
|
# **PostgreSQL**
|
12221
12328
|
#
|
12222
12329
|
# Default: `5432`
|
12223
12330
|
#
|
12224
|
-
# Valid
|
12331
|
+
# Valid values: `1150-65535`
|
12225
12332
|
#
|
12226
12333
|
# Type: Integer
|
12227
12334
|
#
|
@@ -12229,20 +12336,20 @@ module Aws::RDS
|
|
12229
12336
|
#
|
12230
12337
|
# Default: `1521`
|
12231
12338
|
#
|
12232
|
-
# Valid
|
12339
|
+
# Valid values: `1150-65535`
|
12233
12340
|
#
|
12234
12341
|
# **SQL Server**
|
12235
12342
|
#
|
12236
12343
|
# Default: `1433`
|
12237
12344
|
#
|
12238
|
-
# Valid
|
12239
|
-
# `
|
12345
|
+
# Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
|
12346
|
+
# `3389`, `47001`, and `49152-49156`.
|
12240
12347
|
#
|
12241
12348
|
# **Amazon Aurora**
|
12242
12349
|
#
|
12243
12350
|
# Default: `3306`
|
12244
12351
|
#
|
12245
|
-
# Valid
|
12352
|
+
# Valid values: `1150-65535`
|
12246
12353
|
#
|
12247
12354
|
# @option params [Boolean] :publicly_accessible
|
12248
12355
|
# A value that indicates whether the DB instance is publicly accessible.
|
@@ -12778,7 +12885,7 @@ module Aws::RDS
|
|
12778
12885
|
#
|
12779
12886
|
# resp.db_proxy.db_proxy_name #=> String
|
12780
12887
|
# resp.db_proxy.db_proxy_arn #=> String
|
12781
|
-
# resp.db_proxy.status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting"
|
12888
|
+
# resp.db_proxy.status #=> String, one of "available", "modifying", "incompatible-network", "insufficient-resource-limits", "creating", "deleting", "suspended", "suspending", "reactivating"
|
12782
12889
|
# resp.db_proxy.engine_family #=> String
|
12783
12890
|
# resp.db_proxy.vpc_security_group_ids #=> Array
|
12784
12891
|
# resp.db_proxy.vpc_security_group_ids[0] #=> String
|
@@ -12874,8 +12981,8 @@ module Aws::RDS
|
|
12874
12981
|
req.send_request(options)
|
12875
12982
|
end
|
12876
12983
|
|
12877
|
-
# Updates a manual DB snapshot
|
12878
|
-
#
|
12984
|
+
# Updates a manual DB snapshot with a new engine version. The snapshot
|
12985
|
+
# can be encrypted or unencrypted, but not shared or public.
|
12879
12986
|
#
|
12880
12987
|
# Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and
|
12881
12988
|
# PostgreSQL.
|
@@ -13454,16 +13561,16 @@ module Aws::RDS
|
|
13454
13561
|
req.send_request(options)
|
13455
13562
|
end
|
13456
13563
|
|
13457
|
-
# Promotes a
|
13564
|
+
# Promotes a read replica DB instance to a standalone DB instance.
|
13458
13565
|
#
|
13459
13566
|
# <note markdown="1"> * Backup duration is a function of the amount of changes to the
|
13460
|
-
# database since the previous backup. If you plan to promote a
|
13461
|
-
#
|
13567
|
+
# database since the previous backup. If you plan to promote a read
|
13568
|
+
# replica to a standalone instance, we recommend that you enable
|
13462
13569
|
# backups and complete at least one backup prior to promotion. In
|
13463
|
-
# addition, a
|
13570
|
+
# addition, a read replica cannot be promoted to a standalone instance
|
13464
13571
|
# when it is in the `backing-up` status. If you have enabled backups
|
13465
|
-
# on your
|
13466
|
-
# daily backups do not interfere with
|
13572
|
+
# on your read replica, configure the automated backup window so that
|
13573
|
+
# daily backups do not interfere with read replica promotion.
|
13467
13574
|
#
|
13468
13575
|
# * This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
|
13469
13576
|
#
|
@@ -13475,7 +13582,7 @@ module Aws::RDS
|
|
13475
13582
|
#
|
13476
13583
|
# Constraints:
|
13477
13584
|
#
|
13478
|
-
# * Must match the identifier of an existing
|
13585
|
+
# * Must match the identifier of an existing read replica DB instance.
|
13479
13586
|
#
|
13480
13587
|
# ^
|
13481
13588
|
#
|
@@ -13492,7 +13599,7 @@ module Aws::RDS
|
|
13492
13599
|
#
|
13493
13600
|
# * Must be a value from 0 to 35.
|
13494
13601
|
#
|
13495
|
-
# * Can't be set to 0 if the DB instance is a source to
|
13602
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas.
|
13496
13603
|
#
|
13497
13604
|
# @option params [String] :preferred_backup_window
|
13498
13605
|
# The daily time range during which automated backups are created if
|
@@ -13672,19 +13779,19 @@ module Aws::RDS
|
|
13672
13779
|
req.send_request(options)
|
13673
13780
|
end
|
13674
13781
|
|
13675
|
-
# Promotes a
|
13782
|
+
# Promotes a read replica DB cluster to a standalone DB cluster.
|
13676
13783
|
#
|
13677
13784
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
13678
13785
|
#
|
13679
13786
|
# </note>
|
13680
13787
|
#
|
13681
13788
|
# @option params [required, String] :db_cluster_identifier
|
13682
|
-
# The identifier of the DB cluster
|
13789
|
+
# The identifier of the DB cluster read replica to promote. This
|
13683
13790
|
# parameter isn't case-sensitive.
|
13684
13791
|
#
|
13685
13792
|
# Constraints:
|
13686
13793
|
#
|
13687
|
-
# * Must match the identifier of an existing
|
13794
|
+
# * Must match the identifier of an existing DB cluster read replica.
|
13688
13795
|
#
|
13689
13796
|
# ^
|
13690
13797
|
#
|
@@ -14104,6 +14211,9 @@ module Aws::RDS
|
|
14104
14211
|
# resp.db_proxy_targets[0].rds_resource_id #=> String
|
14105
14212
|
# resp.db_proxy_targets[0].port #=> Integer
|
14106
14213
|
# resp.db_proxy_targets[0].type #=> String, one of "RDS_INSTANCE", "RDS_SERVERLESS_ENDPOINT", "TRACKED_CLUSTER"
|
14214
|
+
# resp.db_proxy_targets[0].target_health.state #=> String, one of "REGISTERING", "AVAILABLE", "UNAVAILABLE"
|
14215
|
+
# resp.db_proxy_targets[0].target_health.reason #=> String, one of "UNREACHABLE", "CONNECTION_FAILED", "AUTH_FAILURE", "PENDING_PROXY_CAPACITY"
|
14216
|
+
# resp.db_proxy_targets[0].target_health.description #=> String
|
14107
14217
|
#
|
14108
14218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RegisterDBProxyTargets AWS API Documentation
|
14109
14219
|
#
|
@@ -14562,6 +14672,18 @@ module Aws::RDS
|
|
14562
14672
|
# described in [ Migrating Data to an Amazon Aurora MySQL DB Cluster][1]
|
14563
14673
|
# in the *Amazon Aurora User Guide*.
|
14564
14674
|
#
|
14675
|
+
# <note markdown="1"> This action only restores the DB cluster, not the DB instances for
|
14676
|
+
# that DB cluster. You must invoke the `CreateDBInstance` action to
|
14677
|
+
# create DB instances for the restored DB cluster, specifying the
|
14678
|
+
# identifier of the restored DB cluster in `DBClusterIdentifier`. You
|
14679
|
+
# can create DB instances only after the `RestoreDBClusterFromS3` action
|
14680
|
+
# has completed and the DB cluster is available.
|
14681
|
+
#
|
14682
|
+
# </note>
|
14683
|
+
#
|
14684
|
+
# For more information on Amazon Aurora, see [ What Is Amazon
|
14685
|
+
# Aurora?][2] in the *Amazon Aurora User Guide.*
|
14686
|
+
#
|
14565
14687
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
14566
14688
|
#
|
14567
14689
|
# </note>
|
@@ -14569,6 +14691,7 @@ module Aws::RDS
|
|
14569
14691
|
#
|
14570
14692
|
#
|
14571
14693
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.html
|
14694
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
14572
14695
|
#
|
14573
14696
|
# @option params [Array<String>] :availability_zones
|
14574
14697
|
# A list of Availability Zones (AZs) where instances in the restored DB
|
@@ -14846,12 +14969,12 @@ module Aws::RDS
|
|
14846
14969
|
#
|
14847
14970
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
14848
14971
|
# Authentication to authenticate users that connect to the DB cluster.
|
14849
|
-
# For more information, see [
|
14850
|
-
#
|
14972
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
14973
|
+
# Aurora User Guide*.
|
14851
14974
|
#
|
14852
14975
|
#
|
14853
14976
|
#
|
14854
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
14977
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
14855
14978
|
#
|
14856
14979
|
# @option params [String] :domain_iam_role_name
|
14857
14980
|
# Specify the name of the IAM role to be used when making API calls to
|
@@ -14990,16 +15113,20 @@ module Aws::RDS
|
|
14990
15113
|
end
|
14991
15114
|
|
14992
15115
|
# Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
15116
|
+
# This action only applies to Aurora DB clusters.
|
14993
15117
|
#
|
14994
|
-
#
|
14995
|
-
#
|
14996
|
-
# security group.
|
15118
|
+
# The target DB cluster is created from the source snapshot with a
|
15119
|
+
# default configuration. If you don't specify a security group, the new
|
15120
|
+
# DB cluster is associated with the default security group.
|
14997
15121
|
#
|
14998
|
-
#
|
14999
|
-
#
|
15000
|
-
#
|
15001
|
-
#
|
15002
|
-
#
|
15122
|
+
# <note markdown="1"> This action only restores the DB cluster, not the DB instances for
|
15123
|
+
# that DB cluster. You must invoke the `CreateDBInstance` action to
|
15124
|
+
# create DB instances for the restored DB cluster, specifying the
|
15125
|
+
# identifier of the restored DB cluster in `DBClusterIdentifier`. You
|
15126
|
+
# can create DB instances only after the `RestoreDBClusterFromSnapshot`
|
15127
|
+
# action has completed and the DB cluster is available.
|
15128
|
+
#
|
15129
|
+
# </note>
|
15003
15130
|
#
|
15004
15131
|
# For more information on Amazon Aurora, see [ What Is Amazon
|
15005
15132
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
@@ -15572,12 +15699,12 @@ module Aws::RDS
|
|
15572
15699
|
#
|
15573
15700
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
15574
15701
|
# Authentication to authenticate users that connect to the DB cluster.
|
15575
|
-
# For more information, see [
|
15576
|
-
#
|
15702
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
15703
|
+
# Aurora User Guide*.
|
15577
15704
|
#
|
15578
15705
|
#
|
15579
15706
|
#
|
15580
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
15707
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
15581
15708
|
#
|
15582
15709
|
# @option params [String] :domain_iam_role_name
|
15583
15710
|
# Specify the name of the IAM role to be used when making API calls to
|
@@ -17874,17 +18001,19 @@ module Aws::RDS
|
|
17874
18001
|
# provided, all the snapshot data is exported. Valid values are the
|
17875
18002
|
# following:
|
17876
18003
|
#
|
17877
|
-
# * `database` - Export all the data
|
18004
|
+
# * `database` - Export all the data from a specified database.
|
17878
18005
|
#
|
17879
|
-
# * `database.table
|
18006
|
+
# * `database.table` *table-name* - Export a table of the snapshot. This
|
18007
|
+
# format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora
|
18008
|
+
# MySQL.
|
17880
18009
|
#
|
17881
|
-
# * `database.schema
|
17882
|
-
# snapshot. This
|
17883
|
-
#
|
18010
|
+
# * `database.schema` *schema-name* - Export a database schema of the
|
18011
|
+
# snapshot. This format is valid only for RDS for PostgreSQL and
|
18012
|
+
# Aurora PostgreSQL.
|
17884
18013
|
#
|
17885
|
-
# * `database.schema.table
|
17886
|
-
# database schema. This
|
17887
|
-
#
|
18014
|
+
# * `database.schema.table` *table-name* - Export a table of the
|
18015
|
+
# database schema. This format is valid only for RDS for PostgreSQL
|
18016
|
+
# and Aurora PostgreSQL.
|
17888
18017
|
#
|
17889
18018
|
# @return [Types::ExportTask] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
17890
18019
|
#
|
@@ -18284,7 +18413,7 @@ module Aws::RDS
|
|
18284
18413
|
params: params,
|
18285
18414
|
config: config)
|
18286
18415
|
context[:gem_name] = 'aws-sdk-rds'
|
18287
|
-
context[:gem_version] = '1.
|
18416
|
+
context[:gem_version] = '1.85.0'
|
18288
18417
|
Seahorse::Client::Request.new(handlers, context)
|
18289
18418
|
end
|
18290
18419
|
|
@@ -18350,14 +18479,14 @@ module Aws::RDS
|
|
18350
18479
|
# The following table lists the valid waiter names, the operations they call,
|
18351
18480
|
# and the default `:delay` and `:max_attempts` values.
|
18352
18481
|
#
|
18353
|
-
# | waiter_name | params
|
18354
|
-
# | ----------------------------- |
|
18355
|
-
# | db_cluster_snapshot_available | {#describe_db_cluster_snapshots} | 30 | 60 |
|
18356
|
-
# | db_cluster_snapshot_deleted | {#describe_db_cluster_snapshots} | 30 | 60 |
|
18357
|
-
# | db_instance_available | {#describe_db_instances} | 30 | 60 |
|
18358
|
-
# | db_instance_deleted | {#describe_db_instances} | 30 | 60 |
|
18359
|
-
# | db_snapshot_available | {#describe_db_snapshots} | 30 | 60 |
|
18360
|
-
# | db_snapshot_deleted | {#describe_db_snapshots} | 30 | 60 |
|
18482
|
+
# | waiter_name | params | :delay | :max_attempts |
|
18483
|
+
# | ----------------------------- | -------------------------------------- | -------- | ------------- |
|
18484
|
+
# | db_cluster_snapshot_available | {Client#describe_db_cluster_snapshots} | 30 | 60 |
|
18485
|
+
# | db_cluster_snapshot_deleted | {Client#describe_db_cluster_snapshots} | 30 | 60 |
|
18486
|
+
# | db_instance_available | {Client#describe_db_instances} | 30 | 60 |
|
18487
|
+
# | db_instance_deleted | {Client#describe_db_instances} | 30 | 60 |
|
18488
|
+
# | db_snapshot_available | {Client#describe_db_snapshots} | 30 | 60 |
|
18489
|
+
# | db_snapshot_deleted | {Client#describe_db_snapshots} | 30 | 60 |
|
18361
18490
|
#
|
18362
18491
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
18363
18492
|
# because the waiter has entered a state that it will not transition
|