aws-sdk-rds 1.173.0 → 1.175.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +3604 -491
- data/lib/aws-sdk-rds/client_api.rb +5 -1
- data/lib/aws-sdk-rds/db_cluster.rb +15 -10
- data/lib/aws-sdk-rds/db_instance.rb +49 -18
- data/lib/aws-sdk-rds/resource.rb +11 -6
- data/lib/aws-sdk-rds/types.rb +94 -49
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
@@ -1029,7 +1029,7 @@ module Aws::RDS
|
|
1029
1029
|
CreateDBInstanceMessage.struct_class = Types::CreateDBInstanceMessage
|
1030
1030
|
|
1031
1031
|
CreateDBInstanceReadReplicaMessage.add_member(:db_instance_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBInstanceIdentifier"))
|
1032
|
-
CreateDBInstanceReadReplicaMessage.add_member(:source_db_instance_identifier, Shapes::ShapeRef.new(shape: String,
|
1032
|
+
CreateDBInstanceReadReplicaMessage.add_member(:source_db_instance_identifier, Shapes::ShapeRef.new(shape: String, location_name: "SourceDBInstanceIdentifier"))
|
1033
1033
|
CreateDBInstanceReadReplicaMessage.add_member(:db_instance_class, Shapes::ShapeRef.new(shape: String, location_name: "DBInstanceClass"))
|
1034
1034
|
CreateDBInstanceReadReplicaMessage.add_member(:availability_zone, Shapes::ShapeRef.new(shape: String, location_name: "AvailabilityZone"))
|
1035
1035
|
CreateDBInstanceReadReplicaMessage.add_member(:port, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Port"))
|
@@ -1065,6 +1065,7 @@ module Aws::RDS
|
|
1065
1065
|
CreateDBInstanceReadReplicaMessage.add_member(:storage_throughput, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "StorageThroughput"))
|
1066
1066
|
CreateDBInstanceReadReplicaMessage.add_member(:enable_customer_owned_ip, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableCustomerOwnedIp"))
|
1067
1067
|
CreateDBInstanceReadReplicaMessage.add_member(:allocated_storage, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "AllocatedStorage"))
|
1068
|
+
CreateDBInstanceReadReplicaMessage.add_member(:source_db_cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "SourceDBClusterIdentifier"))
|
1068
1069
|
CreateDBInstanceReadReplicaMessage.add_member(:source_region, Shapes::ShapeRef.new(shape: String, location_name: "SourceRegion"))
|
1069
1070
|
CreateDBInstanceReadReplicaMessage.struct_class = Types::CreateDBInstanceReadReplicaMessage
|
1070
1071
|
|
@@ -1524,6 +1525,7 @@ module Aws::RDS
|
|
1524
1525
|
DBInstance.add_member(:db_system_id, Shapes::ShapeRef.new(shape: String, location_name: "DBSystemId"))
|
1525
1526
|
DBInstance.add_member(:master_user_secret, Shapes::ShapeRef.new(shape: MasterUserSecret, location_name: "MasterUserSecret"))
|
1526
1527
|
DBInstance.add_member(:certificate_details, Shapes::ShapeRef.new(shape: CertificateDetails, location_name: "CertificateDetails"))
|
1528
|
+
DBInstance.add_member(:read_replica_source_db_cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ReadReplicaSourceDBClusterIdentifier"))
|
1527
1529
|
DBInstance.struct_class = Types::DBInstance
|
1528
1530
|
|
1529
1531
|
DBInstanceAlreadyExistsFault.struct_class = Types::DBInstanceAlreadyExistsFault
|
@@ -3963,7 +3965,9 @@ module Aws::RDS
|
|
3963
3965
|
o.errors << Shapes::ShapeRef.new(shape: InstanceQuotaExceededFault)
|
3964
3966
|
o.errors << Shapes::ShapeRef.new(shape: StorageQuotaExceededFault)
|
3965
3967
|
o.errors << Shapes::ShapeRef.new(shape: DBInstanceNotFoundFault)
|
3968
|
+
o.errors << Shapes::ShapeRef.new(shape: DBClusterNotFoundFault)
|
3966
3969
|
o.errors << Shapes::ShapeRef.new(shape: InvalidDBInstanceStateFault)
|
3970
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidDBClusterStateFault)
|
3967
3971
|
o.errors << Shapes::ShapeRef.new(shape: DBSubnetGroupNotFoundFault)
|
3968
3972
|
o.errors << Shapes::ShapeRef.new(shape: DBSubnetGroupDoesNotCoverEnoughAZs)
|
3969
3973
|
o.errors << Shapes::ShapeRef.new(shape: InvalidSubnet)
|
@@ -1102,8 +1102,7 @@ module Aws::RDS
|
|
1102
1102
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
1103
1103
|
# if this DB cluster is created as a read replica.
|
1104
1104
|
#
|
1105
|
-
# Valid for: Aurora DB clusters and
|
1106
|
-
# clusters
|
1105
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1107
1106
|
# @option options [Array<Types::Tag>] :tags
|
1108
1107
|
# Tags to assign to the DB cluster.
|
1109
1108
|
#
|
@@ -1808,14 +1807,10 @@ module Aws::RDS
|
|
1808
1807
|
# the DB cluster. If this parameter is disabled, changes to the DB
|
1809
1808
|
# cluster are applied during the next maintenance window.
|
1810
1809
|
#
|
1811
|
-
#
|
1812
|
-
#
|
1813
|
-
#
|
1814
|
-
#
|
1815
|
-
# `MasterUserPassword`, and `NewDBClusterIdentifier` values are applied
|
1816
|
-
# during the next maintenance window. All other changes are applied
|
1817
|
-
# immediately, regardless of the value of the `ApplyImmediately`
|
1818
|
-
# parameter.
|
1810
|
+
# Most modifications can be applied immediately or during the next
|
1811
|
+
# scheduled maintenance window. Some modifications, such as turning on
|
1812
|
+
# deletion protection and changing the master password, are applied
|
1813
|
+
# immediately—regardless of when you choose to apply them.
|
1819
1814
|
#
|
1820
1815
|
# By default, this parameter is disabled.
|
1821
1816
|
#
|
@@ -1980,6 +1975,10 @@ module Aws::RDS
|
|
1980
1975
|
# applied during the next maintenance window unless `ApplyImmediately`
|
1981
1976
|
# is enabled.
|
1982
1977
|
#
|
1978
|
+
# If the cluster that you're modifying has one or more read replicas,
|
1979
|
+
# all replicas must be running an engine version that's the same or
|
1980
|
+
# later than the version you specify.
|
1981
|
+
#
|
1983
1982
|
# To list all of the available engine versions for Aurora MySQL version
|
1984
1983
|
# 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the
|
1985
1984
|
# following command:
|
@@ -1987,6 +1986,12 @@ module Aws::RDS
|
|
1987
1986
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
1988
1987
|
# "DBEngineVersions[].EngineVersion"`
|
1989
1988
|
#
|
1989
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
1990
|
+
# Aurora, use the following command:
|
1991
|
+
#
|
1992
|
+
# `aws rds describe-db-engine-versions --engine aurora --query
|
1993
|
+
# "DBEngineVersions[].EngineVersion"`
|
1994
|
+
#
|
1990
1995
|
# To list all of the available engine versions for Aurora PostgreSQL,
|
1991
1996
|
# use the following command:
|
1992
1997
|
#
|
@@ -771,6 +771,13 @@ module Aws::RDS
|
|
771
771
|
data[:certificate_details]
|
772
772
|
end
|
773
773
|
|
774
|
+
# Contains the identifier of the source DB cluster if this DB instance
|
775
|
+
# is a read replica.
|
776
|
+
# @return [String]
|
777
|
+
def read_replica_source_db_cluster_identifier
|
778
|
+
data[:read_replica_source_db_cluster_identifier]
|
779
|
+
end
|
780
|
+
|
774
781
|
# @!endgroup
|
775
782
|
|
776
783
|
# @return [Client]
|
@@ -1216,13 +1223,15 @@ module Aws::RDS
|
|
1216
1223
|
#
|
1217
1224
|
# * `aurora-postgresql`
|
1218
1225
|
#
|
1219
|
-
# * `custom-oracle-ee (for RDS Custom for Oracle instances)`
|
1226
|
+
# * `custom-oracle-ee (for RDS Custom for Oracle DB instances)`
|
1227
|
+
#
|
1228
|
+
# * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)`
|
1220
1229
|
#
|
1221
|
-
# * `custom-sqlserver-ee (for RDS Custom for SQL Server instances)`
|
1230
|
+
# * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)`
|
1222
1231
|
#
|
1223
|
-
# * `custom-sqlserver-se (for RDS Custom for SQL Server instances)`
|
1232
|
+
# * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)`
|
1224
1233
|
#
|
1225
|
-
# * `custom-sqlserver-web (for RDS Custom for SQL Server instances)`
|
1234
|
+
# * `custom-sqlserver-web (for RDS Custom for SQL Server DB instances)`
|
1226
1235
|
#
|
1227
1236
|
# * `mariadb`
|
1228
1237
|
#
|
@@ -2131,6 +2140,7 @@ module Aws::RDS
|
|
2131
2140
|
# storage_throughput: 1,
|
2132
2141
|
# enable_customer_owned_ip: false,
|
2133
2142
|
# allocated_storage: 1,
|
2143
|
+
# source_db_cluster_identifier: "String",
|
2134
2144
|
# source_region: "String",
|
2135
2145
|
# })
|
2136
2146
|
# @param [Hash] options ({})
|
@@ -2170,8 +2180,8 @@ module Aws::RDS
|
|
2170
2180
|
# You can create a read replica as a Multi-AZ DB instance. RDS creates a
|
2171
2181
|
# standby of your replica in another Availability Zone for failover
|
2172
2182
|
# support for the replica. Creating your read replica as a Multi-AZ DB
|
2173
|
-
# instance is independent of whether the source
|
2174
|
-
# DB
|
2183
|
+
# instance is independent of whether the source is a Multi-AZ DB
|
2184
|
+
# instance or a Multi-AZ DB cluster.
|
2175
2185
|
#
|
2176
2186
|
# This setting doesn't apply to RDS Custom.
|
2177
2187
|
# @option options [Boolean] :auto_minor_version_upgrade
|
@@ -2186,10 +2196,10 @@ module Aws::RDS
|
|
2186
2196
|
# be initially allocated for the DB instance.
|
2187
2197
|
# @option options [String] :option_group_name
|
2188
2198
|
# The option group the DB instance is associated with. If omitted, the
|
2189
|
-
# option group associated with the source instance is used.
|
2199
|
+
# option group associated with the source instance or cluster is used.
|
2190
2200
|
#
|
2191
2201
|
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
2192
|
-
# source
|
2202
|
+
# source.
|
2193
2203
|
#
|
2194
2204
|
# </note>
|
2195
2205
|
#
|
@@ -2242,9 +2252,6 @@ module Aws::RDS
|
|
2242
2252
|
#
|
2243
2253
|
# Constraints:
|
2244
2254
|
#
|
2245
|
-
# * Can only be specified if the source DB instance identifier specifies
|
2246
|
-
# a DB instance in another Amazon Web Services Region.
|
2247
|
-
#
|
2248
2255
|
# * If supplied, must match the name of an existing DBSubnetGroup.
|
2249
2256
|
#
|
2250
2257
|
# * The specified DB subnet group must be in the same Amazon Web
|
@@ -2314,10 +2321,10 @@ module Aws::RDS
|
|
2314
2321
|
# alias ARN, or alias name for the KMS key.
|
2315
2322
|
#
|
2316
2323
|
# If you create an encrypted read replica in the same Amazon Web
|
2317
|
-
# Services Region as the source DB instance
|
2318
|
-
# for this parameter. A read replica in the same
|
2319
|
-
# Region is always encrypted with the same KMS key
|
2320
|
-
# instance.
|
2324
|
+
# Services Region as the source DB instance or Multi-AZ DB cluster,
|
2325
|
+
# don't specify a value for this parameter. A read replica in the same
|
2326
|
+
# Amazon Web Services Region is always encrypted with the same KMS key
|
2327
|
+
# as the source DB instance or cluster.
|
2321
2328
|
#
|
2322
2329
|
# If you create an encrypted read replica in a different Amazon Web
|
2323
2330
|
# Services Region, then you must specify a KMS key identifier for the
|
@@ -2327,7 +2334,7 @@ module Aws::RDS
|
|
2327
2334
|
# Services Region.
|
2328
2335
|
#
|
2329
2336
|
# You can't create an encrypted read replica from an unencrypted DB
|
2330
|
-
# instance.
|
2337
|
+
# instance or Multi-AZ DB cluster.
|
2331
2338
|
#
|
2332
2339
|
# This setting doesn't apply to RDS Custom, which uses the same KMS key
|
2333
2340
|
# as the primary replica.
|
@@ -2343,6 +2350,10 @@ module Aws::RDS
|
|
2343
2350
|
# and China Amazon Web Services Regions. It's ignored in other Amazon
|
2344
2351
|
# Web Services Regions.
|
2345
2352
|
#
|
2353
|
+
# This setting applies only when replicating from a source DB
|
2354
|
+
# *instance*. Source DB clusters aren't supported in Amazon Web
|
2355
|
+
# Services GovCloud (US) Regions and China Amazon Web Services Regions.
|
2356
|
+
#
|
2346
2357
|
# You must specify this parameter when you create an encrypted read
|
2347
2358
|
# replica from another Amazon Web Services Region by using the Amazon
|
2348
2359
|
# RDS API. Don't specify `PreSignedUrl` when you are creating an
|
@@ -2512,8 +2523,8 @@ module Aws::RDS
|
|
2512
2523
|
#
|
2513
2524
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2514
2525
|
# @option options [String] :domain_iam_role_name
|
2515
|
-
#
|
2516
|
-
#
|
2526
|
+
# The name of the IAM role to be used when making API calls to the
|
2527
|
+
# Directory Service.
|
2517
2528
|
#
|
2518
2529
|
# This setting doesn't apply to RDS Custom.
|
2519
2530
|
# @option options [String] :replica_mode
|
@@ -2627,6 +2638,22 @@ module Aws::RDS
|
|
2627
2638
|
# for future growth.
|
2628
2639
|
#
|
2629
2640
|
# </note>
|
2641
|
+
# @option options [String] :source_db_cluster_identifier
|
2642
|
+
# The identifier of the Multi-AZ DB cluster that will act as the source
|
2643
|
+
# for the read replica. Each DB cluster can have up to 15 read replicas.
|
2644
|
+
#
|
2645
|
+
# Constraints:
|
2646
|
+
#
|
2647
|
+
# * Must be the identifier of an existing Multi-AZ DB cluster.
|
2648
|
+
#
|
2649
|
+
# * Can't be specified if the `SourceDBInstanceIdentifier` parameter is
|
2650
|
+
# also specified.
|
2651
|
+
#
|
2652
|
+
# * The specified DB cluster must have automatic backups enabled, that
|
2653
|
+
# is, its backup retention period must be greater than 0.
|
2654
|
+
#
|
2655
|
+
# * The source DB cluster must be in the same Amazon Web Services Region
|
2656
|
+
# as the read replica. Cross-Region replication isn't supported.
|
2630
2657
|
# @option options [String] :source_region
|
2631
2658
|
# The source region of the snapshot. This is only needed when the
|
2632
2659
|
# shapshot is encrypted and in a different region.
|
@@ -3091,6 +3118,10 @@ module Aws::RDS
|
|
3091
3118
|
# lower. For information about valid engine versions, see
|
3092
3119
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
3093
3120
|
#
|
3121
|
+
# If the instance that you're modifying is acting as a read replica,
|
3122
|
+
# the engine version that you specify must be the same or later than the
|
3123
|
+
# version that the source DB instance or cluster is running.
|
3124
|
+
#
|
3094
3125
|
# In RDS Custom for Oracle, this parameter is supported for read
|
3095
3126
|
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
3096
3127
|
# @option options [Boolean] :allow_major_version_upgrade
|
data/lib/aws-sdk-rds/resource.rb
CHANGED
@@ -353,8 +353,7 @@ module Aws::RDS
|
|
353
353
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
354
354
|
# if this DB cluster is created as a read replica.
|
355
355
|
#
|
356
|
-
# Valid for: Aurora DB clusters and
|
357
|
-
# clusters
|
356
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
358
357
|
# @option options [Array<Types::Tag>] :tags
|
359
358
|
# Tags to assign to the DB cluster.
|
360
359
|
#
|
@@ -1286,13 +1285,15 @@ module Aws::RDS
|
|
1286
1285
|
#
|
1287
1286
|
# * `aurora-postgresql`
|
1288
1287
|
#
|
1289
|
-
# * `custom-oracle-ee (for RDS Custom for Oracle instances)`
|
1288
|
+
# * `custom-oracle-ee (for RDS Custom for Oracle DB instances)`
|
1289
|
+
#
|
1290
|
+
# * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)`
|
1290
1291
|
#
|
1291
|
-
# * `custom-sqlserver-ee (for RDS Custom for SQL Server instances)`
|
1292
|
+
# * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)`
|
1292
1293
|
#
|
1293
|
-
# * `custom-sqlserver-se (for RDS Custom for SQL Server instances)`
|
1294
|
+
# * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)`
|
1294
1295
|
#
|
1295
|
-
# * `custom-sqlserver-web (for RDS Custom for SQL Server instances)`
|
1296
|
+
# * `custom-sqlserver-web (for RDS Custom for SQL Server DB instances)`
|
1296
1297
|
#
|
1297
1298
|
# * `mariadb`
|
1298
1299
|
#
|
@@ -2673,6 +2674,10 @@ module Aws::RDS
|
|
2673
2674
|
# Amazon Resource Names (ARNs). The results list only includes
|
2674
2675
|
# information about the DB clusters identified by these ARNs.
|
2675
2676
|
#
|
2677
|
+
# * `db-cluster-resource-id` - Accepts DB cluster resource identifiers.
|
2678
|
+
# The results list will only include information about the DB clusters
|
2679
|
+
# identified by these DB cluster resource identifiers.
|
2680
|
+
#
|
2676
2681
|
# * `domain` - Accepts Active Directory directory IDs. The results list
|
2677
2682
|
# only includes information about the DB clusters associated with
|
2678
2683
|
# these domains.
|
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -2214,8 +2214,7 @@ module Aws::RDS
|
|
2214
2214
|
# The Amazon Resource Name (ARN) of the source DB instance or DB
|
2215
2215
|
# cluster if this DB cluster is created as a read replica.
|
2216
2216
|
#
|
2217
|
-
# Valid for: Aurora DB clusters and
|
2218
|
-
# clusters
|
2217
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2219
2218
|
# @return [String]
|
2220
2219
|
#
|
2221
2220
|
# @!attribute [rw] tags
|
@@ -3311,13 +3310,16 @@ module Aws::RDS
|
|
3311
3310
|
#
|
3312
3311
|
# * `aurora-postgresql`
|
3313
3312
|
#
|
3314
|
-
# * `custom-oracle-ee (for RDS Custom for Oracle instances)`
|
3313
|
+
# * `custom-oracle-ee (for RDS Custom for Oracle DB instances)`
|
3314
|
+
#
|
3315
|
+
# * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)`
|
3315
3316
|
#
|
3316
|
-
# * `custom-sqlserver-ee (for RDS Custom for SQL Server instances)`
|
3317
|
+
# * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)`
|
3317
3318
|
#
|
3318
|
-
# * `custom-sqlserver-se (for RDS Custom for SQL Server instances)`
|
3319
|
+
# * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)`
|
3319
3320
|
#
|
3320
|
-
# * `custom-sqlserver-web (for RDS Custom for SQL Server
|
3321
|
+
# * `custom-sqlserver-web (for RDS Custom for SQL Server DB
|
3322
|
+
# instances)`
|
3321
3323
|
#
|
3322
3324
|
# * `mariadb`
|
3323
3325
|
#
|
@@ -4345,27 +4347,24 @@ module Aws::RDS
|
|
4345
4347
|
#
|
4346
4348
|
# @!attribute [rw] source_db_instance_identifier
|
4347
4349
|
# The identifier of the DB instance that will act as the source for
|
4348
|
-
# the read replica. Each DB instance can have up to
|
4349
|
-
#
|
4350
|
+
# the read replica. Each DB instance can have up to 15 read replicas,
|
4351
|
+
# with the exception of Oracle and SQL Server, which can have up to
|
4352
|
+
# five.
|
4350
4353
|
#
|
4351
4354
|
# Constraints:
|
4352
4355
|
#
|
4353
4356
|
# * Must be the identifier of an existing MySQL, MariaDB, Oracle,
|
4354
4357
|
# PostgreSQL, or SQL Server DB instance.
|
4355
4358
|
#
|
4356
|
-
# * Can
|
4357
|
-
#
|
4359
|
+
# * Can't be specified if the `SourceDBClusterIdentifier` parameter
|
4360
|
+
# is also specified.
|
4358
4361
|
#
|
4359
|
-
# * For the limitations of Oracle read replicas, see [
|
4360
|
-
#
|
4362
|
+
# * For the limitations of Oracle read replicas, see [Version and
|
4363
|
+
# licensing considerations for RDS for Oracle replicas][1] in the
|
4364
|
+
# *Amazon RDS User Guide*.
|
4361
4365
|
#
|
4362
|
-
# * For the limitations of SQL Server read replicas, see [Read
|
4363
|
-
#
|
4364
|
-
# Guide*.
|
4365
|
-
#
|
4366
|
-
# * Can specify a PostgreSQL DB instance only if the source is running
|
4367
|
-
# PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region
|
4368
|
-
# replication).
|
4366
|
+
# * For the limitations of SQL Server read replicas, see [Read replica
|
4367
|
+
# limitations with SQL Server][2] in the *Amazon RDS User Guide*.
|
4369
4368
|
#
|
4370
4369
|
# * The specified DB instance must have automatic backups enabled,
|
4371
4370
|
# that is, its backup retention period must be greater than 0.
|
@@ -4382,8 +4381,8 @@ module Aws::RDS
|
|
4382
4381
|
#
|
4383
4382
|
#
|
4384
4383
|
#
|
4385
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
4386
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations
|
4384
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses
|
4385
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations
|
4387
4386
|
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
|
4388
4387
|
# @return [String]
|
4389
4388
|
#
|
@@ -4425,8 +4424,8 @@ module Aws::RDS
|
|
4425
4424
|
# You can create a read replica as a Multi-AZ DB instance. RDS creates
|
4426
4425
|
# a standby of your replica in another Availability Zone for failover
|
4427
4426
|
# support for the replica. Creating your read replica as a Multi-AZ DB
|
4428
|
-
# instance is independent of whether the source
|
4429
|
-
# DB
|
4427
|
+
# instance is independent of whether the source is a Multi-AZ DB
|
4428
|
+
# instance or a Multi-AZ DB cluster.
|
4430
4429
|
#
|
4431
4430
|
# This setting doesn't apply to RDS Custom.
|
4432
4431
|
# @return [Boolean]
|
@@ -4447,10 +4446,10 @@ module Aws::RDS
|
|
4447
4446
|
#
|
4448
4447
|
# @!attribute [rw] option_group_name
|
4449
4448
|
# The option group the DB instance is associated with. If omitted, the
|
4450
|
-
# option group associated with the source instance is used.
|
4449
|
+
# option group associated with the source instance or cluster is used.
|
4451
4450
|
#
|
4452
4451
|
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
4453
|
-
# source
|
4452
|
+
# source.
|
4454
4453
|
#
|
4455
4454
|
# </note>
|
4456
4455
|
#
|
@@ -4514,9 +4513,6 @@ module Aws::RDS
|
|
4514
4513
|
#
|
4515
4514
|
# Constraints:
|
4516
4515
|
#
|
4517
|
-
# * Can only be specified if the source DB instance identifier
|
4518
|
-
# specifies a DB instance in another Amazon Web Services Region.
|
4519
|
-
#
|
4520
4516
|
# * If supplied, must match the name of an existing DBSubnetGroup.
|
4521
4517
|
#
|
4522
4518
|
# * The specified DB subnet group must be in the same Amazon Web
|
@@ -4599,10 +4595,10 @@ module Aws::RDS
|
|
4599
4595
|
# alias ARN, or alias name for the KMS key.
|
4600
4596
|
#
|
4601
4597
|
# If you create an encrypted read replica in the same Amazon Web
|
4602
|
-
# Services Region as the source DB instance
|
4603
|
-
# value for this parameter. A read replica in the
|
4604
|
-
# Services Region is always encrypted with the same
|
4605
|
-
# source DB instance.
|
4598
|
+
# Services Region as the source DB instance or Multi-AZ DB cluster,
|
4599
|
+
# don't specify a value for this parameter. A read replica in the
|
4600
|
+
# same Amazon Web Services Region is always encrypted with the same
|
4601
|
+
# KMS key as the source DB instance or cluster.
|
4606
4602
|
#
|
4607
4603
|
# If you create an encrypted read replica in a different Amazon Web
|
4608
4604
|
# Services Region, then you must specify a KMS key identifier for the
|
@@ -4612,7 +4608,7 @@ module Aws::RDS
|
|
4612
4608
|
# Web Services Region.
|
4613
4609
|
#
|
4614
4610
|
# You can't create an encrypted read replica from an unencrypted DB
|
4615
|
-
# instance.
|
4611
|
+
# instance or Multi-AZ DB cluster.
|
4616
4612
|
#
|
4617
4613
|
# This setting doesn't apply to RDS Custom, which uses the same KMS
|
4618
4614
|
# key as the primary replica.
|
@@ -4630,6 +4626,11 @@ module Aws::RDS
|
|
4630
4626
|
# Regions and China Amazon Web Services Regions. It's ignored in
|
4631
4627
|
# other Amazon Web Services Regions.
|
4632
4628
|
#
|
4629
|
+
# This setting applies only when replicating from a source DB
|
4630
|
+
# *instance*. Source DB clusters aren't supported in Amazon Web
|
4631
|
+
# Services GovCloud (US) Regions and China Amazon Web Services
|
4632
|
+
# Regions.
|
4633
|
+
#
|
4633
4634
|
# You must specify this parameter when you create an encrypted read
|
4634
4635
|
# replica from another Amazon Web Services Region by using the Amazon
|
4635
4636
|
# RDS API. Don't specify `PreSignedUrl` when you are creating an
|
@@ -4822,8 +4823,8 @@ module Aws::RDS
|
|
4822
4823
|
# @return [String]
|
4823
4824
|
#
|
4824
4825
|
# @!attribute [rw] domain_iam_role_name
|
4825
|
-
#
|
4826
|
-
#
|
4826
|
+
# The name of the IAM role to be used when making API calls to the
|
4827
|
+
# Directory Service.
|
4827
4828
|
#
|
4828
4829
|
# This setting doesn't apply to RDS Custom.
|
4829
4830
|
# @return [String]
|
@@ -4954,6 +4955,26 @@ module Aws::RDS
|
|
4954
4955
|
# </note>
|
4955
4956
|
# @return [Integer]
|
4956
4957
|
#
|
4958
|
+
# @!attribute [rw] source_db_cluster_identifier
|
4959
|
+
# The identifier of the Multi-AZ DB cluster that will act as the
|
4960
|
+
# source for the read replica. Each DB cluster can have up to 15 read
|
4961
|
+
# replicas.
|
4962
|
+
#
|
4963
|
+
# Constraints:
|
4964
|
+
#
|
4965
|
+
# * Must be the identifier of an existing Multi-AZ DB cluster.
|
4966
|
+
#
|
4967
|
+
# * Can't be specified if the `SourceDBInstanceIdentifier` parameter
|
4968
|
+
# is also specified.
|
4969
|
+
#
|
4970
|
+
# * The specified DB cluster must have automatic backups enabled, that
|
4971
|
+
# is, its backup retention period must be greater than 0.
|
4972
|
+
#
|
4973
|
+
# * The source DB cluster must be in the same Amazon Web Services
|
4974
|
+
# Region as the read replica. Cross-Region replication isn't
|
4975
|
+
# supported.
|
4976
|
+
# @return [String]
|
4977
|
+
#
|
4957
4978
|
# @!attribute [rw] source_region
|
4958
4979
|
# The source region of the snapshot. This is only needed when the
|
4959
4980
|
# shapshot is encrypted and in a different region.
|
@@ -4999,6 +5020,7 @@ module Aws::RDS
|
|
4999
5020
|
:storage_throughput,
|
5000
5021
|
:enable_customer_owned_ip,
|
5001
5022
|
:allocated_storage,
|
5023
|
+
:source_db_cluster_identifier,
|
5002
5024
|
:source_region)
|
5003
5025
|
SENSITIVE = []
|
5004
5026
|
include Aws::Structure
|
@@ -5585,7 +5607,8 @@ module Aws::RDS
|
|
5585
5607
|
end
|
5586
5608
|
|
5587
5609
|
# @!attribute [rw] global_cluster_identifier
|
5588
|
-
# The cluster identifier of the new global database cluster.
|
5610
|
+
# The cluster identifier of the new global database cluster. This
|
5611
|
+
# parameter is stored as a lowercase string.
|
5589
5612
|
# @return [String]
|
5590
5613
|
#
|
5591
5614
|
# @!attribute [rw] source_db_cluster_identifier
|
@@ -7983,6 +8006,11 @@ module Aws::RDS
|
|
7983
8006
|
# The details of the DB instance's server certificate.
|
7984
8007
|
# @return [Types::CertificateDetails]
|
7985
8008
|
#
|
8009
|
+
# @!attribute [rw] read_replica_source_db_cluster_identifier
|
8010
|
+
# Contains the identifier of the source DB cluster if this DB instance
|
8011
|
+
# is a read replica.
|
8012
|
+
# @return [String]
|
8013
|
+
#
|
7986
8014
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
|
7987
8015
|
#
|
7988
8016
|
class DBInstance < Struct.new(
|
@@ -8065,7 +8093,8 @@ module Aws::RDS
|
|
8065
8093
|
:storage_throughput,
|
8066
8094
|
:db_system_id,
|
8067
8095
|
:master_user_secret,
|
8068
|
-
:certificate_details
|
8096
|
+
:certificate_details,
|
8097
|
+
:read_replica_source_db_cluster_identifier)
|
8069
8098
|
SENSITIVE = []
|
8070
8099
|
include Aws::Structure
|
8071
8100
|
end
|
@@ -9592,8 +9621,8 @@ module Aws::RDS
|
|
9592
9621
|
end
|
9593
9622
|
|
9594
9623
|
# @!attribute [rw] engine
|
9595
|
-
# The database engine. The only supported
|
9596
|
-
# `custom-oracle-ee`.
|
9624
|
+
# The database engine. The only supported engines are
|
9625
|
+
# `custom-oracle-ee` and `custom-oracle-ee-cdb`.
|
9597
9626
|
# @return [String]
|
9598
9627
|
#
|
9599
9628
|
# @!attribute [rw] engine_version
|
@@ -10706,6 +10735,11 @@ module Aws::RDS
|
|
10706
10735
|
# Amazon Resource Names (ARNs). The results list only includes
|
10707
10736
|
# information about the DB clusters identified by these ARNs.
|
10708
10737
|
#
|
10738
|
+
# * `db-cluster-resource-id` - Accepts DB cluster resource
|
10739
|
+
# identifiers. The results list will only include information about
|
10740
|
+
# the DB clusters identified by these DB cluster resource
|
10741
|
+
# identifiers.
|
10742
|
+
#
|
10709
10743
|
# * `domain` - Accepts Active Directory directory IDs. The results
|
10710
10744
|
# list only includes information about the DB clusters associated
|
10711
10745
|
# with these domains.
|
@@ -14254,7 +14288,8 @@ module Aws::RDS
|
|
14254
14288
|
end
|
14255
14289
|
|
14256
14290
|
# @!attribute [rw] engine
|
14257
|
-
# The DB engine. The only supported
|
14291
|
+
# The DB engine. The only supported values are `custom-oracle-ee` and
|
14292
|
+
# `custom-oracle-ee-cdb`.
|
14258
14293
|
# @return [String]
|
14259
14294
|
#
|
14260
14295
|
# @!attribute [rw] engine_version
|
@@ -14368,14 +14403,10 @@ module Aws::RDS
|
|
14368
14403
|
# the DB cluster. If this parameter is disabled, changes to the DB
|
14369
14404
|
# cluster are applied during the next maintenance window.
|
14370
14405
|
#
|
14371
|
-
#
|
14372
|
-
#
|
14373
|
-
#
|
14374
|
-
#
|
14375
|
-
# `MasterUserPassword`, and `NewDBClusterIdentifier` values are
|
14376
|
-
# applied during the next maintenance window. All other changes are
|
14377
|
-
# applied immediately, regardless of the value of the
|
14378
|
-
# `ApplyImmediately` parameter.
|
14406
|
+
# Most modifications can be applied immediately or during the next
|
14407
|
+
# scheduled maintenance window. Some modifications, such as turning on
|
14408
|
+
# deletion protection and changing the master password, are applied
|
14409
|
+
# immediately—regardless of when you choose to apply them.
|
14379
14410
|
#
|
14380
14411
|
# By default, this parameter is disabled.
|
14381
14412
|
#
|
@@ -14566,6 +14597,10 @@ module Aws::RDS
|
|
14566
14597
|
# applied during the next maintenance window unless `ApplyImmediately`
|
14567
14598
|
# is enabled.
|
14568
14599
|
#
|
14600
|
+
# If the cluster that you're modifying has one or more read replicas,
|
14601
|
+
# all replicas must be running an engine version that's the same or
|
14602
|
+
# later than the version you specify.
|
14603
|
+
#
|
14569
14604
|
# To list all of the available engine versions for Aurora MySQL
|
14570
14605
|
# version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use
|
14571
14606
|
# the following command:
|
@@ -14573,6 +14608,12 @@ module Aws::RDS
|
|
14573
14608
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
14574
14609
|
# "DBEngineVersions[].EngineVersion"`
|
14575
14610
|
#
|
14611
|
+
# To list all of the available engine versions for MySQL
|
14612
|
+
# 5.6-compatible Aurora, use the following command:
|
14613
|
+
#
|
14614
|
+
# `aws rds describe-db-engine-versions --engine aurora --query
|
14615
|
+
# "DBEngineVersions[].EngineVersion"`
|
14616
|
+
#
|
14576
14617
|
# To list all of the available engine versions for Aurora PostgreSQL,
|
14577
14618
|
# use the following command:
|
14578
14619
|
#
|
@@ -15496,6 +15537,10 @@ module Aws::RDS
|
|
15496
15537
|
# is lower. For information about valid engine versions, see
|
15497
15538
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
15498
15539
|
#
|
15540
|
+
# If the instance that you're modifying is acting as a read replica,
|
15541
|
+
# the engine version that you specify must be the same or later than
|
15542
|
+
# the version that the source DB instance or cluster is running.
|
15543
|
+
#
|
15499
15544
|
# In RDS Custom for Oracle, this parameter is supported for read
|
15500
15545
|
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
15501
15546
|
# @return [String]
|
@@ -22950,7 +22995,7 @@ module Aws::RDS
|
|
22950
22995
|
|
22951
22996
|
# @!attribute [rw] source_db_instance_arn
|
22952
22997
|
# The Amazon Resource Name (ARN) of the source DB instance for which
|
22953
|
-
# to stop replicating
|
22998
|
+
# to stop replicating automate backups, for example,
|
22954
22999
|
# `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.
|
22955
23000
|
# @return [String]
|
22956
23001
|
#
|
data/lib/aws-sdk-rds.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-rds
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.175.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-04-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sigv4
|