aws-sdk-rds 1.80.0 → 1.81.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 +231 -136
- 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 +174 -118
- data/lib/aws-sdk-rds/waiters.rb +66 -0
- metadata +3 -3
@@ -27,10 +27,13 @@ module Aws
|
|
27
27
|
|
28
28
|
# To create a auth login token, following parameters are required:
|
29
29
|
#
|
30
|
-
# @
|
31
|
-
# @params [required, String] :
|
30
|
+
# @param [Hash] params The parameters for auth token creation.
|
31
|
+
# @option params [required, String] :region Region where the database
|
32
|
+
# is located.
|
33
|
+
# @option params [required, String] :endpoint Hostname of the database
|
34
|
+
# with a port number.
|
32
35
|
# For example: my-instance.us-west-2.rds.amazonaws.com:3306
|
33
|
-
# @params [required, String] :user_name Username to login as
|
36
|
+
# @option params [required, String] :user_name Username to login as
|
34
37
|
#
|
35
38
|
# @return [String]
|
36
39
|
def auth_token(params)
|
@@ -195,13 +195,13 @@ module Aws::RDS
|
|
195
195
|
end
|
196
196
|
|
197
197
|
# Contains the identifier of the source DB cluster if this DB cluster is
|
198
|
-
# a
|
198
|
+
# a read replica.
|
199
199
|
# @return [String]
|
200
200
|
def replication_source_identifier
|
201
201
|
data[:replication_source_identifier]
|
202
202
|
end
|
203
203
|
|
204
|
-
# Contains one or more identifiers of the
|
204
|
+
# Contains one or more identifiers of the read replicas associated with
|
205
205
|
# this DB cluster.
|
206
206
|
# @return [Array<String>]
|
207
207
|
def read_replica_identifiers
|
@@ -334,6 +334,15 @@ module Aws::RDS
|
|
334
334
|
|
335
335
|
# The DB engine mode of the DB cluster, either `provisioned`,
|
336
336
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
337
|
+
#
|
338
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters created
|
339
|
+
# with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions,
|
340
|
+
# the clusters in a global database use `provisioned` engine mode. To
|
341
|
+
# check if a DB cluster is part of a global database, use
|
342
|
+
# `DescribeGlobalClusters` instead of checking the `EngineMode` return
|
343
|
+
# value from `DescribeDBClusters`.
|
344
|
+
#
|
345
|
+
# </note>
|
337
346
|
# @return [String]
|
338
347
|
def engine_mode
|
339
348
|
data[:engine_mode]
|
@@ -469,7 +478,8 @@ module Aws::RDS
|
|
469
478
|
# Waiter polls an API operation until a resource enters a desired
|
470
479
|
# state.
|
471
480
|
#
|
472
|
-
# @note The waiting operation is performed on a copy. The original resource
|
481
|
+
# @note The waiting operation is performed on a copy. The original resource
|
482
|
+
# remains unchanged.
|
473
483
|
#
|
474
484
|
# ## Basic Usage
|
475
485
|
#
|
@@ -482,13 +492,15 @@ module Aws::RDS
|
|
482
492
|
#
|
483
493
|
# ## Example
|
484
494
|
#
|
485
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
495
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
496
|
+
# instance.state.name == 'running'
|
497
|
+
# end
|
486
498
|
#
|
487
499
|
# ## Configuration
|
488
500
|
#
|
489
501
|
# You can configure the maximum number of polling attempts, and the
|
490
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
491
|
-
# by passing a block to {#wait_until}:
|
502
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
503
|
+
# set by passing a block to {#wait_until}:
|
492
504
|
#
|
493
505
|
# # poll for ~25 seconds
|
494
506
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -519,17 +531,16 @@ module Aws::RDS
|
|
519
531
|
# # resource did not enter the desired state in time
|
520
532
|
# end
|
521
533
|
#
|
534
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
522
535
|
#
|
523
|
-
# @
|
524
|
-
#
|
525
|
-
#
|
526
|
-
# because the waiter has entered a state that it will not transition
|
527
|
-
# out of, preventing success.
|
536
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
537
|
+
# terminates because the waiter has entered a state that it will not
|
538
|
+
# transition out of, preventing success.
|
528
539
|
#
|
529
540
|
# yet successful.
|
530
541
|
#
|
531
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
532
|
-
# while polling for a resource that is not expected.
|
542
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
543
|
+
# encountered while polling for a resource that is not expected.
|
533
544
|
#
|
534
545
|
# @raise [NotImplementedError] Raised when the resource does not
|
535
546
|
#
|
@@ -761,7 +772,7 @@ module Aws::RDS
|
|
761
772
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
762
773
|
# @option options [String] :replication_source_identifier
|
763
774
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
764
|
-
# if this DB cluster is created as a
|
775
|
+
# if this DB cluster is created as a read replica.
|
765
776
|
# @option options [Array<Types::Tag>] :tags
|
766
777
|
# Tags to assign to the DB cluster.
|
767
778
|
# @option options [Boolean] :storage_encrypted
|
@@ -789,9 +800,9 @@ module Aws::RDS
|
|
789
800
|
# AWS account has a different default encryption key for each AWS
|
790
801
|
# Region.
|
791
802
|
#
|
792
|
-
# If you create a
|
803
|
+
# If you create a read replica of an encrypted DB cluster in another AWS
|
793
804
|
# Region, you must set `KmsKeyId` to a KMS key ID that is valid in the
|
794
|
-
# destination AWS Region. This key is used to encrypt the
|
805
|
+
# destination AWS Region. This key is used to encrypt the read replica
|
795
806
|
# in that AWS Region.
|
796
807
|
# @option options [String] :pre_signed_url
|
797
808
|
# A URL that contains a Signature Version 4 signed request for the
|
@@ -813,8 +824,8 @@ module Aws::RDS
|
|
813
824
|
# action that is called in the destination AWS Region, and the action
|
814
825
|
# contained in the pre-signed URL.
|
815
826
|
#
|
816
|
-
# * `DestinationRegion` - The name of the AWS Region that Aurora
|
817
|
-
#
|
827
|
+
# * `DestinationRegion` - The name of the AWS Region that Aurora read
|
828
|
+
# replica will be created in.
|
818
829
|
#
|
819
830
|
# * `ReplicationSourceIdentifier` - The DB cluster identifier for the
|
820
831
|
# encrypted DB cluster to be copied. This identifier must be in the
|
@@ -876,6 +887,12 @@ module Aws::RDS
|
|
876
887
|
# The DB engine mode of the DB cluster, either `provisioned`,
|
877
888
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
878
889
|
#
|
890
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters created
|
891
|
+
# with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions,
|
892
|
+
# the clusters in a global database use `provisioned` engine mode.
|
893
|
+
#
|
894
|
+
# </note>
|
895
|
+
#
|
879
896
|
# Limitations and requirements apply to some DB engine modes. For more
|
880
897
|
# information, see the following sections in the *Amazon Aurora User
|
881
898
|
# Guide*\:
|
@@ -928,12 +945,12 @@ module Aws::RDS
|
|
928
945
|
#
|
929
946
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
930
947
|
# Authentication to authenticate users that connect to the DB cluster.
|
931
|
-
# For more information, see [
|
932
|
-
#
|
948
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
949
|
+
# Aurora User Guide*.
|
933
950
|
#
|
934
951
|
#
|
935
952
|
#
|
936
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
953
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
937
954
|
# @option options [String] :domain_iam_role_name
|
938
955
|
# Specify the name of the IAM role to be used when making API calls to
|
939
956
|
# the Directory Service.
|
@@ -1517,12 +1534,12 @@ module Aws::RDS
|
|
1517
1534
|
#
|
1518
1535
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
1519
1536
|
# Authentication to authenticate users that connect to the DB cluster.
|
1520
|
-
# For more information, see [
|
1521
|
-
#
|
1537
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
1538
|
+
# Aurora User Guide*.
|
1522
1539
|
#
|
1523
1540
|
#
|
1524
1541
|
#
|
1525
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
1542
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
1526
1543
|
# @option options [String] :domain_iam_role_name
|
1527
1544
|
# Specify the name of the IAM role to be used when making API calls to
|
1528
1545
|
# the Directory Service.
|
@@ -93,7 +93,8 @@ module Aws::RDS
|
|
93
93
|
# Waiter polls an API operation until a resource enters a desired
|
94
94
|
# state.
|
95
95
|
#
|
96
|
-
# @note The waiting operation is performed on a copy. The original resource
|
96
|
+
# @note The waiting operation is performed on a copy. The original resource
|
97
|
+
# remains unchanged.
|
97
98
|
#
|
98
99
|
# ## Basic Usage
|
99
100
|
#
|
@@ -106,13 +107,15 @@ module Aws::RDS
|
|
106
107
|
#
|
107
108
|
# ## Example
|
108
109
|
#
|
109
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
110
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
111
|
+
# instance.state.name == 'running'
|
112
|
+
# end
|
110
113
|
#
|
111
114
|
# ## Configuration
|
112
115
|
#
|
113
116
|
# You can configure the maximum number of polling attempts, and the
|
114
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
115
|
-
# by passing a block to {#wait_until}:
|
117
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
118
|
+
# set by passing a block to {#wait_until}:
|
116
119
|
#
|
117
120
|
# # poll for ~25 seconds
|
118
121
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -143,17 +146,16 @@ module Aws::RDS
|
|
143
146
|
# # resource did not enter the desired state in time
|
144
147
|
# end
|
145
148
|
#
|
149
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
146
150
|
#
|
147
|
-
# @
|
148
|
-
#
|
149
|
-
#
|
150
|
-
# because the waiter has entered a state that it will not transition
|
151
|
-
# out of, preventing success.
|
151
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
152
|
+
# terminates because the waiter has entered a state that it will not
|
153
|
+
# transition out of, preventing success.
|
152
154
|
#
|
153
155
|
# yet successful.
|
154
156
|
#
|
155
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
156
|
-
# while polling for a resource that is not expected.
|
157
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
158
|
+
# encountered while polling for a resource that is not expected.
|
157
159
|
#
|
158
160
|
# @raise [NotImplementedError] Raised when the resource does not
|
159
161
|
#
|
@@ -200,7 +200,8 @@ module Aws::RDS
|
|
200
200
|
# Waiter polls an API operation until a resource enters a desired
|
201
201
|
# state.
|
202
202
|
#
|
203
|
-
# @note The waiting operation is performed on a copy. The original resource
|
203
|
+
# @note The waiting operation is performed on a copy. The original resource
|
204
|
+
# remains unchanged.
|
204
205
|
#
|
205
206
|
# ## Basic Usage
|
206
207
|
#
|
@@ -213,13 +214,15 @@ module Aws::RDS
|
|
213
214
|
#
|
214
215
|
# ## Example
|
215
216
|
#
|
216
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
217
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
218
|
+
# instance.state.name == 'running'
|
219
|
+
# end
|
217
220
|
#
|
218
221
|
# ## Configuration
|
219
222
|
#
|
220
223
|
# You can configure the maximum number of polling attempts, and the
|
221
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
222
|
-
# by passing a block to {#wait_until}:
|
224
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
225
|
+
# set by passing a block to {#wait_until}:
|
223
226
|
#
|
224
227
|
# # poll for ~25 seconds
|
225
228
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -250,17 +253,16 @@ module Aws::RDS
|
|
250
253
|
# # resource did not enter the desired state in time
|
251
254
|
# end
|
252
255
|
#
|
256
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
253
257
|
#
|
254
|
-
# @
|
255
|
-
#
|
256
|
-
#
|
257
|
-
# because the waiter has entered a state that it will not transition
|
258
|
-
# out of, preventing success.
|
258
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
259
|
+
# terminates because the waiter has entered a state that it will not
|
260
|
+
# transition out of, preventing success.
|
259
261
|
#
|
260
262
|
# yet successful.
|
261
263
|
#
|
262
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
263
|
-
# while polling for a resource that is not expected.
|
264
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
265
|
+
# encountered while polling for a resource that is not expected.
|
264
266
|
#
|
265
267
|
# @raise [NotImplementedError] Raised when the resource does not
|
266
268
|
#
|
@@ -381,7 +383,7 @@ module Aws::RDS
|
|
381
383
|
# encrypted DB cluster snapshot in the same AWS Region.
|
382
384
|
#
|
383
385
|
# The pre-signed URL must be a valid request for the
|
384
|
-
# `
|
386
|
+
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
385
387
|
# AWS Region that contains the encrypted DB cluster snapshot to be
|
386
388
|
# copied. The pre-signed URL request must contain the following
|
387
389
|
# parameter values:
|
@@ -65,7 +65,8 @@ module Aws::RDS
|
|
65
65
|
# Waiter polls an API operation until a resource enters a desired
|
66
66
|
# state.
|
67
67
|
#
|
68
|
-
# @note The waiting operation is performed on a copy. The original resource
|
68
|
+
# @note The waiting operation is performed on a copy. The original resource
|
69
|
+
# remains unchanged.
|
69
70
|
#
|
70
71
|
# ## Basic Usage
|
71
72
|
#
|
@@ -78,13 +79,15 @@ module Aws::RDS
|
|
78
79
|
#
|
79
80
|
# ## Example
|
80
81
|
#
|
81
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
82
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
83
|
+
# instance.state.name == 'running'
|
84
|
+
# end
|
82
85
|
#
|
83
86
|
# ## Configuration
|
84
87
|
#
|
85
88
|
# You can configure the maximum number of polling attempts, and the
|
86
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
87
|
-
# by passing a block to {#wait_until}:
|
89
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
90
|
+
# set by passing a block to {#wait_until}:
|
88
91
|
#
|
89
92
|
# # poll for ~25 seconds
|
90
93
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -115,17 +118,16 @@ module Aws::RDS
|
|
115
118
|
# # resource did not enter the desired state in time
|
116
119
|
# end
|
117
120
|
#
|
121
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
118
122
|
#
|
119
|
-
# @
|
120
|
-
#
|
121
|
-
#
|
122
|
-
# because the waiter has entered a state that it will not transition
|
123
|
-
# out of, preventing success.
|
123
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
124
|
+
# terminates because the waiter has entered a state that it will not
|
125
|
+
# transition out of, preventing success.
|
124
126
|
#
|
125
127
|
# yet successful.
|
126
128
|
#
|
127
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
128
|
-
# while polling for a resource that is not expected.
|
129
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
130
|
+
# encountered while polling for a resource that is not expected.
|
129
131
|
#
|
130
132
|
# @raise [NotImplementedError] Raised when the resource does not
|
131
133
|
#
|
@@ -103,13 +103,19 @@ module Aws::RDS
|
|
103
103
|
data[:supports_log_exports_to_cloudwatch_logs]
|
104
104
|
end
|
105
105
|
|
106
|
-
# Indicates whether the database engine version supports
|
106
|
+
# Indicates whether the database engine version supports read replicas.
|
107
107
|
# @return [Boolean]
|
108
108
|
def supports_read_replica
|
109
109
|
data[:supports_read_replica]
|
110
110
|
end
|
111
111
|
|
112
112
|
# A list of the supported DB engine modes.
|
113
|
+
#
|
114
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters created
|
115
|
+
# with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions,
|
116
|
+
# the clusters in a global database use `provisioned` engine mode.
|
117
|
+
#
|
118
|
+
# </note>
|
113
119
|
# @return [Array<String>]
|
114
120
|
def supported_engine_modes
|
115
121
|
data[:supported_engine_modes]
|
@@ -176,7 +182,8 @@ module Aws::RDS
|
|
176
182
|
# Waiter polls an API operation until a resource enters a desired
|
177
183
|
# state.
|
178
184
|
#
|
179
|
-
# @note The waiting operation is performed on a copy. The original resource
|
185
|
+
# @note The waiting operation is performed on a copy. The original resource
|
186
|
+
# remains unchanged.
|
180
187
|
#
|
181
188
|
# ## Basic Usage
|
182
189
|
#
|
@@ -189,13 +196,15 @@ module Aws::RDS
|
|
189
196
|
#
|
190
197
|
# ## Example
|
191
198
|
#
|
192
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
199
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
200
|
+
# instance.state.name == 'running'
|
201
|
+
# end
|
193
202
|
#
|
194
203
|
# ## Configuration
|
195
204
|
#
|
196
205
|
# You can configure the maximum number of polling attempts, and the
|
197
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
198
|
-
# by passing a block to {#wait_until}:
|
206
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
207
|
+
# set by passing a block to {#wait_until}:
|
199
208
|
#
|
200
209
|
# # poll for ~25 seconds
|
201
210
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -226,17 +235,16 @@ module Aws::RDS
|
|
226
235
|
# # resource did not enter the desired state in time
|
227
236
|
# end
|
228
237
|
#
|
238
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
229
239
|
#
|
230
|
-
# @
|
231
|
-
#
|
232
|
-
#
|
233
|
-
# because the waiter has entered a state that it will not transition
|
234
|
-
# out of, preventing success.
|
240
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
241
|
+
# terminates because the waiter has entered a state that it will not
|
242
|
+
# transition out of, preventing success.
|
235
243
|
#
|
236
244
|
# yet successful.
|
237
245
|
#
|
238
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
239
|
-
# while polling for a resource that is not expected.
|
246
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
247
|
+
# encountered while polling for a resource that is not expected.
|
240
248
|
#
|
241
249
|
# @raise [NotImplementedError] Raised when the resource does not
|
242
250
|
#
|
@@ -48,6 +48,13 @@ module Aws::RDS
|
|
48
48
|
end
|
49
49
|
|
50
50
|
# Specifies the current state of this database.
|
51
|
+
#
|
52
|
+
# For information about DB instance statuses, see [DB Instance
|
53
|
+
# Status][1] in the *Amazon RDS User Guide.*
|
54
|
+
#
|
55
|
+
#
|
56
|
+
#
|
57
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Status.html
|
51
58
|
# @return [String]
|
52
59
|
def db_instance_status
|
53
60
|
data[:db_instance_status]
|
@@ -189,13 +196,13 @@ module Aws::RDS
|
|
189
196
|
end
|
190
197
|
|
191
198
|
# Contains the identifier of the source DB instance if this DB instance
|
192
|
-
# is a
|
199
|
+
# is a read replica.
|
193
200
|
# @return [String]
|
194
201
|
def read_replica_source_db_instance_identifier
|
195
202
|
data[:read_replica_source_db_instance_identifier]
|
196
203
|
end
|
197
204
|
|
198
|
-
# Contains one or more identifiers of the
|
205
|
+
# Contains one or more identifiers of the read replicas associated with
|
199
206
|
# this DB instance.
|
200
207
|
# @return [Array<String>]
|
201
208
|
def read_replica_db_instance_identifiers
|
@@ -203,12 +210,12 @@ module Aws::RDS
|
|
203
210
|
end
|
204
211
|
|
205
212
|
# Contains one or more identifiers of Aurora DB clusters to which the
|
206
|
-
# RDS DB instance is replicated as a
|
207
|
-
# create an Aurora
|
208
|
-
# MySQL DB cluster for the Aurora
|
209
|
-
# does not contain information about cross region Aurora
|
213
|
+
# RDS DB instance is replicated as a read replica. For example, when you
|
214
|
+
# create an Aurora read replica of an RDS MySQL DB instance, the Aurora
|
215
|
+
# MySQL DB cluster for the Aurora read replica is shown. This output
|
216
|
+
# does not contain information about cross region Aurora read replicas.
|
210
217
|
#
|
211
|
-
# <note markdown="1"> Currently, each RDS DB instance can have only one Aurora
|
218
|
+
# <note markdown="1"> Currently, each RDS DB instance can have only one Aurora read replica.
|
212
219
|
#
|
213
220
|
# </note>
|
214
221
|
# @return [Array<String>]
|
@@ -258,7 +265,7 @@ module Aws::RDS
|
|
258
265
|
data[:publicly_accessible]
|
259
266
|
end
|
260
267
|
|
261
|
-
# The status of a
|
268
|
+
# The status of a read replica. If the instance isn't a read replica,
|
262
269
|
# this is blank.
|
263
270
|
# @return [Array<Types::DBInstanceStatusInfo>]
|
264
271
|
def status_infos
|
@@ -522,7 +529,8 @@ module Aws::RDS
|
|
522
529
|
# Waiter polls an API operation until a resource enters a desired
|
523
530
|
# state.
|
524
531
|
#
|
525
|
-
# @note The waiting operation is performed on a copy. The original resource
|
532
|
+
# @note The waiting operation is performed on a copy. The original resource
|
533
|
+
# remains unchanged.
|
526
534
|
#
|
527
535
|
# ## Basic Usage
|
528
536
|
#
|
@@ -535,13 +543,15 @@ module Aws::RDS
|
|
535
543
|
#
|
536
544
|
# ## Example
|
537
545
|
#
|
538
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
546
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
547
|
+
# instance.state.name == 'running'
|
548
|
+
# end
|
539
549
|
#
|
540
550
|
# ## Configuration
|
541
551
|
#
|
542
552
|
# You can configure the maximum number of polling attempts, and the
|
543
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
544
|
-
# by passing a block to {#wait_until}:
|
553
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
554
|
+
# set by passing a block to {#wait_until}:
|
545
555
|
#
|
546
556
|
# # poll for ~25 seconds
|
547
557
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -572,17 +582,16 @@ module Aws::RDS
|
|
572
582
|
# # resource did not enter the desired state in time
|
573
583
|
# end
|
574
584
|
#
|
585
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
575
586
|
#
|
576
|
-
# @
|
577
|
-
#
|
578
|
-
#
|
579
|
-
# because the waiter has entered a state that it will not transition
|
580
|
-
# out of, preventing success.
|
587
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
588
|
+
# terminates because the waiter has entered a state that it will not
|
589
|
+
# transition out of, preventing success.
|
581
590
|
#
|
582
591
|
# yet successful.
|
583
592
|
#
|
584
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
585
|
-
# while polling for a resource that is not expected.
|
593
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
594
|
+
# encountered while polling for a resource that is not expected.
|
586
595
|
#
|
587
596
|
# @raise [NotImplementedError] Raised when the resource does not
|
588
597
|
#
|
@@ -1063,7 +1072,7 @@ module Aws::RDS
|
|
1063
1072
|
#
|
1064
1073
|
# * Must be a value from 0 to 35
|
1065
1074
|
#
|
1066
|
-
# * Can't be set to 0 if the DB instance is a source to
|
1075
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas
|
1067
1076
|
# @option options [String] :preferred_backup_window
|
1068
1077
|
# The daily time range during which automated backups are created if
|
1069
1078
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1101,7 +1110,7 @@ module Aws::RDS
|
|
1101
1110
|
#
|
1102
1111
|
# Default: `3306`
|
1103
1112
|
#
|
1104
|
-
# Valid
|
1113
|
+
# Valid values: `1150-65535`
|
1105
1114
|
#
|
1106
1115
|
# Type: Integer
|
1107
1116
|
#
|
@@ -1109,7 +1118,7 @@ module Aws::RDS
|
|
1109
1118
|
#
|
1110
1119
|
# Default: `3306`
|
1111
1120
|
#
|
1112
|
-
# Valid
|
1121
|
+
# Valid values: `1150-65535`
|
1113
1122
|
#
|
1114
1123
|
# Type: Integer
|
1115
1124
|
#
|
@@ -1117,7 +1126,7 @@ module Aws::RDS
|
|
1117
1126
|
#
|
1118
1127
|
# Default: `5432`
|
1119
1128
|
#
|
1120
|
-
# Valid
|
1129
|
+
# Valid values: `1150-65535`
|
1121
1130
|
#
|
1122
1131
|
# Type: Integer
|
1123
1132
|
#
|
@@ -1125,20 +1134,20 @@ module Aws::RDS
|
|
1125
1134
|
#
|
1126
1135
|
# Default: `1521`
|
1127
1136
|
#
|
1128
|
-
# Valid
|
1137
|
+
# Valid values: `1150-65535`
|
1129
1138
|
#
|
1130
1139
|
# **SQL Server**
|
1131
1140
|
#
|
1132
1141
|
# Default: `1433`
|
1133
1142
|
#
|
1134
|
-
# Valid
|
1135
|
-
# `
|
1143
|
+
# Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
|
1144
|
+
# `3389`, `47001`, and `49152-49156`.
|
1136
1145
|
#
|
1137
1146
|
# **Amazon Aurora**
|
1138
1147
|
#
|
1139
1148
|
# Default: `3306`
|
1140
1149
|
#
|
1141
|
-
# Valid
|
1150
|
+
# Valid values: `1150-65535`
|
1142
1151
|
#
|
1143
1152
|
# Type: Integer
|
1144
1153
|
# @option options [Boolean] :multi_az
|
@@ -1315,15 +1324,13 @@ module Aws::RDS
|
|
1315
1324
|
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
1316
1325
|
# RDS User Guide*.
|
1317
1326
|
#
|
1318
|
-
# For Oracle DB
|
1327
|
+
# For Oracle DB instances, Amazon RDS can use Kerberos Authentication to
|
1319
1328
|
# authenticate users that connect to the DB instance. For more
|
1320
1329
|
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
1321
1330
|
# Oracle][2] in the *Amazon RDS User Guide*.
|
1322
1331
|
#
|
1323
1332
|
#
|
1324
1333
|
#
|
1325
|
-
#
|
1326
|
-
#
|
1327
1334
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
1328
1335
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
1329
1336
|
# @option options [Boolean] :copy_tags_to_snapshot
|
@@ -1526,11 +1533,11 @@ module Aws::RDS
|
|
1526
1533
|
# })
|
1527
1534
|
# @param [Hash] options ({})
|
1528
1535
|
# @option options [required, String] :db_instance_identifier
|
1529
|
-
# The DB instance identifier of the
|
1536
|
+
# The DB instance identifier of the read replica. This identifier is the
|
1530
1537
|
# unique key that identifies a DB instance. This parameter is stored as
|
1531
1538
|
# a lowercase string.
|
1532
1539
|
# @option options [String] :db_instance_class
|
1533
|
-
# The compute and memory capacity of the
|
1540
|
+
# The compute and memory capacity of the read replica, for example,
|
1534
1541
|
# `db.m4.large`. Not all DB instance classes are available in all AWS
|
1535
1542
|
# Regions, or for all database engines. For the full list of DB instance
|
1536
1543
|
# classes, and availability for your engine, see [DB Instance Class][1]
|
@@ -1542,7 +1549,7 @@ module Aws::RDS
|
|
1542
1549
|
#
|
1543
1550
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
1544
1551
|
# @option options [String] :availability_zone
|
1545
|
-
# The Availability Zone (AZ) where the
|
1552
|
+
# The Availability Zone (AZ) where the read replica will be created.
|
1546
1553
|
#
|
1547
1554
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1548
1555
|
# AWS Region.
|
@@ -1555,17 +1562,17 @@ module Aws::RDS
|
|
1555
1562
|
#
|
1556
1563
|
# Valid Values: `1150-65535`
|
1557
1564
|
# @option options [Boolean] :multi_az
|
1558
|
-
# A value that indicates whether the
|
1565
|
+
# A value that indicates whether the read replica is in a Multi-AZ
|
1559
1566
|
# deployment.
|
1560
1567
|
#
|
1561
|
-
# You can create a
|
1568
|
+
# You can create a read replica as a Multi-AZ DB instance. RDS creates a
|
1562
1569
|
# standby of your replica in another Availability Zone for failover
|
1563
|
-
# support for the replica. Creating your
|
1570
|
+
# support for the replica. Creating your read replica as a Multi-AZ DB
|
1564
1571
|
# instance is independent of whether the source database is a Multi-AZ
|
1565
1572
|
# DB instance.
|
1566
1573
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1567
1574
|
# A value that indicates whether minor engine upgrades are applied
|
1568
|
-
# automatically to the
|
1575
|
+
# automatically to the read replica during the maintenance window.
|
1569
1576
|
#
|
1570
1577
|
# Default: Inherits from the source DB instance
|
1571
1578
|
# @option options [Integer] :iops
|
@@ -1574,13 +1581,18 @@ module Aws::RDS
|
|
1574
1581
|
# @option options [String] :option_group_name
|
1575
1582
|
# The option group the DB instance is associated with. If omitted, the
|
1576
1583
|
# option group associated with the source instance is used.
|
1584
|
+
#
|
1585
|
+
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
1586
|
+
# source instance.
|
1587
|
+
#
|
1588
|
+
# </note>
|
1577
1589
|
# @option options [String] :db_parameter_group_name
|
1578
1590
|
# The name of the DB parameter group to associate with this DB instance.
|
1579
1591
|
#
|
1580
1592
|
# If you do not specify a value for `DBParameterGroupName`, then Amazon
|
1581
1593
|
# RDS uses the `DBParameterGroup` of source DB instance for a same
|
1582
|
-
# region
|
1583
|
-
# specified DB engine for a cross region
|
1594
|
+
# region read replica, or the default `DBParameterGroup` for the
|
1595
|
+
# specified DB engine for a cross region read replica.
|
1584
1596
|
#
|
1585
1597
|
# <note markdown="1"> Currently, specifying a parameter group for this operation is only
|
1586
1598
|
# supported for Oracle DB instances.
|
@@ -1624,23 +1636,23 @@ module Aws::RDS
|
|
1624
1636
|
# * The specified DB subnet group must be in the same AWS Region in
|
1625
1637
|
# which the operation is running.
|
1626
1638
|
#
|
1627
|
-
# * All
|
1639
|
+
# * All read replicas in one AWS Region that are created from the same
|
1628
1640
|
# source DB instance must either:>
|
1629
1641
|
#
|
1630
|
-
# * Specify DB subnet groups from the same VPC. All these
|
1631
|
-
#
|
1642
|
+
# * Specify DB subnet groups from the same VPC. All these read
|
1643
|
+
# replicas are created in the same VPC.
|
1632
1644
|
#
|
1633
|
-
# * Not specify a DB subnet group. All these
|
1645
|
+
# * Not specify a DB subnet group. All these read replicas are created
|
1634
1646
|
# outside of any VPC.
|
1635
1647
|
#
|
1636
1648
|
# Example: `mySubnetgroup`
|
1637
1649
|
# @option options [Array<String>] :vpc_security_group_ids
|
1638
|
-
# A list of EC2 VPC security groups to associate with the
|
1650
|
+
# A list of EC2 VPC security groups to associate with the read replica.
|
1639
1651
|
#
|
1640
1652
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
1641
1653
|
# VPC.
|
1642
1654
|
# @option options [String] :storage_type
|
1643
|
-
# Specifies the storage type to be associated with the
|
1655
|
+
# Specifies the storage type to be associated with the read replica.
|
1644
1656
|
#
|
1645
1657
|
# Valid values: `standard | gp2 | io1`
|
1646
1658
|
#
|
@@ -1649,11 +1661,11 @@ module Aws::RDS
|
|
1649
1661
|
#
|
1650
1662
|
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1651
1663
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1652
|
-
# A value that indicates whether to copy all tags from the
|
1653
|
-
# to snapshots of the
|
1664
|
+
# A value that indicates whether to copy all tags from the read replica
|
1665
|
+
# to snapshots of the read replica. By default, tags are not copied.
|
1654
1666
|
# @option options [Integer] :monitoring_interval
|
1655
1667
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1656
|
-
# metrics are collected for the
|
1668
|
+
# metrics are collected for the read replica. To disable collecting
|
1657
1669
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
1658
1670
|
#
|
1659
1671
|
# If `MonitoringRoleArn` is specified, then you must also set
|
@@ -1674,31 +1686,31 @@ module Aws::RDS
|
|
1674
1686
|
#
|
1675
1687
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
1676
1688
|
# @option options [String] :kms_key_id
|
1677
|
-
# The AWS KMS key ID for an encrypted
|
1689
|
+
# The AWS KMS key ID for an encrypted read replica. The KMS key ID is
|
1678
1690
|
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
1679
1691
|
# alias for the KMS encryption key.
|
1680
1692
|
#
|
1681
|
-
# If you create an encrypted
|
1693
|
+
# If you create an encrypted read replica in the same AWS Region as the
|
1682
1694
|
# source DB instance, then you do not have to specify a value for this
|
1683
|
-
# parameter. The
|
1695
|
+
# parameter. The read replica is encrypted with the same KMS key as the
|
1684
1696
|
# source DB instance.
|
1685
1697
|
#
|
1686
|
-
# If you create an encrypted
|
1698
|
+
# If you create an encrypted read replica in a different AWS Region,
|
1687
1699
|
# then you must specify a KMS key for the destination AWS Region. KMS
|
1688
1700
|
# encryption keys are specific to the AWS Region that they are created
|
1689
1701
|
# in, and you can't use encryption keys from one AWS Region in another
|
1690
1702
|
# AWS Region.
|
1691
1703
|
#
|
1692
|
-
# You can't create an encrypted
|
1704
|
+
# You can't create an encrypted read replica from an unencrypted DB
|
1693
1705
|
# instance.
|
1694
1706
|
# @option options [String] :pre_signed_url
|
1695
1707
|
# The URL that contains a Signature Version 4 signed request for the
|
1696
1708
|
# `CreateDBInstanceReadReplica` API action in the source AWS Region that
|
1697
1709
|
# contains the source DB instance.
|
1698
1710
|
#
|
1699
|
-
# You must specify this parameter when you create an encrypted
|
1700
|
-
#
|
1701
|
-
# specify `PreSignedUrl` when you are creating an encrypted
|
1711
|
+
# You must specify this parameter when you create an encrypted read
|
1712
|
+
# replica from another AWS Region by using the Amazon RDS API. Don't
|
1713
|
+
# specify `PreSignedUrl` when you are creating an encrypted read replica
|
1702
1714
|
# in the same AWS Region.
|
1703
1715
|
#
|
1704
1716
|
# The presigned URL must be a valid request for the
|
@@ -1706,7 +1718,7 @@ module Aws::RDS
|
|
1706
1718
|
# source AWS Region that contains the encrypted source DB instance. The
|
1707
1719
|
# presigned URL request must contain the following parameter values:
|
1708
1720
|
#
|
1709
|
-
# * `DestinationRegion` - The AWS Region that the encrypted
|
1721
|
+
# * `DestinationRegion` - The AWS Region that the encrypted read replica
|
1710
1722
|
# is created in. This AWS Region is the same one where the
|
1711
1723
|
# `CreateDBInstanceReadReplica` action is called that contains this
|
1712
1724
|
# presigned URL.
|
@@ -1720,7 +1732,7 @@ module Aws::RDS
|
|
1720
1732
|
# presigned URL must be set to the us-east-1 AWS Region.
|
1721
1733
|
#
|
1722
1734
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
1723
|
-
# encrypt the
|
1735
|
+
# encrypt the read replica in the destination AWS Region. This is the
|
1724
1736
|
# same identifier for both the `CreateDBInstanceReadReplica` action
|
1725
1737
|
# that is called in the destination AWS Region, and the action
|
1726
1738
|
# contained in the presigned URL.
|
@@ -1728,7 +1740,7 @@ module Aws::RDS
|
|
1728
1740
|
# * `SourceDBInstanceIdentifier` - The DB instance identifier for the
|
1729
1741
|
# encrypted DB instance to be replicated. This identifier must be in
|
1730
1742
|
# the Amazon Resource Name (ARN) format for the source AWS Region. For
|
1731
|
-
# example, if you are creating an encrypted
|
1743
|
+
# example, if you are creating an encrypted read replica from a DB
|
1732
1744
|
# instance in the us-west-2 AWS Region, then your
|
1733
1745
|
# `SourceDBInstanceIdentifier` looks like the following example:
|
1734
1746
|
# `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
|
@@ -1740,9 +1752,12 @@ module Aws::RDS
|
|
1740
1752
|
# <note markdown="1"> If you are using an AWS SDK tool or the AWS CLI, you can specify
|
1741
1753
|
# `SourceRegion` (or `--source-region` for the AWS CLI) instead of
|
1742
1754
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1743
|
-
# autogenerates a
|
1755
|
+
# autogenerates a presigned URL that is a valid request for the
|
1744
1756
|
# operation that can be executed in the source AWS Region.
|
1745
1757
|
#
|
1758
|
+
# `SourceRegion` isn't supported for SQL Server, because SQL Server on
|
1759
|
+
# Amazon RDS doesn't support cross-region read replicas.
|
1760
|
+
#
|
1746
1761
|
# </note>
|
1747
1762
|
#
|
1748
1763
|
#
|
@@ -1764,7 +1779,7 @@ module Aws::RDS
|
|
1764
1779
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
1765
1780
|
# @option options [Boolean] :enable_performance_insights
|
1766
1781
|
# A value that indicates whether to enable Performance Insights for the
|
1767
|
-
#
|
1782
|
+
# read replica.
|
1768
1783
|
#
|
1769
1784
|
# For more information, see [Using Amazon Performance Insights][1] in
|
1770
1785
|
# the *Amazon RDS User Guide*.
|
@@ -1816,9 +1831,16 @@ module Aws::RDS
|
|
1816
1831
|
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
1817
1832
|
# Oracle][1] in the *Amazon RDS User Guide*.
|
1818
1833
|
#
|
1834
|
+
# For Microsoft SQL Server DB instances, Amazon RDS can use Windows
|
1835
|
+
# Authentication to authenticate users that connect to the DB instance.
|
1836
|
+
# For more information, see [ Using Windows Authentication with an
|
1837
|
+
# Amazon RDS DB Instance Running Microsoft SQL Server][2] in the *Amazon
|
1838
|
+
# RDS User Guide*.
|
1839
|
+
#
|
1819
1840
|
#
|
1820
1841
|
#
|
1821
1842
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
1843
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
1822
1844
|
# @option options [String] :domain_iam_role_name
|
1823
1845
|
# Specify the name of the IAM role to be used when making API calls to
|
1824
1846
|
# the Directory Service.
|
@@ -1901,7 +1923,7 @@ module Aws::RDS
|
|
1901
1923
|
# 'failed', 'incompatible-restore', or 'incompatible-network', it
|
1902
1924
|
# can only be deleted when skip is specified.
|
1903
1925
|
#
|
1904
|
-
# Specify skip when deleting a
|
1926
|
+
# Specify skip when deleting a read replica.
|
1905
1927
|
#
|
1906
1928
|
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip
|
1907
1929
|
# isn't specified.
|
@@ -1924,7 +1946,7 @@ module Aws::RDS
|
|
1924
1946
|
#
|
1925
1947
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
1926
1948
|
#
|
1927
|
-
# * Can't be specified when deleting a
|
1949
|
+
# * Can't be specified when deleting a read replica.
|
1928
1950
|
# @option options [Boolean] :delete_automated_backups
|
1929
1951
|
# A value that indicates whether to remove automated backups immediately
|
1930
1952
|
# after the DB instance is deleted. This parameter isn't
|
@@ -2162,13 +2184,13 @@ module Aws::RDS
|
|
2162
2184
|
#
|
2163
2185
|
# * Must be a value from 0 to 35
|
2164
2186
|
#
|
2165
|
-
# * Can be specified for a MySQL
|
2187
|
+
# * Can be specified for a MySQL read replica only if the source is
|
2166
2188
|
# running MySQL 5.6 or later
|
2167
2189
|
#
|
2168
|
-
# * Can be specified for a PostgreSQL
|
2190
|
+
# * Can be specified for a PostgreSQL read replica only if the source is
|
2169
2191
|
# running PostgreSQL 9.3.5
|
2170
2192
|
#
|
2171
|
-
# * Can't be set to 0 if the DB instance is a source to
|
2193
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas
|
2172
2194
|
# @option options [String] :preferred_backup_window
|
2173
2195
|
# The daily time range during which automated backups are created if
|
2174
2196
|
# automated backups are enabled, as determined by the
|
@@ -2271,7 +2293,7 @@ module Aws::RDS
|
|
2271
2293
|
# performance degradation. While the migration takes place, nightly
|
2272
2294
|
# backups for the instance are suspended. No other Amazon RDS operations
|
2273
2295
|
# can take place for the instance, including modifying the instance,
|
2274
|
-
# rebooting the instance, deleting the instance, creating a
|
2296
|
+
# rebooting the instance, deleting the instance, creating a read replica
|
2275
2297
|
# for the instance, and creating a DB snapshot of the instance.
|
2276
2298
|
#
|
2277
2299
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value
|
@@ -2328,7 +2350,7 @@ module Aws::RDS
|
|
2328
2350
|
# performance degradation. While the migration takes place, nightly
|
2329
2351
|
# backups for the instance are suspended. No other Amazon RDS operations
|
2330
2352
|
# can take place for the instance, including modifying the instance,
|
2331
|
-
# rebooting the instance, deleting the instance, creating a
|
2353
|
+
# rebooting the instance, deleting the instance, creating a read replica
|
2332
2354
|
# for the instance, and creating a DB snapshot of the instance.
|
2333
2355
|
#
|
2334
2356
|
# Valid values: `standard | gp2 | io1`
|
@@ -2397,19 +2419,19 @@ module Aws::RDS
|
|
2397
2419
|
#
|
2398
2420
|
# Default: `3306`
|
2399
2421
|
#
|
2400
|
-
# Valid
|
2422
|
+
# Valid values: `1150-65535`
|
2401
2423
|
#
|
2402
2424
|
# **MariaDB**
|
2403
2425
|
#
|
2404
2426
|
# Default: `3306`
|
2405
2427
|
#
|
2406
|
-
# Valid
|
2428
|
+
# Valid values: `1150-65535`
|
2407
2429
|
#
|
2408
2430
|
# **PostgreSQL**
|
2409
2431
|
#
|
2410
2432
|
# Default: `5432`
|
2411
2433
|
#
|
2412
|
-
# Valid
|
2434
|
+
# Valid values: `1150-65535`
|
2413
2435
|
#
|
2414
2436
|
# Type: Integer
|
2415
2437
|
#
|
@@ -2417,20 +2439,20 @@ module Aws::RDS
|
|
2417
2439
|
#
|
2418
2440
|
# Default: `1521`
|
2419
2441
|
#
|
2420
|
-
# Valid
|
2442
|
+
# Valid values: `1150-65535`
|
2421
2443
|
#
|
2422
2444
|
# **SQL Server**
|
2423
2445
|
#
|
2424
2446
|
# Default: `1433`
|
2425
2447
|
#
|
2426
|
-
# Valid
|
2427
|
-
# `
|
2448
|
+
# Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
|
2449
|
+
# `3389`, `47001`, and `49152-49156`.
|
2428
2450
|
#
|
2429
2451
|
# **Amazon Aurora**
|
2430
2452
|
#
|
2431
2453
|
# Default: `3306`
|
2432
2454
|
#
|
2433
|
-
# Valid
|
2455
|
+
# Valid values: `1150-65535`
|
2434
2456
|
# @option options [Boolean] :publicly_accessible
|
2435
2457
|
# A value that indicates whether the DB instance is publicly accessible.
|
2436
2458
|
# When the DB instance is publicly accessible, it is an Internet-facing
|
@@ -2590,7 +2612,7 @@ module Aws::RDS
|
|
2590
2612
|
#
|
2591
2613
|
# * Must be a value from 0 to 35.
|
2592
2614
|
#
|
2593
|
-
# * Can't be set to 0 if the DB instance is a source to
|
2615
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas.
|
2594
2616
|
# @option options [String] :preferred_backup_window
|
2595
2617
|
# The daily time range during which automated backups are created if
|
2596
2618
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|