aws-sdk-rds 1.277.0 → 1.282.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/CHANGELOG.md +25 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +180 -54
- data/lib/aws-sdk-rds/client_api.rb +7 -0
- data/lib/aws-sdk-rds/db_cluster.rb +8 -0
- data/lib/aws-sdk-rds/db_instance.rb +111 -37
- data/lib/aws-sdk-rds/db_snapshot.rb +29 -4
- data/lib/aws-sdk-rds/db_subnet_group.rb +4 -1
- data/lib/aws-sdk-rds/resource.rb +2 -0
- data/lib/aws-sdk-rds/types.rb +201 -68
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +3 -0
- data/sig/db_cluster.rbs +3 -0
- data/sig/db_instance.rbs +1 -0
- data/sig/db_snapshot.rbs +5 -0
- data/sig/types.rbs +5 -0
- metadata +4 -4
@@ -227,17 +227,20 @@ module Aws::RDS
|
|
227
227
|
data[:read_replica_db_cluster_identifiers]
|
228
228
|
end
|
229
229
|
|
230
|
-
# The open mode of an Oracle read replica. The default is
|
231
|
-
# `open-read-only`. For more information, see [Working with
|
232
|
-
#
|
230
|
+
# The open mode of a Db2 or an Oracle read replica. The default is
|
231
|
+
# `open-read-only`. For more information, see [Working with read
|
232
|
+
# replicas for Amazon RDS for Db2][1] and [Working with read replicas
|
233
|
+
# for Amazon RDS for Oracle][2] in the *Amazon RDS User Guide*.
|
233
234
|
#
|
234
|
-
# <note markdown="1"> This attribute is only supported in RDS for Oracle
|
235
|
+
# <note markdown="1"> This attribute is only supported in RDS for Db2, RDS for Oracle, and
|
236
|
+
# RDS Custom for Oracle.
|
235
237
|
#
|
236
238
|
# </note>
|
237
239
|
#
|
238
240
|
#
|
239
241
|
#
|
240
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
242
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
243
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
241
244
|
# @return [String]
|
242
245
|
def replica_mode
|
243
246
|
data[:replica_mode]
|
@@ -694,7 +697,8 @@ module Aws::RDS
|
|
694
697
|
end
|
695
698
|
|
696
699
|
# The location where automated backups and manual snapshots are stored:
|
697
|
-
# Amazon Web Services Outposts or the Amazon Web
|
700
|
+
# Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web
|
701
|
+
# Services Region.
|
698
702
|
# @return [String]
|
699
703
|
def backup_target
|
700
704
|
data[:backup_target]
|
@@ -2121,6 +2125,8 @@ module Aws::RDS
|
|
2121
2125
|
#
|
2122
2126
|
# Valid Values:
|
2123
2127
|
#
|
2128
|
+
# * `local` (Dedicated Local Zone)
|
2129
|
+
#
|
2124
2130
|
# * `outposts` (Amazon Web Services Outposts)
|
2125
2131
|
#
|
2126
2132
|
# * `region` (Amazon Web Services Region)
|
@@ -2332,6 +2338,7 @@ module Aws::RDS
|
|
2332
2338
|
# network_type: "String",
|
2333
2339
|
# storage_throughput: 1,
|
2334
2340
|
# enable_customer_owned_ip: false,
|
2341
|
+
# backup_target: "String",
|
2335
2342
|
# allocated_storage: 1,
|
2336
2343
|
# source_db_cluster_identifier: "String",
|
2337
2344
|
# dedicated_log_volume: false,
|
@@ -2411,6 +2418,16 @@ module Aws::RDS
|
|
2411
2418
|
# The name of the DB parameter group to associate with this read replica
|
2412
2419
|
# DB instance.
|
2413
2420
|
#
|
2421
|
+
# For the Db2 DB engine, if your source DB instance uses the Bring Your
|
2422
|
+
# Own License model, then a custom parameter group must be associated
|
2423
|
+
# with the replica. For a same Amazon Web Services Region replica, if
|
2424
|
+
# you don't specify a custom parameter group, Amazon RDS associates the
|
2425
|
+
# custom parameter group associated with the source DB instance. For a
|
2426
|
+
# cross-Region replica, you must specify a custom parameter group. This
|
2427
|
+
# custom parameter group must include your IBM Site ID and IBM Customer
|
2428
|
+
# ID. For more information, see [ IBM IDs for Bring Your Own License for
|
2429
|
+
# Db2][1].
|
2430
|
+
#
|
2414
2431
|
# For Single-AZ or Multi-AZ DB instance read replica instances, if you
|
2415
2432
|
# don't specify a value for `DBParameterGroupName`, then Amazon RDS
|
2416
2433
|
# uses the `DBParameterGroup` of the source DB instance for a same
|
@@ -2423,9 +2440,9 @@ module Aws::RDS
|
|
2423
2440
|
#
|
2424
2441
|
# Specifying a parameter group for this operation is only supported for
|
2425
2442
|
# MySQL DB instances for cross-Region read replicas, for Multi-AZ DB
|
2426
|
-
# cluster read replica instances,
|
2427
|
-
# supported for MySQL DB instances for same
|
2428
|
-
# RDS Custom.
|
2443
|
+
# cluster read replica instances, for Db2 DB instances, and for Oracle
|
2444
|
+
# DB instances. It isn't supported for MySQL DB instances for same
|
2445
|
+
# Region read replicas or for RDS Custom.
|
2429
2446
|
#
|
2430
2447
|
# Constraints:
|
2431
2448
|
#
|
@@ -2434,6 +2451,10 @@ module Aws::RDS
|
|
2434
2451
|
# * First character must be a letter.
|
2435
2452
|
#
|
2436
2453
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
2454
|
+
#
|
2455
|
+
#
|
2456
|
+
#
|
2457
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html#db2-prereqs-ibm-info
|
2437
2458
|
# @option options [Boolean] :publicly_accessible
|
2438
2459
|
# Specifies whether the DB instance is publicly accessible.
|
2439
2460
|
#
|
@@ -2782,31 +2803,50 @@ module Aws::RDS
|
|
2782
2803
|
#
|
2783
2804
|
# Example: `123.124.125.126,234.235.236.237`
|
2784
2805
|
# @option options [String] :replica_mode
|
2785
|
-
# The open mode of the replica database
|
2806
|
+
# The open mode of the replica database.
|
2786
2807
|
#
|
2787
|
-
# <note markdown="1"> This parameter is only supported for
|
2808
|
+
# <note markdown="1"> This parameter is only supported for Db2 DB instances and Oracle DB
|
2809
|
+
# instances.
|
2788
2810
|
#
|
2789
2811
|
# </note>
|
2790
2812
|
#
|
2791
|
-
#
|
2792
|
-
# Edition. The main use case for mounted replicas is cross-Region
|
2793
|
-
# disaster recovery. The primary database doesn't use Active Data Guard
|
2794
|
-
# to transmit information to the mounted replica. Because it doesn't
|
2795
|
-
# accept user connections, a mounted replica can't serve a read-only
|
2796
|
-
# workload.
|
2813
|
+
# Db2
|
2797
2814
|
#
|
2798
|
-
#
|
2799
|
-
#
|
2800
|
-
#
|
2801
|
-
#
|
2815
|
+
# : Standby DB replicas are included in Db2 Advanced Edition (AE) and
|
2816
|
+
# Db2 Standard Edition (SE). The main use case for standby replicas is
|
2817
|
+
# cross-Region disaster recovery. Because it doesn't accept user
|
2818
|
+
# connections, a standby replica can't serve a read-only workload.
|
2819
|
+
#
|
2820
|
+
# You can create a combination of standby and read-only DB replicas
|
2821
|
+
# for the same primary DB instance. For more information, see [Working
|
2822
|
+
# with read replicas for Amazon RDS for Db2][1] in the *Amazon RDS
|
2823
|
+
# User Guide*.
|
2824
|
+
#
|
2825
|
+
# To create standby DB replicas for RDS for Db2, set this parameter to
|
2826
|
+
# `mounted`.
|
2827
|
+
#
|
2828
|
+
# Oracle
|
2802
2829
|
#
|
2803
|
-
#
|
2804
|
-
#
|
2805
|
-
#
|
2830
|
+
# : Mounted DB replicas are included in Oracle Database Enterprise
|
2831
|
+
# Edition. The main use case for mounted replicas is cross-Region
|
2832
|
+
# disaster recovery. The primary database doesn't use Active Data
|
2833
|
+
# Guard to transmit information to the mounted replica. Because it
|
2834
|
+
# doesn't accept user connections, a mounted replica can't serve a
|
2835
|
+
# read-only workload.
|
2806
2836
|
#
|
2837
|
+
# You can create a combination of mounted and read-only DB replicas
|
2838
|
+
# for the same primary DB instance. For more information, see [Working
|
2839
|
+
# with read replicas for Amazon RDS for Oracle][2] in the *Amazon RDS
|
2840
|
+
# User Guide*.
|
2807
2841
|
#
|
2842
|
+
# For RDS Custom, you must specify this parameter and set it to
|
2843
|
+
# `mounted`. The value won't be set by default. After replica
|
2844
|
+
# creation, you can manage the open mode manually.
|
2808
2845
|
#
|
2809
|
-
#
|
2846
|
+
#
|
2847
|
+
#
|
2848
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
2849
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
2810
2850
|
# @option options [Integer] :max_allocated_storage
|
2811
2851
|
# The upper limit in gibibytes (GiB) to which Amazon RDS can
|
2812
2852
|
# automatically scale the storage of the DB instance.
|
@@ -2883,6 +2923,14 @@ module Aws::RDS
|
|
2883
2923
|
#
|
2884
2924
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2885
2925
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
2926
|
+
# @option options [String] :backup_target
|
2927
|
+
# The location where RDS stores automated backups and manual snapshots.
|
2928
|
+
#
|
2929
|
+
# Valid Values:
|
2930
|
+
#
|
2931
|
+
# * `local` for Dedicated Local Zones
|
2932
|
+
#
|
2933
|
+
# * `region` for Amazon Web Services Region
|
2886
2934
|
# @option options [Integer] :allocated_storage
|
2887
2935
|
# The amount of storage (in gibibytes) to allocate initially for the
|
2888
2936
|
# read replica. Follow the allocation rules specified in
|
@@ -3986,26 +4034,50 @@ module Aws::RDS
|
|
3986
4034
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
3987
4035
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
3988
4036
|
# @option options [String] :replica_mode
|
3989
|
-
#
|
3990
|
-
# mounted or read-only.
|
4037
|
+
# The open mode of a replica database.
|
3991
4038
|
#
|
3992
|
-
# <note markdown="1">
|
4039
|
+
# <note markdown="1"> This parameter is only supported for Db2 DB instances and Oracle DB
|
4040
|
+
# instances.
|
3993
4041
|
#
|
3994
4042
|
# </note>
|
3995
4043
|
#
|
3996
|
-
#
|
3997
|
-
# main use case for mounted replicas is cross-Region disaster recovery.
|
3998
|
-
# The primary database doesn't use Active Data Guard to transmit
|
3999
|
-
# information to the mounted replica. Because it doesn't accept user
|
4000
|
-
# connections, a mounted replica can't serve a read-only workload. For
|
4001
|
-
# more information, see [Working with Oracle Read Replicas for Amazon
|
4002
|
-
# RDS][1] in the *Amazon RDS User Guide*.
|
4044
|
+
# Db2
|
4003
4045
|
#
|
4004
|
-
#
|
4046
|
+
# : Standby DB replicas are included in Db2 Advanced Edition (AE) and
|
4047
|
+
# Db2 Standard Edition (SE). The main use case for standby replicas is
|
4048
|
+
# cross-Region disaster recovery. Because it doesn't accept user
|
4049
|
+
# connections, a standby replica can't serve a read-only workload.
|
4050
|
+
#
|
4051
|
+
# You can create a combination of standby and read-only DB replicas
|
4052
|
+
# for the same primary DB instance. For more information, see [Working
|
4053
|
+
# with read replicas for Amazon RDS for Db2][1] in the *Amazon RDS
|
4054
|
+
# User Guide*.
|
4005
4055
|
#
|
4056
|
+
# To create standby DB replicas for RDS for Db2, set this parameter to
|
4057
|
+
# `mounted`.
|
4006
4058
|
#
|
4059
|
+
# Oracle
|
4007
4060
|
#
|
4008
|
-
#
|
4061
|
+
# : Mounted DB replicas are included in Oracle Database Enterprise
|
4062
|
+
# Edition. The main use case for mounted replicas is cross-Region
|
4063
|
+
# disaster recovery. The primary database doesn't use Active Data
|
4064
|
+
# Guard to transmit information to the mounted replica. Because it
|
4065
|
+
# doesn't accept user connections, a mounted replica can't serve a
|
4066
|
+
# read-only workload.
|
4067
|
+
#
|
4068
|
+
# You can create a combination of mounted and read-only DB replicas
|
4069
|
+
# for the same primary DB instance. For more information, see [Working
|
4070
|
+
# with read replicas for Amazon RDS for Oracle][2] in the *Amazon RDS
|
4071
|
+
# User Guide*.
|
4072
|
+
#
|
4073
|
+
# For RDS Custom, you must specify this parameter and set it to
|
4074
|
+
# `mounted`. The value won't be set by default. After replica
|
4075
|
+
# creation, you can manage the open mode manually.
|
4076
|
+
#
|
4077
|
+
#
|
4078
|
+
#
|
4079
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
4080
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
4009
4081
|
# @option options [Boolean] :enable_customer_owned_ip
|
4010
4082
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
4011
4083
|
# RDS on Outposts DB instance.
|
@@ -4817,6 +4889,8 @@ module Aws::RDS
|
|
4817
4889
|
#
|
4818
4890
|
# Valid Values:
|
4819
4891
|
#
|
4892
|
+
# * `local` (Dedicated Local Zone)
|
4893
|
+
#
|
4820
4894
|
# * `outposts` (Amazon Web Services Outposts)
|
4821
4895
|
#
|
4822
4896
|
# * `region` (Amazon Web Services Region)
|
@@ -256,8 +256,8 @@ module Aws::RDS
|
|
256
256
|
data[:snapshot_database_time]
|
257
257
|
end
|
258
258
|
|
259
|
-
# Specifies where manual snapshots are stored:
|
260
|
-
# Outposts or the Amazon Web Services Region.
|
259
|
+
# Specifies where manual snapshots are stored: Dedicated Local Zones,
|
260
|
+
# Amazon Web Services Outposts or the Amazon Web Services Region.
|
261
261
|
# @return [String]
|
262
262
|
def snapshot_target
|
263
263
|
data[:snapshot_target]
|
@@ -292,6 +292,14 @@ module Aws::RDS
|
|
292
292
|
data[:multi_tenant]
|
293
293
|
end
|
294
294
|
|
295
|
+
# Specifies the name of the Availability Zone where RDS stores the DB
|
296
|
+
# snapshot. This value is valid only for snapshots that RDS stores on a
|
297
|
+
# Dedicated Local Zone.
|
298
|
+
# @return [String]
|
299
|
+
def snapshot_availability_zone
|
300
|
+
data[:snapshot_availability_zone]
|
301
|
+
end
|
302
|
+
|
295
303
|
# @!endgroup
|
296
304
|
|
297
305
|
# @return [Client]
|
@@ -485,6 +493,8 @@ module Aws::RDS
|
|
485
493
|
# option_group_name: "String",
|
486
494
|
# target_custom_availability_zone: "String",
|
487
495
|
# copy_option_group: false,
|
496
|
+
# snapshot_availability_zone: "String",
|
497
|
+
# snapshot_target: "String",
|
488
498
|
# source_region: "String",
|
489
499
|
# })
|
490
500
|
# @param [Hash] options ({})
|
@@ -631,6 +641,20 @@ module Aws::RDS
|
|
631
641
|
# source DB snapshot to the target Amazon Web Services account and
|
632
642
|
# associate with the target DB snapshot. The associated option group can
|
633
643
|
# be copied only with cross-account snapshot copy calls.
|
644
|
+
# @option options [String] :snapshot_availability_zone
|
645
|
+
# Specifies the name of the Availability Zone where RDS stores the DB
|
646
|
+
# snapshot. This value is valid only for snapshots that RDS stores on a
|
647
|
+
# Dedicated Local Zone.
|
648
|
+
# @option options [String] :snapshot_target
|
649
|
+
# Configures the location where RDS will store copied snapshots.
|
650
|
+
#
|
651
|
+
# Valid Values:
|
652
|
+
#
|
653
|
+
# * `local` (Dedicated Local Zone)
|
654
|
+
#
|
655
|
+
# * `outposts` (Amazon Web Services Outposts)
|
656
|
+
#
|
657
|
+
# * `region` (Amazon Web Services Region)
|
634
658
|
# @option options [String] :source_region
|
635
659
|
# The source region of the snapshot. This is only needed when the
|
636
660
|
# shapshot is encrypted and in a different region.
|
@@ -1139,8 +1163,9 @@ module Aws::RDS
|
|
1139
1163
|
# Specifies where automated backups and manual snapshots are stored for
|
1140
1164
|
# the restored DB instance.
|
1141
1165
|
#
|
1142
|
-
# Possible values are `
|
1143
|
-
# `region` (Amazon Web Services Region). The
|
1166
|
+
# Possible values are `local` (Dedicated Local Zone), `outposts` (Amazon
|
1167
|
+
# Web Services Outposts), and `region` (Amazon Web Services Region). The
|
1168
|
+
# default is `region`.
|
1144
1169
|
#
|
1145
1170
|
# For more information, see [Working with Amazon RDS on Amazon Web
|
1146
1171
|
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
@@ -53,7 +53,10 @@ module Aws::RDS
|
|
53
53
|
data[:subnet_group_status]
|
54
54
|
end
|
55
55
|
|
56
|
-
# Contains a list of `Subnet` elements.
|
56
|
+
# Contains a list of `Subnet` elements. The list of subnets shown here
|
57
|
+
# might not reflect the current state of your VPC. For the most
|
58
|
+
# up-to-date information, we recommend checking your VPC configuration
|
59
|
+
# directly.
|
57
60
|
# @return [Array<Types::Subnet>]
|
58
61
|
def subnets
|
59
62
|
data[:subnets]
|