aws-sdk-rds 1.277.0 → 1.300.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 +115 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1790 -1463
- data/lib/aws-sdk-rds/client_api.rb +244 -156
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +404 -335
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +25 -25
- data/lib/aws-sdk-rds/db_engine_version.rb +55 -55
- data/lib/aws-sdk-rds/db_instance.rb +452 -353
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +91 -66
- data/lib/aws-sdk-rds/db_subnet_group.rb +4 -1
- data/lib/aws-sdk-rds/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-rds/errors.rb +11 -1
- data/lib/aws-sdk-rds/option_group.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +257 -236
- data/lib/aws-sdk-rds/types.rb +1559 -1153
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +115 -102
- data/sig/db_cluster.rbs +72 -61
- data/sig/db_cluster_snapshot.rbs +6 -6
- data/sig/db_engine_version.rbs +21 -21
- data/sig/db_instance.rbs +50 -44
- data/sig/db_snapshot.rbs +17 -12
- data/sig/errors.rbs +2 -0
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +24 -21
- data/sig/types.rbs +140 -115
- metadata +4 -4
|
@@ -346,7 +346,7 @@ module Aws::RDS
|
|
|
346
346
|
# parameters: [ # required
|
|
347
347
|
# {
|
|
348
348
|
# parameter_name: "String",
|
|
349
|
-
# parameter_value: "
|
|
349
|
+
# parameter_value: "PotentiallySensitiveParameterValue",
|
|
350
350
|
# description: "String",
|
|
351
351
|
# source: "String",
|
|
352
352
|
# apply_type: "String",
|
|
@@ -411,7 +411,7 @@ module Aws::RDS
|
|
|
411
411
|
# parameters: [
|
|
412
412
|
# {
|
|
413
413
|
# parameter_name: "String",
|
|
414
|
-
# parameter_value: "
|
|
414
|
+
# parameter_value: "PotentiallySensitiveParameterValue",
|
|
415
415
|
# description: "String",
|
|
416
416
|
# source: "String",
|
|
417
417
|
# apply_type: "String",
|
|
@@ -127,6 +127,12 @@ module Aws::RDS
|
|
|
127
127
|
data[:iops]
|
|
128
128
|
end
|
|
129
129
|
|
|
130
|
+
# Specifies the storage throughput for the DB snapshot.
|
|
131
|
+
# @return [Integer]
|
|
132
|
+
def storage_throughput
|
|
133
|
+
data[:storage_throughput]
|
|
134
|
+
end
|
|
135
|
+
|
|
130
136
|
# Provides the option group name for the DB snapshot.
|
|
131
137
|
# @return [String]
|
|
132
138
|
def option_group_name
|
|
@@ -234,6 +240,13 @@ module Aws::RDS
|
|
|
234
240
|
data[:tag_list]
|
|
235
241
|
end
|
|
236
242
|
|
|
243
|
+
# Specifies where manual snapshots are stored: Dedicated Local Zones,
|
|
244
|
+
# Amazon Web Services Outposts or the Amazon Web Services Region.
|
|
245
|
+
# @return [String]
|
|
246
|
+
def snapshot_target
|
|
247
|
+
data[:snapshot_target]
|
|
248
|
+
end
|
|
249
|
+
|
|
237
250
|
# Specifies the time of the CreateDBSnapshot operation in Coordinated
|
|
238
251
|
# Universal Time (UTC). Doesn't change when the snapshot is copied.
|
|
239
252
|
# @return [Time]
|
|
@@ -256,19 +269,6 @@ module Aws::RDS
|
|
|
256
269
|
data[:snapshot_database_time]
|
|
257
270
|
end
|
|
258
271
|
|
|
259
|
-
# Specifies where manual snapshots are stored: Amazon Web Services
|
|
260
|
-
# Outposts or the Amazon Web Services Region.
|
|
261
|
-
# @return [String]
|
|
262
|
-
def snapshot_target
|
|
263
|
-
data[:snapshot_target]
|
|
264
|
-
end
|
|
265
|
-
|
|
266
|
-
# Specifies the storage throughput for the DB snapshot.
|
|
267
|
-
# @return [Integer]
|
|
268
|
-
def storage_throughput
|
|
269
|
-
data[:storage_throughput]
|
|
270
|
-
end
|
|
271
|
-
|
|
272
272
|
# The Oracle system identifier (SID), which is the name of the Oracle
|
|
273
273
|
# database instance that manages your database files. The Oracle SID is
|
|
274
274
|
# also the name of your CDB.
|
|
@@ -277,6 +277,14 @@ module Aws::RDS
|
|
|
277
277
|
data[:db_system_id]
|
|
278
278
|
end
|
|
279
279
|
|
|
280
|
+
# Indicates whether the snapshot is of a DB instance using the
|
|
281
|
+
# multi-tenant configuration (TRUE) or the single-tenant configuration
|
|
282
|
+
# (FALSE).
|
|
283
|
+
# @return [Boolean]
|
|
284
|
+
def multi_tenant
|
|
285
|
+
data[:multi_tenant]
|
|
286
|
+
end
|
|
287
|
+
|
|
280
288
|
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
281
289
|
# enabled.
|
|
282
290
|
# @return [Boolean]
|
|
@@ -284,12 +292,12 @@ module Aws::RDS
|
|
|
284
292
|
data[:dedicated_log_volume]
|
|
285
293
|
end
|
|
286
294
|
|
|
287
|
-
#
|
|
288
|
-
#
|
|
289
|
-
#
|
|
290
|
-
# @return [
|
|
291
|
-
def
|
|
292
|
-
data[:
|
|
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]
|
|
293
301
|
end
|
|
294
302
|
|
|
295
303
|
# @!endgroup
|
|
@@ -481,10 +489,12 @@ module Aws::RDS
|
|
|
481
489
|
# },
|
|
482
490
|
# ],
|
|
483
491
|
# copy_tags: false,
|
|
484
|
-
# pre_signed_url: "
|
|
492
|
+
# pre_signed_url: "SensitiveString",
|
|
485
493
|
# option_group_name: "String",
|
|
486
494
|
# target_custom_availability_zone: "String",
|
|
495
|
+
# snapshot_target: "String",
|
|
487
496
|
# copy_option_group: false,
|
|
497
|
+
# snapshot_availability_zone: "String",
|
|
488
498
|
# source_region: "String",
|
|
489
499
|
# })
|
|
490
500
|
# @param [Hash] options ({})
|
|
@@ -626,11 +636,25 @@ module Aws::RDS
|
|
|
626
636
|
# CAZ.
|
|
627
637
|
#
|
|
628
638
|
# Example: `rds-caz-aiqhTgQv`.
|
|
639
|
+
# @option options [String] :snapshot_target
|
|
640
|
+
# Configures the location where RDS will store copied snapshots.
|
|
641
|
+
#
|
|
642
|
+
# Valid Values:
|
|
643
|
+
#
|
|
644
|
+
# * `local` (Dedicated Local Zone)
|
|
645
|
+
#
|
|
646
|
+
# * `outposts` (Amazon Web Services Outposts)
|
|
647
|
+
#
|
|
648
|
+
# * `region` (Amazon Web Services Region)
|
|
629
649
|
# @option options [Boolean] :copy_option_group
|
|
630
650
|
# Specifies whether to copy the DB option group associated with the
|
|
631
651
|
# source DB snapshot to the target Amazon Web Services account and
|
|
632
652
|
# associate with the target DB snapshot. The associated option group can
|
|
633
653
|
# be copied only with cross-account snapshot copy calls.
|
|
654
|
+
# @option options [String] :snapshot_availability_zone
|
|
655
|
+
# Specifies the name of the Availability Zone where RDS stores the DB
|
|
656
|
+
# snapshot. This value is valid only for snapshots that RDS stores on a
|
|
657
|
+
# Dedicated Local Zone.
|
|
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.
|
|
@@ -681,6 +705,7 @@ module Aws::RDS
|
|
|
681
705
|
# db_name: "String",
|
|
682
706
|
# engine: "String",
|
|
683
707
|
# iops: 1,
|
|
708
|
+
# storage_throughput: 1,
|
|
684
709
|
# option_group_name: "String",
|
|
685
710
|
# tags: [
|
|
686
711
|
# {
|
|
@@ -690,7 +715,7 @@ module Aws::RDS
|
|
|
690
715
|
# ],
|
|
691
716
|
# storage_type: "String",
|
|
692
717
|
# tde_credential_arn: "String",
|
|
693
|
-
# tde_credential_password: "
|
|
718
|
+
# tde_credential_password: "SensitiveString",
|
|
694
719
|
# vpc_security_group_ids: ["String"],
|
|
695
720
|
# domain: "String",
|
|
696
721
|
# domain_fqdn: "String",
|
|
@@ -711,12 +736,11 @@ module Aws::RDS
|
|
|
711
736
|
# db_parameter_group_name: "String",
|
|
712
737
|
# deletion_protection: false,
|
|
713
738
|
# enable_customer_owned_ip: false,
|
|
714
|
-
# custom_iam_instance_profile: "String",
|
|
715
|
-
# backup_target: "String",
|
|
716
739
|
# network_type: "String",
|
|
717
|
-
#
|
|
718
|
-
#
|
|
740
|
+
# backup_target: "String",
|
|
741
|
+
# custom_iam_instance_profile: "String",
|
|
719
742
|
# allocated_storage: 1,
|
|
743
|
+
# db_cluster_snapshot_identifier: "String",
|
|
720
744
|
# dedicated_log_volume: false,
|
|
721
745
|
# ca_certificate_identifier: "String",
|
|
722
746
|
# engine_lifecycle_support: "String",
|
|
@@ -813,7 +837,7 @@ module Aws::RDS
|
|
|
813
837
|
# License model information for the restored DB instance.
|
|
814
838
|
#
|
|
815
839
|
# <note markdown="1"> License models for RDS for Db2 require additional configuration. The
|
|
816
|
-
#
|
|
840
|
+
# bring your own license (BYOL) model requires a custom parameter group
|
|
817
841
|
# and an Amazon Web Services License Manager self-managed license. The
|
|
818
842
|
# Db2 license through Amazon Web Services Marketplace model requires an
|
|
819
843
|
# Amazon Web Services Marketplace subscription. For more information,
|
|
@@ -905,6 +929,10 @@ module Aws::RDS
|
|
|
905
929
|
#
|
|
906
930
|
#
|
|
907
931
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
|
932
|
+
# @option options [Integer] :storage_throughput
|
|
933
|
+
# Specifies the storage throughput value for the DB instance.
|
|
934
|
+
#
|
|
935
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
908
936
|
# @option options [String] :option_group_name
|
|
909
937
|
# The name of the option group to be used for the restored DB instance.
|
|
910
938
|
#
|
|
@@ -1114,33 +1142,32 @@ module Aws::RDS
|
|
|
1114
1142
|
#
|
|
1115
1143
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
1116
1144
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
1117
|
-
# @option options [String] :
|
|
1118
|
-
# The
|
|
1119
|
-
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
1120
|
-
# the following requirements:
|
|
1145
|
+
# @option options [String] :network_type
|
|
1146
|
+
# The network type of the DB instance.
|
|
1121
1147
|
#
|
|
1122
|
-
#
|
|
1148
|
+
# Valid Values:
|
|
1123
1149
|
#
|
|
1124
|
-
# *
|
|
1125
|
-
# assume.
|
|
1150
|
+
# * `IPV4`
|
|
1126
1151
|
#
|
|
1127
|
-
# *
|
|
1128
|
-
# start with the prefix `AWSRDSCustom`.
|
|
1152
|
+
# * `DUAL`
|
|
1129
1153
|
#
|
|
1130
|
-
#
|
|
1131
|
-
#
|
|
1154
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
1155
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
1156
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
1132
1157
|
#
|
|
1133
|
-
#
|
|
1158
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
1159
|
+
# the *Amazon RDS User Guide.*
|
|
1134
1160
|
#
|
|
1135
1161
|
#
|
|
1136
1162
|
#
|
|
1137
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
1163
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
1138
1164
|
# @option options [String] :backup_target
|
|
1139
1165
|
# Specifies where automated backups and manual snapshots are stored for
|
|
1140
1166
|
# the restored DB instance.
|
|
1141
1167
|
#
|
|
1142
|
-
# Possible values are `
|
|
1143
|
-
# `region` (Amazon Web Services Region). The
|
|
1168
|
+
# Possible values are `local` (Dedicated Local Zone), `outposts` (Amazon
|
|
1169
|
+
# Web Services Outposts), and `region` (Amazon Web Services Region). The
|
|
1170
|
+
# default is `region`.
|
|
1144
1171
|
#
|
|
1145
1172
|
# For more information, see [Working with Amazon RDS on Amazon Web
|
|
1146
1173
|
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
|
@@ -1148,29 +1175,38 @@ module Aws::RDS
|
|
|
1148
1175
|
#
|
|
1149
1176
|
#
|
|
1150
1177
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
1151
|
-
# @option options [String] :
|
|
1152
|
-
# The
|
|
1178
|
+
# @option options [String] :custom_iam_instance_profile
|
|
1179
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
1180
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
1181
|
+
# the following requirements:
|
|
1153
1182
|
#
|
|
1154
|
-
#
|
|
1183
|
+
# * The profile must exist in your account.
|
|
1155
1184
|
#
|
|
1156
|
-
# *
|
|
1185
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
1186
|
+
# assume.
|
|
1157
1187
|
#
|
|
1158
|
-
# *
|
|
1188
|
+
# * The instance profile name and the associated IAM role name must
|
|
1189
|
+
# start with the prefix `AWSRDSCustom`.
|
|
1159
1190
|
#
|
|
1160
|
-
#
|
|
1161
|
-
#
|
|
1162
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
1191
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
1192
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
1163
1193
|
#
|
|
1164
|
-
#
|
|
1165
|
-
# the *Amazon RDS User Guide.*
|
|
1194
|
+
# This setting is required for RDS Custom.
|
|
1166
1195
|
#
|
|
1167
1196
|
#
|
|
1168
1197
|
#
|
|
1169
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
1170
|
-
# @option options [Integer] :
|
|
1171
|
-
#
|
|
1198
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
1199
|
+
# @option options [Integer] :allocated_storage
|
|
1200
|
+
# The amount of storage (in gibibytes) to allocate initially for the DB
|
|
1201
|
+
# instance. Follow the allocation rules specified in CreateDBInstance.
|
|
1172
1202
|
#
|
|
1173
|
-
# This setting
|
|
1203
|
+
# This setting isn't valid for RDS for SQL Server.
|
|
1204
|
+
#
|
|
1205
|
+
# <note markdown="1"> Be sure to allocate enough storage for your new DB instance so that
|
|
1206
|
+
# the restore operation can succeed. You can also allocate additional
|
|
1207
|
+
# storage for future growth.
|
|
1208
|
+
#
|
|
1209
|
+
# </note>
|
|
1174
1210
|
# @option options [String] :db_cluster_snapshot_identifier
|
|
1175
1211
|
# The identifier for the Multi-AZ DB cluster snapshot to restore from.
|
|
1176
1212
|
#
|
|
@@ -1195,17 +1231,6 @@ module Aws::RDS
|
|
|
1195
1231
|
#
|
|
1196
1232
|
#
|
|
1197
1233
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
|
1198
|
-
# @option options [Integer] :allocated_storage
|
|
1199
|
-
# The amount of storage (in gibibytes) to allocate initially for the DB
|
|
1200
|
-
# instance. Follow the allocation rules specified in CreateDBInstance.
|
|
1201
|
-
#
|
|
1202
|
-
# This setting isn't valid for RDS for SQL Server.
|
|
1203
|
-
#
|
|
1204
|
-
# <note markdown="1"> Be sure to allocate enough storage for your new DB instance so that
|
|
1205
|
-
# the restore operation can succeed. You can also allocate additional
|
|
1206
|
-
# storage for future growth.
|
|
1207
|
-
#
|
|
1208
|
-
# </note>
|
|
1209
1234
|
# @option options [Boolean] :dedicated_log_volume
|
|
1210
1235
|
# Specifies whether to enable a dedicated log volume (DLV) for the DB
|
|
1211
1236
|
# instance.
|
|
@@ -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]
|
|
@@ -13,22 +13,22 @@ module Aws::RDS
|
|
|
13
13
|
# @!attribute region
|
|
14
14
|
# The AWS region used to dispatch the request.
|
|
15
15
|
#
|
|
16
|
-
# @return [
|
|
16
|
+
# @return [string]
|
|
17
17
|
#
|
|
18
18
|
# @!attribute use_dual_stack
|
|
19
19
|
# When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
|
|
20
20
|
#
|
|
21
|
-
# @return [
|
|
21
|
+
# @return [boolean]
|
|
22
22
|
#
|
|
23
23
|
# @!attribute use_fips
|
|
24
24
|
# When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
|
|
25
25
|
#
|
|
26
|
-
# @return [
|
|
26
|
+
# @return [boolean]
|
|
27
27
|
#
|
|
28
28
|
# @!attribute endpoint
|
|
29
29
|
# Override the endpoint used to send this request
|
|
30
30
|
#
|
|
31
|
-
# @return [
|
|
31
|
+
# @return [string]
|
|
32
32
|
#
|
|
33
33
|
EndpointParameters = Struct.new(
|
|
34
34
|
:region,
|
data/lib/aws-sdk-rds/errors.rb
CHANGED
|
@@ -240,10 +240,10 @@ module Aws::RDS
|
|
|
240
240
|
# * This error class is not used. `TenantDatabaseQuotaExceeded` is used during parsing instead.
|
|
241
241
|
# * {UnsupportedDBEngineVersionFault}
|
|
242
242
|
# * This error class is not used. `UnsupportedDBEngineVersion` is used during parsing instead.
|
|
243
|
+
# * {VpcEncryptionControlViolationException}
|
|
243
244
|
#
|
|
244
245
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
|
245
246
|
# if they are not defined above.
|
|
246
|
-
# Some existing error classes may use a different class name than the one documented.
|
|
247
247
|
module Errors
|
|
248
248
|
|
|
249
249
|
extend Aws::Errors::DynamicErrors
|
|
@@ -1834,5 +1834,15 @@ module Aws::RDS
|
|
|
1834
1834
|
end
|
|
1835
1835
|
end
|
|
1836
1836
|
|
|
1837
|
+
class VpcEncryptionControlViolationException < ServiceError
|
|
1838
|
+
|
|
1839
|
+
# @param [Seahorse::Client::RequestContext] context
|
|
1840
|
+
# @param [String] message
|
|
1841
|
+
# @param [Aws::RDS::Types::VpcEncryptionControlViolationException] data
|
|
1842
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
|
1843
|
+
super(context, message, data)
|
|
1844
|
+
end
|
|
1845
|
+
end
|
|
1846
|
+
|
|
1837
1847
|
end
|
|
1838
1848
|
end
|