aws-sdk-rds 1.110.0 → 1.115.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 +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +354 -33
- data/lib/aws-sdk-rds/client_api.rb +38 -0
- data/lib/aws-sdk-rds/db_cluster.rb +28 -14
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +10 -2
- data/lib/aws-sdk-rds/db_instance.rb +66 -8
- data/lib/aws-sdk-rds/option_group.rb +24 -0
- data/lib/aws-sdk-rds/resource.rb +126 -16
- data/lib/aws-sdk-rds/types.rb +377 -40
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f2192a5f3649a3a943063cc8a7b9d636f119a0beac7657c7f0413dfd46aab3fa
|
4
|
+
data.tar.gz: 063dc91a8c2bf01555a3834ef4ff2b1a1c865c98f0560c2b568996460a75340c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cc4d394170318390282ca3ccb2e6c72e584c9c699700ea211ac1ff27a1eff4327d1cfa689f914e80ead6fe87bd4fbce1ff0c2566f3f72db82e7f780a03133f87
|
7
|
+
data.tar.gz: 93cd46662beab3a09ce9f72179574a5db196bf2ab5fb165a9a23b56c411c1731a2c668c7134eb069e7bfc809cbd7d6f998423d8c0e5027146984a580859bb362
|
data/lib/aws-sdk-rds.rb
CHANGED
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -913,14 +913,7 @@ module Aws::RDS
|
|
913
913
|
#
|
914
914
|
# * Must specify a valid DB cluster parameter group.
|
915
915
|
#
|
916
|
-
#
|
917
|
-
# as the copy, specify a valid DB parameter group identifier, for
|
918
|
-
# example `my-db-cluster-param-group`, or a valid ARN.
|
919
|
-
#
|
920
|
-
# * If the source DB parameter group is in a different AWS Region than
|
921
|
-
# the copy, specify a valid DB cluster parameter group ARN, for
|
922
|
-
# example
|
923
|
-
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
|
916
|
+
# ^
|
924
917
|
#
|
925
918
|
#
|
926
919
|
#
|
@@ -1267,6 +1260,7 @@ module Aws::RDS
|
|
1267
1260
|
# resp.db_cluster_snapshot.db_cluster_identifier #=> String
|
1268
1261
|
# resp.db_cluster_snapshot.snapshot_create_time #=> Time
|
1269
1262
|
# resp.db_cluster_snapshot.engine #=> String
|
1263
|
+
# resp.db_cluster_snapshot.engine_mode #=> String
|
1270
1264
|
# resp.db_cluster_snapshot.allocated_storage #=> Integer
|
1271
1265
|
# resp.db_cluster_snapshot.status #=> String
|
1272
1266
|
# resp.db_cluster_snapshot.port #=> Integer
|
@@ -1306,8 +1300,7 @@ module Aws::RDS
|
|
1306
1300
|
#
|
1307
1301
|
# * Must specify a valid DB parameter group.
|
1308
1302
|
#
|
1309
|
-
#
|
1310
|
-
# `my-db-param-group`, or a valid ARN.
|
1303
|
+
# ^
|
1311
1304
|
#
|
1312
1305
|
#
|
1313
1306
|
#
|
@@ -2149,14 +2142,14 @@ module Aws::RDS
|
|
2149
2142
|
#
|
2150
2143
|
# **Aurora PostgreSQL**
|
2151
2144
|
#
|
2152
|
-
# Possible
|
2145
|
+
# Possible value is `postgresql`.
|
2153
2146
|
#
|
2154
2147
|
#
|
2155
2148
|
#
|
2156
2149
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
2157
2150
|
#
|
2158
2151
|
# @option params [String] :engine_mode
|
2159
|
-
# The DB engine mode of the DB cluster, either `provisioned
|
2152
|
+
# The DB engine mode of the DB cluster, either `provisioned`,
|
2160
2153
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
2161
2154
|
#
|
2162
2155
|
# The `parallelquery` engine mode isn't required for Aurora MySQL
|
@@ -2244,12 +2237,19 @@ module Aws::RDS
|
|
2244
2237
|
# the Directory Service.
|
2245
2238
|
#
|
2246
2239
|
# @option params [Boolean] :enable_global_write_forwarding
|
2247
|
-
# A value that indicates whether to enable
|
2248
|
-
#
|
2249
|
-
#
|
2250
|
-
#
|
2251
|
-
#
|
2252
|
-
#
|
2240
|
+
# A value that indicates whether to enable this DB cluster to forward
|
2241
|
+
# write operations to the primary cluster of an Aurora global database
|
2242
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
2243
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
2244
|
+
# database.
|
2245
|
+
#
|
2246
|
+
# You can set this value only on Aurora DB clusters that are members of
|
2247
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
2248
|
+
# cluster can forward writes to the current primary cluster and the
|
2249
|
+
# resulting changes are replicated back to this cluster. For the primary
|
2250
|
+
# DB cluster of an Aurora global database, this value is used
|
2251
|
+
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
2252
|
+
# operation, but it does nothing until then.
|
2253
2253
|
#
|
2254
2254
|
# @option params [String] :source_region
|
2255
2255
|
# The source region of the snapshot. This is only needed when the
|
@@ -2726,6 +2726,7 @@ module Aws::RDS
|
|
2726
2726
|
# resp.db_cluster_snapshot.db_cluster_identifier #=> String
|
2727
2727
|
# resp.db_cluster_snapshot.snapshot_create_time #=> Time
|
2728
2728
|
# resp.db_cluster_snapshot.engine #=> String
|
2729
|
+
# resp.db_cluster_snapshot.engine_mode #=> String
|
2729
2730
|
# resp.db_cluster_snapshot.allocated_storage #=> Integer
|
2730
2731
|
# resp.db_cluster_snapshot.status #=> String
|
2731
2732
|
# resp.db_cluster_snapshot.port #=> Integer
|
@@ -2793,8 +2794,8 @@ module Aws::RDS
|
|
2793
2794
|
# **PostgreSQL**
|
2794
2795
|
#
|
2795
2796
|
# The name of the database to create when the DB instance is created. If
|
2796
|
-
# this parameter isn't specified,
|
2797
|
-
# instance.
|
2797
|
+
# this parameter isn't specified, a database named `postgres` is
|
2798
|
+
# created in the DB instance.
|
2798
2799
|
#
|
2799
2800
|
# Constraints:
|
2800
2801
|
#
|
@@ -2823,17 +2824,34 @@ module Aws::RDS
|
|
2823
2824
|
#
|
2824
2825
|
# Not applicable. Must be null.
|
2825
2826
|
#
|
2826
|
-
# **Amazon Aurora**
|
2827
|
+
# **Amazon Aurora MySQL**
|
2827
2828
|
#
|
2828
|
-
# The name of the database to create when the primary instance of the
|
2829
|
-
# cluster is created. If this parameter isn't specified
|
2830
|
-
# created in the DB
|
2829
|
+
# The name of the database to create when the primary DB instance of the
|
2830
|
+
# Aurora MySQL DB cluster is created. If this parameter isn't specified
|
2831
|
+
# for an Aurora MySQL DB cluster, no database is created in the DB
|
2832
|
+
# cluster.
|
2831
2833
|
#
|
2832
2834
|
# Constraints:
|
2833
2835
|
#
|
2834
|
-
# *
|
2836
|
+
# * It must contain 1 to 64 alphanumeric characters.
|
2835
2837
|
#
|
2836
|
-
# *
|
2838
|
+
# * It can't be a word reserved by the database engine.
|
2839
|
+
#
|
2840
|
+
# **Amazon Aurora PostgreSQL**
|
2841
|
+
#
|
2842
|
+
# The name of the database to create when the primary DB instance of the
|
2843
|
+
# Aurora PostgreSQL DB cluster is created. If this parameter isn't
|
2844
|
+
# specified for an Aurora PostgreSQL DB cluster, a database named
|
2845
|
+
# `postgres` is created in the DB cluster.
|
2846
|
+
#
|
2847
|
+
# Constraints:
|
2848
|
+
#
|
2849
|
+
# * It must contain 1 to 63 alphanumeric characters.
|
2850
|
+
#
|
2851
|
+
# * It must begin with a letter or an underscore. Subsequent characters
|
2852
|
+
# can be letters, underscores, or digits (0 to 9).
|
2853
|
+
#
|
2854
|
+
# * It can't be a word reserved by the database engine.
|
2837
2855
|
#
|
2838
2856
|
# @option params [required, String] :db_instance_identifier
|
2839
2857
|
# The DB instance identifier. This parameter is stored as a lowercase
|
@@ -3616,6 +3634,14 @@ module Aws::RDS
|
|
3616
3634
|
# The upper limit to which Amazon RDS can automatically scale the
|
3617
3635
|
# storage of the DB instance.
|
3618
3636
|
#
|
3637
|
+
# For more information about this setting, including limitations that
|
3638
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3639
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3640
|
+
#
|
3641
|
+
#
|
3642
|
+
#
|
3643
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
3644
|
+
#
|
3619
3645
|
# @option params [Boolean] :enable_customer_owned_ip
|
3620
3646
|
# A value that indicates whether to enable a customer-owned IP address
|
3621
3647
|
# (CoIP) for an RDS on Outposts DB instance.
|
@@ -3848,6 +3874,7 @@ module Aws::RDS
|
|
3848
3874
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
3849
3875
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
3850
3876
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
3877
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
3851
3878
|
#
|
3852
3879
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance AWS API Documentation
|
3853
3880
|
#
|
@@ -4289,6 +4316,14 @@ module Aws::RDS
|
|
4289
4316
|
# The upper limit to which Amazon RDS can automatically scale the
|
4290
4317
|
# storage of the DB instance.
|
4291
4318
|
#
|
4319
|
+
# For more information about this setting, including limitations that
|
4320
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
4321
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
4322
|
+
#
|
4323
|
+
#
|
4324
|
+
#
|
4325
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
4326
|
+
#
|
4292
4327
|
# @option params [String] :source_region
|
4293
4328
|
# The source region of the snapshot. This is only needed when the
|
4294
4329
|
# shapshot is encrypted and in a different region.
|
@@ -4497,6 +4532,7 @@ module Aws::RDS
|
|
4497
4532
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
4498
4533
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
4499
4534
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
4535
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
4500
4536
|
#
|
4501
4537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica AWS API Documentation
|
4502
4538
|
#
|
@@ -5265,6 +5301,9 @@ module Aws::RDS
|
|
5265
5301
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
5266
5302
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
5267
5303
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
5304
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
5305
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
5306
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
5268
5307
|
#
|
5269
5308
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateGlobalCluster AWS API Documentation
|
5270
5309
|
#
|
@@ -5294,6 +5333,30 @@ module Aws::RDS
|
|
5294
5333
|
# Specifies the name of the engine that this option group should be
|
5295
5334
|
# associated with.
|
5296
5335
|
#
|
5336
|
+
# Valid Values:
|
5337
|
+
#
|
5338
|
+
# * `mariadb`
|
5339
|
+
#
|
5340
|
+
# * `mysql`
|
5341
|
+
#
|
5342
|
+
# * `oracle-ee`
|
5343
|
+
#
|
5344
|
+
# * `oracle-se2`
|
5345
|
+
#
|
5346
|
+
# * `oracle-se1`
|
5347
|
+
#
|
5348
|
+
# * `oracle-se`
|
5349
|
+
#
|
5350
|
+
# * `postgres`
|
5351
|
+
#
|
5352
|
+
# * `sqlserver-ee`
|
5353
|
+
#
|
5354
|
+
# * `sqlserver-se`
|
5355
|
+
#
|
5356
|
+
# * `sqlserver-ex`
|
5357
|
+
#
|
5358
|
+
# * `sqlserver-web`
|
5359
|
+
#
|
5297
5360
|
# @option params [required, String] :major_engine_version
|
5298
5361
|
# Specifies the major version of the engine that this option group
|
5299
5362
|
# should be associated with.
|
@@ -5780,6 +5843,7 @@ module Aws::RDS
|
|
5780
5843
|
# resp.db_cluster_snapshot.db_cluster_identifier #=> String
|
5781
5844
|
# resp.db_cluster_snapshot.snapshot_create_time #=> Time
|
5782
5845
|
# resp.db_cluster_snapshot.engine #=> String
|
5846
|
+
# resp.db_cluster_snapshot.engine_mode #=> String
|
5783
5847
|
# resp.db_cluster_snapshot.allocated_storage #=> Integer
|
5784
5848
|
# resp.db_cluster_snapshot.status #=> String
|
5785
5849
|
# resp.db_cluster_snapshot.port #=> Integer
|
@@ -6046,6 +6110,7 @@ module Aws::RDS
|
|
6046
6110
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
6047
6111
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
6048
6112
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
6113
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
6049
6114
|
#
|
6050
6115
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance AWS API Documentation
|
6051
6116
|
#
|
@@ -6480,6 +6545,9 @@ module Aws::RDS
|
|
6480
6545
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
6481
6546
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
6482
6547
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
6548
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
6549
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
6550
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
6483
6551
|
#
|
6484
6552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteGlobalCluster AWS API Documentation
|
6485
6553
|
#
|
@@ -7464,6 +7532,7 @@ module Aws::RDS
|
|
7464
7532
|
# resp.db_cluster_snapshots[0].db_cluster_identifier #=> String
|
7465
7533
|
# resp.db_cluster_snapshots[0].snapshot_create_time #=> Time
|
7466
7534
|
# resp.db_cluster_snapshots[0].engine #=> String
|
7535
|
+
# resp.db_cluster_snapshots[0].engine_mode #=> String
|
7467
7536
|
# resp.db_cluster_snapshots[0].allocated_storage #=> Integer
|
7468
7537
|
# resp.db_cluster_snapshots[0].status #=> String
|
7469
7538
|
# resp.db_cluster_snapshots[0].port #=> Integer
|
@@ -7697,6 +7766,36 @@ module Aws::RDS
|
|
7697
7766
|
# @option params [String] :engine
|
7698
7767
|
# The database engine to return.
|
7699
7768
|
#
|
7769
|
+
# Valid Values:
|
7770
|
+
#
|
7771
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
7772
|
+
#
|
7773
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
7774
|
+
#
|
7775
|
+
# * `aurora-postgresql`
|
7776
|
+
#
|
7777
|
+
# * `mariadb`
|
7778
|
+
#
|
7779
|
+
# * `mysql`
|
7780
|
+
#
|
7781
|
+
# * `oracle-ee`
|
7782
|
+
#
|
7783
|
+
# * `oracle-se2`
|
7784
|
+
#
|
7785
|
+
# * `oracle-se1`
|
7786
|
+
#
|
7787
|
+
# * `oracle-se`
|
7788
|
+
#
|
7789
|
+
# * `postgres`
|
7790
|
+
#
|
7791
|
+
# * `sqlserver-ee`
|
7792
|
+
#
|
7793
|
+
# * `sqlserver-se`
|
7794
|
+
#
|
7795
|
+
# * `sqlserver-ex`
|
7796
|
+
#
|
7797
|
+
# * `sqlserver-web`
|
7798
|
+
#
|
7700
7799
|
# @option params [String] :engine_version
|
7701
7800
|
# The database engine version to return.
|
7702
7801
|
#
|
@@ -7822,6 +7921,10 @@ module Aws::RDS
|
|
7822
7921
|
# resp.db_engine_versions[0].valid_upgrade_target[0].description #=> String
|
7823
7922
|
# resp.db_engine_versions[0].valid_upgrade_target[0].auto_upgrade #=> Boolean
|
7824
7923
|
# resp.db_engine_versions[0].valid_upgrade_target[0].is_major_version_upgrade #=> Boolean
|
7924
|
+
# resp.db_engine_versions[0].valid_upgrade_target[0].supported_engine_modes #=> Array
|
7925
|
+
# resp.db_engine_versions[0].valid_upgrade_target[0].supported_engine_modes[0] #=> String
|
7926
|
+
# resp.db_engine_versions[0].valid_upgrade_target[0].supports_parallel_query #=> Boolean
|
7927
|
+
# resp.db_engine_versions[0].valid_upgrade_target[0].supports_global_databases #=> Boolean
|
7825
7928
|
# resp.db_engine_versions[0].supported_timezones #=> Array
|
7826
7929
|
# resp.db_engine_versions[0].supported_timezones[0].timezone_name #=> String
|
7827
7930
|
# resp.db_engine_versions[0].exportable_log_types #=> Array
|
@@ -8192,6 +8295,7 @@ module Aws::RDS
|
|
8192
8295
|
# resp.db_instances[0].db_instance_automated_backups_replications #=> Array
|
8193
8296
|
# resp.db_instances[0].db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
8194
8297
|
# resp.db_instances[0].customer_owned_ip_enabled #=> Boolean
|
8298
|
+
# resp.db_instances[0].aws_backup_recovery_point_arn #=> String
|
8195
8299
|
#
|
8196
8300
|
#
|
8197
8301
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -9847,6 +9951,9 @@ module Aws::RDS
|
|
9847
9951
|
# resp.global_clusters[0].global_cluster_members[0].readers[0] #=> String
|
9848
9952
|
# resp.global_clusters[0].global_cluster_members[0].is_writer #=> Boolean
|
9849
9953
|
# resp.global_clusters[0].global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
9954
|
+
# resp.global_clusters[0].failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
9955
|
+
# resp.global_clusters[0].failover_state.from_db_cluster_arn #=> String
|
9956
|
+
# resp.global_clusters[0].failover_state.to_db_cluster_arn #=> String
|
9850
9957
|
#
|
9851
9958
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeGlobalClusters AWS API Documentation
|
9852
9959
|
#
|
@@ -9939,6 +10046,30 @@ module Aws::RDS
|
|
9939
10046
|
# A required parameter. Options available for the given engine name are
|
9940
10047
|
# described.
|
9941
10048
|
#
|
10049
|
+
# Valid Values:
|
10050
|
+
#
|
10051
|
+
# * `mariadb`
|
10052
|
+
#
|
10053
|
+
# * `mysql`
|
10054
|
+
#
|
10055
|
+
# * `oracle-ee`
|
10056
|
+
#
|
10057
|
+
# * `oracle-se2`
|
10058
|
+
#
|
10059
|
+
# * `oracle-se1`
|
10060
|
+
#
|
10061
|
+
# * `oracle-se`
|
10062
|
+
#
|
10063
|
+
# * `postgres`
|
10064
|
+
#
|
10065
|
+
# * `sqlserver-ee`
|
10066
|
+
#
|
10067
|
+
# * `sqlserver-se`
|
10068
|
+
#
|
10069
|
+
# * `sqlserver-ex`
|
10070
|
+
#
|
10071
|
+
# * `sqlserver-web`
|
10072
|
+
#
|
9942
10073
|
# @option params [String] :major_engine_version
|
9943
10074
|
# If specified, filters the results to include only options for the
|
9944
10075
|
# specified major engine version.
|
@@ -10070,6 +10201,30 @@ module Aws::RDS
|
|
10070
10201
|
# Filters the list of option groups to only include groups associated
|
10071
10202
|
# with a specific database engine.
|
10072
10203
|
#
|
10204
|
+
# Valid Values:
|
10205
|
+
#
|
10206
|
+
# * `mariadb`
|
10207
|
+
#
|
10208
|
+
# * `mysql`
|
10209
|
+
#
|
10210
|
+
# * `oracle-ee`
|
10211
|
+
#
|
10212
|
+
# * `oracle-se2`
|
10213
|
+
#
|
10214
|
+
# * `oracle-se1`
|
10215
|
+
#
|
10216
|
+
# * `oracle-se`
|
10217
|
+
#
|
10218
|
+
# * `postgres`
|
10219
|
+
#
|
10220
|
+
# * `sqlserver-ee`
|
10221
|
+
#
|
10222
|
+
# * `sqlserver-se`
|
10223
|
+
#
|
10224
|
+
# * `sqlserver-ex`
|
10225
|
+
#
|
10226
|
+
# * `sqlserver-web`
|
10227
|
+
#
|
10073
10228
|
# @option params [String] :major_engine_version
|
10074
10229
|
# Filters the list of option groups to only include groups associated
|
10075
10230
|
# with a specific database engine version. If specified, then EngineName
|
@@ -10162,6 +10317,36 @@ module Aws::RDS
|
|
10162
10317
|
# @option params [required, String] :engine
|
10163
10318
|
# The name of the engine to retrieve DB instance options for.
|
10164
10319
|
#
|
10320
|
+
# Valid Values:
|
10321
|
+
#
|
10322
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
10323
|
+
#
|
10324
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
10325
|
+
#
|
10326
|
+
# * `aurora-postgresql`
|
10327
|
+
#
|
10328
|
+
# * `mariadb`
|
10329
|
+
#
|
10330
|
+
# * `mysql`
|
10331
|
+
#
|
10332
|
+
# * `oracle-ee`
|
10333
|
+
#
|
10334
|
+
# * `oracle-se2`
|
10335
|
+
#
|
10336
|
+
# * `oracle-se1`
|
10337
|
+
#
|
10338
|
+
# * `oracle-se`
|
10339
|
+
#
|
10340
|
+
# * `postgres`
|
10341
|
+
#
|
10342
|
+
# * `sqlserver-ee`
|
10343
|
+
#
|
10344
|
+
# * `sqlserver-se`
|
10345
|
+
#
|
10346
|
+
# * `sqlserver-ex`
|
10347
|
+
#
|
10348
|
+
# * `sqlserver-web`
|
10349
|
+
#
|
10165
10350
|
# @option params [String] :engine_version
|
10166
10351
|
# The engine version filter value. Specify this parameter to show only
|
10167
10352
|
# the available offerings matching the specified engine version.
|
@@ -11097,6 +11282,93 @@ module Aws::RDS
|
|
11097
11282
|
req.send_request(options)
|
11098
11283
|
end
|
11099
11284
|
|
11285
|
+
# Initiates the failover process for an Aurora global database
|
11286
|
+
# (GlobalCluster).
|
11287
|
+
#
|
11288
|
+
# A failover for an Aurora global database promotes one of secondary
|
11289
|
+
# read-only DB clusters to be the primary DB cluster and demotes the
|
11290
|
+
# primary DB cluster to being a secondary (read-only) DB cluster. In
|
11291
|
+
# other words, the role of the current primary DB cluster and the
|
11292
|
+
# selected (target) DB cluster are switched. The selected secondary DB
|
11293
|
+
# cluster assumes full read/write capabilities for the Aurora global
|
11294
|
+
# database.
|
11295
|
+
#
|
11296
|
+
# For more information about failing over an Amazon Aurora global
|
11297
|
+
# database, see [Managed planned failover for Amazon Aurora global
|
11298
|
+
# databases][1] in the *Amazon Aurora User Guide.*
|
11299
|
+
#
|
11300
|
+
# <note markdown="1"> This action applies to GlobalCluster (Aurora global databases) only.
|
11301
|
+
# Use this action only on healthy Aurora global databases with running
|
11302
|
+
# Aurora DB clusters and no Region-wide outages, to test disaster
|
11303
|
+
# recovery scenarios or to reconfigure your Aurora global database
|
11304
|
+
# topology.
|
11305
|
+
#
|
11306
|
+
# </note>
|
11307
|
+
#
|
11308
|
+
#
|
11309
|
+
#
|
11310
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.managed-failover
|
11311
|
+
#
|
11312
|
+
# @option params [required, String] :global_cluster_identifier
|
11313
|
+
# Identifier of the Aurora global database (GlobalCluster) that should
|
11314
|
+
# be failed over. The identifier is the unique key assigned by the user
|
11315
|
+
# when the Aurora global database was created. In other words, it's the
|
11316
|
+
# name of the Aurora global database that you want to fail over.
|
11317
|
+
#
|
11318
|
+
# Constraints:
|
11319
|
+
#
|
11320
|
+
# * Must match the identifier of an existing GlobalCluster (Aurora
|
11321
|
+
# global database).
|
11322
|
+
#
|
11323
|
+
# ^
|
11324
|
+
#
|
11325
|
+
# @option params [required, String] :target_db_cluster_identifier
|
11326
|
+
# Identifier of the secondary Aurora DB cluster that you want to promote
|
11327
|
+
# to primary for the Aurora global database (GlobalCluster.) Use the
|
11328
|
+
# Amazon Resource Name (ARN) for the identifier so that Aurora can
|
11329
|
+
# locate the cluster in its AWS Region.
|
11330
|
+
#
|
11331
|
+
# @return [Types::FailoverGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11332
|
+
#
|
11333
|
+
# * {Types::FailoverGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
11334
|
+
#
|
11335
|
+
# @example Request syntax with placeholder values
|
11336
|
+
#
|
11337
|
+
# resp = client.failover_global_cluster({
|
11338
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
11339
|
+
# target_db_cluster_identifier: "DBClusterIdentifier", # required
|
11340
|
+
# })
|
11341
|
+
#
|
11342
|
+
# @example Response structure
|
11343
|
+
#
|
11344
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
11345
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
11346
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
11347
|
+
# resp.global_cluster.status #=> String
|
11348
|
+
# resp.global_cluster.engine #=> String
|
11349
|
+
# resp.global_cluster.engine_version #=> String
|
11350
|
+
# resp.global_cluster.database_name #=> String
|
11351
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
11352
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
11353
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
11354
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
11355
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
11356
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
11357
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
11358
|
+
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
11359
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
11360
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
11361
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
11362
|
+
#
|
11363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalCluster AWS API Documentation
|
11364
|
+
#
|
11365
|
+
# @overload failover_global_cluster(params = {})
|
11366
|
+
# @param [Hash] params ({})
|
11367
|
+
def failover_global_cluster(params = {}, options = {})
|
11368
|
+
req = build_request(:failover_global_cluster, params)
|
11369
|
+
req.send_request(options)
|
11370
|
+
end
|
11371
|
+
|
11100
11372
|
# Imports the installation media for a DB engine that requires an
|
11101
11373
|
# on-premises customer provided license, such as SQL Server.
|
11102
11374
|
#
|
@@ -11717,12 +11989,19 @@ module Aws::RDS
|
|
11717
11989
|
# snapshots of the DB cluster. The default is not to copy them.
|
11718
11990
|
#
|
11719
11991
|
# @option params [Boolean] :enable_global_write_forwarding
|
11720
|
-
# A value that indicates whether to enable
|
11721
|
-
#
|
11722
|
-
#
|
11723
|
-
#
|
11724
|
-
#
|
11725
|
-
#
|
11992
|
+
# A value that indicates whether to enable this DB cluster to forward
|
11993
|
+
# write operations to the primary cluster of an Aurora global database
|
11994
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
11995
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
11996
|
+
# database.
|
11997
|
+
#
|
11998
|
+
# You can set this value only on Aurora DB clusters that are members of
|
11999
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
12000
|
+
# cluster can forward writes to the current primary cluster and the
|
12001
|
+
# resulting changes are replicated back to this cluster. For the primary
|
12002
|
+
# DB cluster of an Aurora global database, this value is used
|
12003
|
+
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
12004
|
+
# operation, but it does nothing until then.
|
11726
12005
|
#
|
11727
12006
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11728
12007
|
#
|
@@ -12778,6 +13057,14 @@ module Aws::RDS
|
|
12778
13057
|
# The upper limit to which Amazon RDS can automatically scale the
|
12779
13058
|
# storage of the DB instance.
|
12780
13059
|
#
|
13060
|
+
# For more information about this setting, including limitations that
|
13061
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
13062
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
13063
|
+
#
|
13064
|
+
#
|
13065
|
+
#
|
13066
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
13067
|
+
#
|
12781
13068
|
# @option params [Boolean] :certificate_rotation_restart
|
12782
13069
|
# A value that indicates whether the DB instance is restarted when you
|
12783
13070
|
# rotate your SSL/TLS certificate.
|
@@ -12846,6 +13133,9 @@ module Aws::RDS
|
|
12846
13133
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
12847
13134
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
12848
13135
|
#
|
13136
|
+
# @option params [String] :aws_backup_recovery_point_arn
|
13137
|
+
# The Amazon Resource Name (ARN) of the recovery point in AWS Backup.
|
13138
|
+
#
|
12849
13139
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12850
13140
|
#
|
12851
13141
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -12927,6 +13217,7 @@ module Aws::RDS
|
|
12927
13217
|
# certificate_rotation_restart: false,
|
12928
13218
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
12929
13219
|
# enable_customer_owned_ip: false,
|
13220
|
+
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
12930
13221
|
# })
|
12931
13222
|
#
|
12932
13223
|
# @example Response structure
|
@@ -13054,6 +13345,7 @@ module Aws::RDS
|
|
13054
13345
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
13055
13346
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
13056
13347
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
13348
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
13057
13349
|
#
|
13058
13350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance AWS API Documentation
|
13059
13351
|
#
|
@@ -13836,6 +14128,9 @@ module Aws::RDS
|
|
13836
14128
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
13837
14129
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
13838
14130
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
14131
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
14132
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
14133
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
13839
14134
|
#
|
13840
14135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyGlobalCluster AWS API Documentation
|
13841
14136
|
#
|
@@ -14187,6 +14482,7 @@ module Aws::RDS
|
|
14187
14482
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
14188
14483
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
14189
14484
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
14485
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
14190
14486
|
#
|
14191
14487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica AWS API Documentation
|
14192
14488
|
#
|
@@ -14599,6 +14895,7 @@ module Aws::RDS
|
|
14599
14895
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
14600
14896
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
14601
14897
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
14898
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
14602
14899
|
#
|
14603
14900
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance AWS API Documentation
|
14604
14901
|
#
|
@@ -14705,6 +15002,9 @@ module Aws::RDS
|
|
14705
15002
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
14706
15003
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
14707
15004
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
15005
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
15006
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
15007
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
14708
15008
|
#
|
14709
15009
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveFromGlobalCluster AWS API Documentation
|
14710
15010
|
#
|
@@ -16936,6 +17236,7 @@ module Aws::RDS
|
|
16936
17236
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
16937
17237
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
16938
17238
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
17239
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
16939
17240
|
#
|
16940
17241
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot AWS API Documentation
|
16941
17242
|
#
|
@@ -17318,6 +17619,14 @@ module Aws::RDS
|
|
17318
17619
|
# The upper limit to which Amazon RDS can automatically scale the
|
17319
17620
|
# storage of the DB instance.
|
17320
17621
|
#
|
17622
|
+
# For more information about this setting, including limitations that
|
17623
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
17624
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
17625
|
+
#
|
17626
|
+
#
|
17627
|
+
#
|
17628
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
17629
|
+
#
|
17321
17630
|
# @return [Types::RestoreDBInstanceFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
17322
17631
|
#
|
17323
17632
|
# * {Types::RestoreDBInstanceFromS3Result#db_instance #db_instance} => Types::DBInstance
|
@@ -17506,6 +17815,7 @@ module Aws::RDS
|
|
17506
17815
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
17507
17816
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
17508
17817
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
17818
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
17509
17819
|
#
|
17510
17820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation
|
17511
17821
|
#
|
@@ -17825,6 +18135,14 @@ module Aws::RDS
|
|
17825
18135
|
# The upper limit to which Amazon RDS can automatically scale the
|
17826
18136
|
# storage of the DB instance.
|
17827
18137
|
#
|
18138
|
+
# For more information about this setting, including limitations that
|
18139
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
18140
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
18141
|
+
#
|
18142
|
+
#
|
18143
|
+
#
|
18144
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
18145
|
+
#
|
17828
18146
|
# @option params [String] :source_db_instance_automated_backups_arn
|
17829
18147
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
17830
18148
|
# from which to restore, for example,
|
@@ -18124,6 +18442,7 @@ module Aws::RDS
|
|
18124
18442
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
18125
18443
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
18126
18444
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
18445
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
18127
18446
|
#
|
18128
18447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime AWS API Documentation
|
18129
18448
|
#
|
@@ -18568,6 +18887,7 @@ module Aws::RDS
|
|
18568
18887
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
18569
18888
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
18570
18889
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
18890
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
18571
18891
|
#
|
18572
18892
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance AWS API Documentation
|
18573
18893
|
#
|
@@ -19131,6 +19451,7 @@ module Aws::RDS
|
|
19131
19451
|
# resp.db_instance.db_instance_automated_backups_replications #=> Array
|
19132
19452
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
19133
19453
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
19454
|
+
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
19134
19455
|
#
|
19135
19456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance AWS API Documentation
|
19136
19457
|
#
|
@@ -19218,7 +19539,7 @@ module Aws::RDS
|
|
19218
19539
|
params: params,
|
19219
19540
|
config: config)
|
19220
19541
|
context[:gem_name] = 'aws-sdk-rds'
|
19221
|
-
context[:gem_version] = '1.
|
19542
|
+
context[:gem_version] = '1.115.0'
|
19222
19543
|
Seahorse::Client::Request.new(handlers, context)
|
19223
19544
|
end
|
19224
19545
|
|