aws-sdk-rds 1.194.0 → 1.196.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/certificate.rb +2 -1
- data/lib/aws-sdk-rds/client.rb +450 -398
- data/lib/aws-sdk-rds/client_api.rb +1 -0
- data/lib/aws-sdk-rds/db_cluster.rb +44 -43
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +3 -4
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +45 -50
- data/lib/aws-sdk-rds/db_engine.rb +12 -15
- data/lib/aws-sdk-rds/db_engine_version.rb +14 -14
- data/lib/aws-sdk-rds/db_instance.rb +218 -174
- data/lib/aws-sdk-rds/db_parameter_group.rb +3 -3
- data/lib/aws-sdk-rds/db_snapshot.rb +33 -30
- data/lib/aws-sdk-rds/event_subscription.rb +5 -5
- data/lib/aws-sdk-rds/option_group.rb +2 -3
- data/lib/aws-sdk-rds/option_group_option.rb +2 -2
- data/lib/aws-sdk-rds/parameter.rb +2 -2
- data/lib/aws-sdk-rds/reserved_db_instance.rb +1 -1
- data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +30 -32
- data/lib/aws-sdk-rds/types.rb +630 -573
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
@@ -1264,7 +1264,8 @@ module Aws::RDS
|
|
1264
1264
|
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
1265
1265
|
#
|
1266
1266
|
# * Can include any printable ASCII character except "/", """, or
|
1267
|
-
# "@".
|
1267
|
+
# "@". For RDS for Oracle, can't include the "&" (ampersand)
|
1268
|
+
# or the "'" (single quotes) character.
|
1268
1269
|
#
|
1269
1270
|
# Length Constraints:
|
1270
1271
|
#
|
@@ -2146,7 +2147,7 @@ module Aws::RDS
|
|
2146
2147
|
# of DB instance classes, and availability for your engine, see [DB
|
2147
2148
|
# Instance Class][1] in the *Amazon RDS User Guide*.
|
2148
2149
|
#
|
2149
|
-
# Default: Inherits from the source DB instance.
|
2150
|
+
# Default: Inherits the value from the source DB instance.
|
2150
2151
|
#
|
2151
2152
|
#
|
2152
2153
|
#
|
@@ -2161,12 +2162,11 @@ module Aws::RDS
|
|
2161
2162
|
# @option options [Integer] :port
|
2162
2163
|
# The port number that the DB instance uses for connections.
|
2163
2164
|
#
|
2164
|
-
# Default: Inherits from the source DB instance
|
2165
|
-
#
|
2166
2165
|
# Valid Values: `1150-65535`
|
2166
|
+
#
|
2167
|
+
# Default: Inherits the value from the source DB instance.
|
2167
2168
|
# @option options [Boolean] :multi_az
|
2168
|
-
#
|
2169
|
-
# deployment.
|
2169
|
+
# Specifies whether the read replica is in a Multi-AZ deployment.
|
2170
2170
|
#
|
2171
2171
|
# You can create a read replica as a Multi-AZ DB instance. RDS creates a
|
2172
2172
|
# standby of your replica in another Availability Zone for failover
|
@@ -2174,47 +2174,50 @@ module Aws::RDS
|
|
2174
2174
|
# instance is independent of whether the source is a Multi-AZ DB
|
2175
2175
|
# instance or a Multi-AZ DB cluster.
|
2176
2176
|
#
|
2177
|
-
# This setting doesn't apply to RDS Custom.
|
2177
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2178
2178
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2179
|
-
#
|
2180
|
-
#
|
2179
|
+
# Specifies whether to automatically apply minor engine upgrades to the
|
2180
|
+
# read replica during the maintenance window.
|
2181
2181
|
#
|
2182
|
-
# This setting doesn't apply to RDS Custom.
|
2182
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2183
2183
|
#
|
2184
|
-
# Default: Inherits from the source DB instance
|
2184
|
+
# Default: Inherits the value from the source DB instance.
|
2185
2185
|
# @option options [Integer] :iops
|
2186
2186
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
2187
|
-
#
|
2187
|
+
# initially allocate for the DB instance.
|
2188
2188
|
# @option options [String] :option_group_name
|
2189
|
-
# The option group the DB instance
|
2190
|
-
# option group associated with the source instance or
|
2189
|
+
# The option group to associate the DB instance with. If not specified,
|
2190
|
+
# RDS uses the option group associated with the source DB instance or
|
2191
|
+
# cluster.
|
2191
2192
|
#
|
2192
2193
|
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
2193
2194
|
# source.
|
2194
2195
|
#
|
2195
2196
|
# </note>
|
2196
2197
|
#
|
2197
|
-
# This setting doesn't apply to RDS Custom.
|
2198
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2198
2199
|
# @option options [String] :db_parameter_group_name
|
2199
2200
|
# The name of the DB parameter group to associate with this DB instance.
|
2200
2201
|
#
|
2201
|
-
# If you
|
2202
|
-
# RDS uses the `DBParameterGroup` of source DB instance for a same
|
2202
|
+
# If you don't specify a value for `DBParameterGroupName`, then Amazon
|
2203
|
+
# RDS uses the `DBParameterGroup` of the source DB instance for a same
|
2203
2204
|
# Region read replica, or the default `DBParameterGroup` for the
|
2204
2205
|
# specified DB engine for a cross-Region read replica.
|
2205
2206
|
#
|
2206
2207
|
# Specifying a parameter group for this operation is only supported for
|
2207
|
-
# MySQL
|
2208
|
+
# MySQL DB instances for cross-Region read replicas and for Oracle DB
|
2209
|
+
# instances. It isn't supported for MySQL DB instances for same Region
|
2210
|
+
# read replicas or for RDS Custom.
|
2208
2211
|
#
|
2209
2212
|
# Constraints:
|
2210
2213
|
#
|
2211
2214
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
2212
2215
|
#
|
2213
|
-
# * First character must be a letter
|
2216
|
+
# * First character must be a letter.
|
2214
2217
|
#
|
2215
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
2218
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
2216
2219
|
# @option options [Boolean] :publicly_accessible
|
2217
|
-
#
|
2220
|
+
# Specifies whether the DB instance is publicly accessible.
|
2218
2221
|
#
|
2219
2222
|
# When the DB cluster is publicly accessible, its Domain Name System
|
2220
2223
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -2236,20 +2239,19 @@ module Aws::RDS
|
|
2236
2239
|
#
|
2237
2240
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
2238
2241
|
# @option options [String] :db_subnet_group_name
|
2239
|
-
#
|
2240
|
-
#
|
2241
|
-
#
|
2242
|
-
# a VPC.
|
2242
|
+
# A DB subnet group for the DB instance. The new DB instance is created
|
2243
|
+
# in the VPC associated with the DB subnet group. If no DB subnet group
|
2244
|
+
# is specified, then the new DB instance isn't created in a VPC.
|
2243
2245
|
#
|
2244
2246
|
# Constraints:
|
2245
2247
|
#
|
2246
|
-
# * If supplied, must match the name of an existing
|
2248
|
+
# * If supplied, must match the name of an existing DB subnet group.
|
2247
2249
|
#
|
2248
2250
|
# * The specified DB subnet group must be in the same Amazon Web
|
2249
2251
|
# Services Region in which the operation is running.
|
2250
2252
|
#
|
2251
2253
|
# * All read replicas in one Amazon Web Services Region that are created
|
2252
|
-
# from the same source DB instance must either
|
2254
|
+
# from the same source DB instance must either:
|
2253
2255
|
#
|
2254
2256
|
# * Specify DB subnet groups from the same VPC. All these read
|
2255
2257
|
# replicas are created in the same VPC.
|
@@ -2262,33 +2264,35 @@ module Aws::RDS
|
|
2262
2264
|
# A list of Amazon EC2 VPC security groups to associate with the read
|
2263
2265
|
# replica.
|
2264
2266
|
#
|
2265
|
-
# This setting doesn't apply to RDS Custom.
|
2267
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2266
2268
|
#
|
2267
2269
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
2268
2270
|
# VPC.
|
2269
2271
|
# @option options [String] :storage_type
|
2270
|
-
#
|
2271
|
-
#
|
2272
|
-
# Valid values: `gp2 | gp3 | io1 | standard`
|
2272
|
+
# The storage type to associate with the read replica.
|
2273
2273
|
#
|
2274
2274
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
2275
2275
|
# `Iops` parameter.
|
2276
2276
|
#
|
2277
|
-
#
|
2277
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
2278
|
+
#
|
2279
|
+
# Default: `io1` if the `Iops` parameter is specified. Otherwise, `gp2`.
|
2278
2280
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2279
|
-
#
|
2280
|
-
#
|
2281
|
+
# Specifies whether to copy all tags from the read replica to snapshots
|
2282
|
+
# of the read replica. By default, tags aren't copied.
|
2281
2283
|
# @option options [Integer] :monitoring_interval
|
2282
2284
|
# The interval, in seconds, between points when Enhanced Monitoring
|
2283
|
-
# metrics are collected for the read replica. To disable
|
2284
|
-
# Enhanced Monitoring metrics, specify 0
|
2285
|
+
# metrics are collected for the read replica. To disable collection of
|
2286
|
+
# Enhanced Monitoring metrics, specify `0`. The default is `0`.
|
2285
2287
|
#
|
2286
|
-
# If `MonitoringRoleArn` is specified, then you must
|
2287
|
-
# `MonitoringInterval` to a value other than 0
|
2288
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
2289
|
+
# `MonitoringInterval` to a value other than `0`.
|
2288
2290
|
#
|
2289
|
-
# This setting doesn't apply to RDS Custom.
|
2291
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2290
2292
|
#
|
2291
2293
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
2294
|
+
#
|
2295
|
+
# Default: `0`
|
2292
2296
|
# @option options [String] :monitoring_role_arn
|
2293
2297
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
2294
2298
|
# metrics to Amazon CloudWatch Logs. For example,
|
@@ -2299,7 +2303,7 @@ module Aws::RDS
|
|
2299
2303
|
# If `MonitoringInterval` is set to a value other than 0, then you must
|
2300
2304
|
# supply a `MonitoringRoleArn` value.
|
2301
2305
|
#
|
2302
|
-
# This setting doesn't apply to RDS Custom.
|
2306
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2303
2307
|
#
|
2304
2308
|
#
|
2305
2309
|
#
|
@@ -2401,34 +2405,33 @@ module Aws::RDS
|
|
2401
2405
|
#
|
2402
2406
|
# </note>
|
2403
2407
|
#
|
2404
|
-
# This setting doesn't apply to RDS Custom.
|
2408
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2405
2409
|
#
|
2406
2410
|
#
|
2407
2411
|
#
|
2408
2412
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
2409
2413
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
2410
2414
|
# @option options [Boolean] :enable_iam_database_authentication
|
2411
|
-
#
|
2412
|
-
#
|
2413
|
-
#
|
2415
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
2416
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
2417
|
+
# mapping isn't enabled.
|
2414
2418
|
#
|
2415
2419
|
# For more information about IAM database authentication, see [ IAM
|
2416
2420
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
2417
2421
|
# RDS User Guide*.
|
2418
2422
|
#
|
2419
|
-
# This setting doesn't apply to RDS Custom.
|
2423
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2420
2424
|
#
|
2421
2425
|
#
|
2422
2426
|
#
|
2423
2427
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
2424
2428
|
# @option options [Boolean] :enable_performance_insights
|
2425
|
-
#
|
2426
|
-
# read replica.
|
2429
|
+
# Specifies whether to enable Performance Insights for the read replica.
|
2427
2430
|
#
|
2428
2431
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2429
2432
|
# the *Amazon RDS User Guide*.
|
2430
2433
|
#
|
2431
|
-
# This setting doesn't apply to RDS Custom.
|
2434
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2432
2435
|
#
|
2433
2436
|
#
|
2434
2437
|
#
|
@@ -2445,38 +2448,33 @@ module Aws::RDS
|
|
2445
2448
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
2446
2449
|
# a different default KMS key for each Amazon Web Services Region.
|
2447
2450
|
#
|
2448
|
-
# This setting doesn't apply to RDS Custom.
|
2451
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2449
2452
|
# @option options [Integer] :performance_insights_retention_period
|
2450
|
-
# The number of days to retain Performance Insights data.
|
2451
|
-
# 7 days. The following values are valid:
|
2452
|
-
#
|
2453
|
-
# * 7
|
2454
|
-
#
|
2455
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
2456
|
-
#
|
2457
|
-
# * 731
|
2453
|
+
# The number of days to retain Performance Insights data.
|
2458
2454
|
#
|
2459
|
-
#
|
2455
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2460
2456
|
#
|
2461
|
-
#
|
2457
|
+
# Valid Values:
|
2462
2458
|
#
|
2463
|
-
# *
|
2459
|
+
# * `7`
|
2464
2460
|
#
|
2465
|
-
# *
|
2461
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
2462
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
2463
|
+
# months * 31)
|
2466
2464
|
#
|
2467
|
-
# * 731
|
2465
|
+
# * `731`
|
2468
2466
|
#
|
2469
|
-
#
|
2470
|
-
# value, RDS issues an error.
|
2467
|
+
# Default: `7` days
|
2471
2468
|
#
|
2472
|
-
#
|
2469
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
2470
|
+
# Amazon RDS returns an error.
|
2473
2471
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
2474
2472
|
# The list of logs that the new DB instance is to export to CloudWatch
|
2475
2473
|
# Logs. The values in the list depend on the DB engine being used. For
|
2476
2474
|
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
2477
2475
|
# Logs ][1] in the *Amazon RDS User Guide*.
|
2478
2476
|
#
|
2479
|
-
# This setting doesn't apply to RDS Custom.
|
2477
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2480
2478
|
#
|
2481
2479
|
#
|
2482
2480
|
#
|
@@ -2485,17 +2483,17 @@ module Aws::RDS
|
|
2485
2483
|
# The number of CPU cores and the number of threads per core for the DB
|
2486
2484
|
# instance class of the DB instance.
|
2487
2485
|
#
|
2488
|
-
# This setting doesn't apply to RDS Custom.
|
2486
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2489
2487
|
# @option options [Boolean] :use_default_processor_features
|
2490
|
-
#
|
2491
|
-
#
|
2488
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
2489
|
+
# default processor features.
|
2492
2490
|
#
|
2493
|
-
# This setting doesn't apply to RDS Custom.
|
2491
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2494
2492
|
# @option options [Boolean] :deletion_protection
|
2495
|
-
#
|
2496
|
-
#
|
2497
|
-
#
|
2498
|
-
#
|
2493
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
2494
|
+
# The database can't be deleted when deletion protection is enabled. By
|
2495
|
+
# default, deletion protection isn't enabled. For more information, see
|
2496
|
+
# [ Deleting a DB Instance][1].
|
2499
2497
|
#
|
2500
2498
|
#
|
2501
2499
|
#
|
@@ -2508,16 +2506,16 @@ module Aws::RDS
|
|
2508
2506
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2509
2507
|
# RDS User Guide*.
|
2510
2508
|
#
|
2511
|
-
# This setting doesn't apply to RDS Custom.
|
2509
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2512
2510
|
#
|
2513
2511
|
#
|
2514
2512
|
#
|
2515
2513
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2516
2514
|
# @option options [String] :domain_iam_role_name
|
2517
|
-
# The name of the IAM role to
|
2518
|
-
#
|
2515
|
+
# The name of the IAM role to use when making API calls to the Directory
|
2516
|
+
# Service.
|
2519
2517
|
#
|
2520
|
-
# This setting doesn't apply to RDS Custom.
|
2518
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2521
2519
|
# @option options [String] :domain_fqdn
|
2522
2520
|
# The fully qualified domain name (FQDN) of an Active Directory domain.
|
2523
2521
|
#
|
@@ -2611,7 +2609,7 @@ module Aws::RDS
|
|
2611
2609
|
# For the list of permissions required for the IAM role, see [ Configure
|
2612
2610
|
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
2613
2611
|
#
|
2614
|
-
# This setting is required for RDS Custom.
|
2612
|
+
# This setting is required for RDS Custom DB instances.
|
2615
2613
|
#
|
2616
2614
|
#
|
2617
2615
|
#
|
@@ -2619,7 +2617,7 @@ module Aws::RDS
|
|
2619
2617
|
# @option options [String] :network_type
|
2620
2618
|
# The network type of the DB instance.
|
2621
2619
|
#
|
2622
|
-
# Valid
|
2620
|
+
# Valid Values:
|
2623
2621
|
#
|
2624
2622
|
# * `IPV4`
|
2625
2623
|
#
|
@@ -2638,10 +2636,11 @@ module Aws::RDS
|
|
2638
2636
|
# @option options [Integer] :storage_throughput
|
2639
2637
|
# Specifies the storage throughput value for the read replica.
|
2640
2638
|
#
|
2641
|
-
# This setting doesn't apply to RDS Custom or Amazon Aurora
|
2639
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
2640
|
+
# instances.
|
2642
2641
|
# @option options [Boolean] :enable_customer_owned_ip
|
2643
|
-
#
|
2644
|
-
#
|
2642
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
2643
|
+
# RDS on Outposts read replica.
|
2645
2644
|
#
|
2646
2645
|
# A *CoIP* provides local or external connectivity to resources in your
|
2647
2646
|
# Outpost subnets through your on-premises network. For some use cases,
|
@@ -2757,12 +2756,11 @@ module Aws::RDS
|
|
2757
2756
|
# })
|
2758
2757
|
# @param [Hash] options ({})
|
2759
2758
|
# @option options [Boolean] :skip_final_snapshot
|
2760
|
-
#
|
2761
|
-
#
|
2762
|
-
#
|
2763
|
-
#
|
2764
|
-
#
|
2765
|
-
# created.
|
2759
|
+
# Specifies whether to skip the creation of a final DB snapshot before
|
2760
|
+
# deleting the instance. If you enable this parameter, RDS doesn't
|
2761
|
+
# create a DB snapshot. If you don't enable this parameter, RDS creates
|
2762
|
+
# a DB snapshot before the DB instance is deleted. By default, skip
|
2763
|
+
# isn't enabled, and the DB snapshot is created.
|
2766
2764
|
#
|
2767
2765
|
# <note markdown="1"> If you don't enable this parameter, you must specify the
|
2768
2766
|
# `FinalDBSnapshotIdentifier` parameter.
|
@@ -2798,10 +2796,10 @@ module Aws::RDS
|
|
2798
2796
|
#
|
2799
2797
|
# * Can't be specified when deleting a read replica.
|
2800
2798
|
# @option options [Boolean] :delete_automated_backups
|
2801
|
-
#
|
2802
|
-
#
|
2803
|
-
#
|
2804
|
-
#
|
2799
|
+
# Specifies whether to remove automated backups immediately after the DB
|
2800
|
+
# instance is deleted. This parameter isn't case-sensitive. The default
|
2801
|
+
# is to remove automated backups immediately after the DB instance is
|
2802
|
+
# deleted.
|
2805
2803
|
# @return [DBInstance]
|
2806
2804
|
def delete(options = {})
|
2807
2805
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2913,6 +2911,17 @@ module Aws::RDS
|
|
2913
2911
|
#
|
2914
2912
|
# Default: Uses existing setting
|
2915
2913
|
#
|
2914
|
+
# Constraints:
|
2915
|
+
#
|
2916
|
+
# * If you are modifying the DB instance class and upgrading the engine
|
2917
|
+
# version at the same time, the currently running engine version must
|
2918
|
+
# be supported on the specified DB instance class. Otherwise, the
|
2919
|
+
# operation returns an error. In this case, first run the operation to
|
2920
|
+
# modify the DB instance class, and then run it again to upgrade the
|
2921
|
+
# engine version.
|
2922
|
+
#
|
2923
|
+
# ^
|
2924
|
+
#
|
2916
2925
|
#
|
2917
2926
|
#
|
2918
2927
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
@@ -3169,6 +3178,17 @@ module Aws::RDS
|
|
3169
3178
|
#
|
3170
3179
|
# In RDS Custom for Oracle, this parameter is supported for read
|
3171
3180
|
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
3181
|
+
#
|
3182
|
+
# Constraints:
|
3183
|
+
#
|
3184
|
+
# * If you are upgrading the engine version and modifying the DB
|
3185
|
+
# instance class at the same time, the currently running engine
|
3186
|
+
# version must be supported on the specified DB instance class.
|
3187
|
+
# Otherwise, the operation returns an error. In this case, first run
|
3188
|
+
# the operation to modify the DB instance class, and then run it again
|
3189
|
+
# to upgrade the engine version.
|
3190
|
+
#
|
3191
|
+
# ^
|
3172
3192
|
# @option options [Boolean] :allow_major_version_upgrade
|
3173
3193
|
# Specifies whether major version upgrades are allowed. Changing this
|
3174
3194
|
# parameter doesn't result in an outage and the change is
|
@@ -3906,8 +3926,7 @@ module Aws::RDS
|
|
3906
3926
|
# })
|
3907
3927
|
# @param [Hash] options ({})
|
3908
3928
|
# @option options [Boolean] :force_failover
|
3909
|
-
#
|
3910
|
-
# Multi-AZ failover.
|
3929
|
+
# Specifies whether the reboot is conducted through a Multi-AZ failover.
|
3911
3930
|
#
|
3912
3931
|
# Constraint: You can't enable force failover if the instance isn't
|
3913
3932
|
# configured for Multi-AZ.
|
@@ -3982,36 +4001,38 @@ module Aws::RDS
|
|
3982
4001
|
# })
|
3983
4002
|
# @param [Hash] options ({})
|
3984
4003
|
# @option options [required, String] :target_db_instance_identifier
|
3985
|
-
# The name of the new DB instance to
|
4004
|
+
# The name of the new DB instance to create.
|
3986
4005
|
#
|
3987
4006
|
# Constraints:
|
3988
4007
|
#
|
3989
|
-
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
4008
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
3990
4009
|
#
|
3991
|
-
# * First character must be a letter
|
4010
|
+
# * First character must be a letter.
|
3992
4011
|
#
|
3993
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
4012
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
3994
4013
|
# @option options [Time,DateTime,Date,Integer,String] :restore_time
|
3995
4014
|
# The date and time to restore from.
|
3996
4015
|
#
|
3997
|
-
# Valid Values: Value must be a time in Universal Coordinated Time (UTC)
|
3998
|
-
# format
|
3999
|
-
#
|
4000
4016
|
# Constraints:
|
4001
4017
|
#
|
4002
|
-
# * Must be
|
4018
|
+
# * Must be a time in Universal Coordinated Time (UTC) format.
|
4019
|
+
#
|
4020
|
+
# * Must be before the latest restorable time for the DB instance.
|
4003
4021
|
#
|
4004
4022
|
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
4005
|
-
# enabled
|
4023
|
+
# enabled.
|
4006
4024
|
#
|
4007
4025
|
# Example: `2009-09-07T23:45:00Z`
|
4008
4026
|
# @option options [Boolean] :use_latest_restorable_time
|
4009
|
-
#
|
4010
|
-
#
|
4011
|
-
#
|
4027
|
+
# Specifies whether the DB instance is restored from the latest backup
|
4028
|
+
# time. By default, the DB instance isn't restored from the latest
|
4029
|
+
# backup time.
|
4030
|
+
#
|
4031
|
+
# Constraints:
|
4032
|
+
#
|
4033
|
+
# * Can't be specified if the `RestoreTime` parameter is provided.
|
4012
4034
|
#
|
4013
|
-
#
|
4014
|
-
# provided.
|
4035
|
+
# ^
|
4015
4036
|
# @option options [String] :db_instance_class
|
4016
4037
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
4017
4038
|
# example db.m4.large. Not all DB instance classes are available in all
|
@@ -4019,7 +4040,7 @@ module Aws::RDS
|
|
4019
4040
|
# list of DB instance classes, and availability for your engine, see [DB
|
4020
4041
|
# Instance Class][1] in the *Amazon RDS User Guide*.
|
4021
4042
|
#
|
4022
|
-
# Default: The same
|
4043
|
+
# Default: The same DB instance class as the original DB instance.
|
4023
4044
|
#
|
4024
4045
|
#
|
4025
4046
|
#
|
@@ -4027,35 +4048,49 @@ module Aws::RDS
|
|
4027
4048
|
# @option options [Integer] :port
|
4028
4049
|
# The port number on which the database accepts connections.
|
4029
4050
|
#
|
4030
|
-
# Constraints: Value must be `1150-65535`
|
4031
|
-
#
|
4032
4051
|
# Default: The same port as the original DB instance.
|
4052
|
+
#
|
4053
|
+
# Constraints:
|
4054
|
+
#
|
4055
|
+
# * The value must be `1150-65535`.
|
4056
|
+
#
|
4057
|
+
# ^
|
4033
4058
|
# @option options [String] :availability_zone
|
4034
4059
|
# The Availability Zone (AZ) where the DB instance will be created.
|
4035
4060
|
#
|
4036
4061
|
# Default: A random, system-chosen Availability Zone.
|
4037
4062
|
#
|
4038
|
-
#
|
4039
|
-
#
|
4063
|
+
# Constraints:
|
4064
|
+
#
|
4065
|
+
# * You can't specify the `AvailabilityZone` parameter if the DB
|
4066
|
+
# instance is a Multi-AZ deployment.
|
4067
|
+
#
|
4068
|
+
# ^
|
4040
4069
|
#
|
4041
4070
|
# Example: `us-east-1a`
|
4042
4071
|
# @option options [String] :db_subnet_group_name
|
4043
4072
|
# The DB subnet group name to use for the new instance.
|
4044
4073
|
#
|
4045
|
-
# Constraints:
|
4046
|
-
#
|
4074
|
+
# Constraints:
|
4075
|
+
#
|
4076
|
+
# * If supplied, must match the name of an existing DB subnet group.
|
4077
|
+
#
|
4078
|
+
# ^
|
4047
4079
|
#
|
4048
4080
|
# Example: `mydbsubnetgroup`
|
4049
4081
|
# @option options [Boolean] :multi_az
|
4050
|
-
#
|
4051
|
-
# deployment.
|
4082
|
+
# Secifies whether the DB instance is a Multi-AZ deployment.
|
4052
4083
|
#
|
4053
4084
|
# This setting doesn't apply to RDS Custom.
|
4054
4085
|
#
|
4055
|
-
#
|
4056
|
-
#
|
4086
|
+
# Constraints:
|
4087
|
+
#
|
4088
|
+
# * You can't specify the `AvailabilityZone` parameter if the DB
|
4089
|
+
# instance is a Multi-AZ deployment.
|
4090
|
+
#
|
4091
|
+
# ^
|
4057
4092
|
# @option options [Boolean] :publicly_accessible
|
4058
|
-
#
|
4093
|
+
# Specifies whether the DB instance is publicly accessible.
|
4059
4094
|
#
|
4060
4095
|
# When the DB cluster is publicly accessible, its Domain Name System
|
4061
4096
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -4070,19 +4105,19 @@ module Aws::RDS
|
|
4070
4105
|
#
|
4071
4106
|
# For more information, see CreateDBInstance.
|
4072
4107
|
# @option options [Boolean] :auto_minor_version_upgrade
|
4073
|
-
#
|
4074
|
-
#
|
4108
|
+
# Specifies whether minor version upgrades are applied automatically to
|
4109
|
+
# the DB instance during the maintenance window.
|
4075
4110
|
#
|
4076
4111
|
# This setting doesn't apply to RDS Custom.
|
4077
4112
|
# @option options [String] :license_model
|
4078
|
-
#
|
4113
|
+
# The license model information for the restored DB instance.
|
4079
4114
|
#
|
4080
4115
|
# This setting doesn't apply to RDS Custom.
|
4081
4116
|
#
|
4082
|
-
#
|
4083
|
-
#
|
4084
|
-
# Valid values: `license-included` \| `bring-your-own-license` \|
|
4117
|
+
# Valid Values: `license-included` \| `bring-your-own-license` \|
|
4085
4118
|
# `general-public-license`
|
4119
|
+
#
|
4120
|
+
# Default: Same as the source.
|
4086
4121
|
# @option options [String] :db_name
|
4087
4122
|
# The database name for the restored DB instance.
|
4088
4123
|
#
|
@@ -4095,10 +4130,6 @@ module Aws::RDS
|
|
4095
4130
|
#
|
4096
4131
|
# This setting doesn't apply to RDS Custom.
|
4097
4132
|
#
|
4098
|
-
# Default: The same as source
|
4099
|
-
#
|
4100
|
-
# Constraint: Must be compatible with the engine of the source
|
4101
|
-
#
|
4102
4133
|
# Valid Values:
|
4103
4134
|
#
|
4104
4135
|
# * `mariadb`
|
@@ -4122,18 +4153,27 @@ module Aws::RDS
|
|
4122
4153
|
# * `sqlserver-ex`
|
4123
4154
|
#
|
4124
4155
|
# * `sqlserver-web`
|
4156
|
+
#
|
4157
|
+
# Default: The same as source
|
4158
|
+
#
|
4159
|
+
# Constraints:
|
4160
|
+
#
|
4161
|
+
# * Must be compatible with the engine of the source.
|
4162
|
+
#
|
4163
|
+
# ^
|
4125
4164
|
# @option options [Integer] :iops
|
4126
4165
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
4127
|
-
#
|
4166
|
+
# initially allocate for the DB instance.
|
4128
4167
|
#
|
4129
|
-
#
|
4168
|
+
# This setting doesn't apply to SQL Server.
|
4130
4169
|
#
|
4131
|
-
#
|
4170
|
+
# Constraints:
|
4171
|
+
#
|
4172
|
+
# * Must be an integer greater than 1000.
|
4132
4173
|
#
|
4133
|
-
#
|
4134
|
-
# supported.
|
4174
|
+
# ^
|
4135
4175
|
# @option options [String] :option_group_name
|
4136
|
-
# The name of the option group to
|
4176
|
+
# The name of the option group to use for the restored DB instance.
|
4137
4177
|
#
|
4138
4178
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
4139
4179
|
# TDE, can't be removed from an option group, and that option group
|
@@ -4142,9 +4182,8 @@ module Aws::RDS
|
|
4142
4182
|
#
|
4143
4183
|
# This setting doesn't apply to RDS Custom.
|
4144
4184
|
# @option options [Boolean] :copy_tags_to_snapshot
|
4145
|
-
#
|
4146
|
-
#
|
4147
|
-
# copied.
|
4185
|
+
# Specifies whether to copy all tags from the restored DB instance to
|
4186
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
4148
4187
|
# @option options [Array<Types::Tag>] :tags
|
4149
4188
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
4150
4189
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -4153,14 +4192,19 @@ module Aws::RDS
|
|
4153
4192
|
#
|
4154
4193
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
4155
4194
|
# @option options [String] :storage_type
|
4156
|
-
#
|
4195
|
+
# The storage type to associate with the DB instance.
|
4157
4196
|
#
|
4158
|
-
# Valid
|
4197
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
4159
4198
|
#
|
4160
|
-
#
|
4161
|
-
# `
|
4199
|
+
# Default: `io1`, if the `Iops` parameter is specified. Otherwise,
|
4200
|
+
# `gp2`.
|
4201
|
+
#
|
4202
|
+
# Constraints:
|
4203
|
+
#
|
4204
|
+
# * If you specify `io1` or `gp3`, you must also include a value for the
|
4205
|
+
# `Iops` parameter.
|
4162
4206
|
#
|
4163
|
-
#
|
4207
|
+
# ^
|
4164
4208
|
# @option options [String] :tde_credential_arn
|
4165
4209
|
# The ARN from the key store with which to associate the instance for
|
4166
4210
|
# TDE encryption.
|
@@ -4177,8 +4221,8 @@ module Aws::RDS
|
|
4177
4221
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
4178
4222
|
# VPC.
|
4179
4223
|
# @option options [String] :domain
|
4180
|
-
#
|
4181
|
-
#
|
4224
|
+
# The Active Directory directory ID to restore the DB instance in.
|
4225
|
+
# Create the domain before running this command. Currently, you can
|
4182
4226
|
# create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
4183
4227
|
# instances in an Active Directory Domain.
|
4184
4228
|
#
|
@@ -4242,9 +4286,9 @@ module Aws::RDS
|
|
4242
4286
|
#
|
4243
4287
|
# Example: `123.124.125.126,234.235.236.237`
|
4244
4288
|
# @option options [Boolean] :enable_iam_database_authentication
|
4245
|
-
#
|
4246
|
-
#
|
4247
|
-
#
|
4289
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
4290
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
4291
|
+
# mapping isn't enabled.
|
4248
4292
|
#
|
4249
4293
|
# This setting doesn't apply to RDS Custom.
|
4250
4294
|
#
|
@@ -4272,8 +4316,8 @@ module Aws::RDS
|
|
4272
4316
|
#
|
4273
4317
|
# This setting doesn't apply to RDS Custom.
|
4274
4318
|
# @option options [Boolean] :use_default_processor_features
|
4275
|
-
#
|
4276
|
-
#
|
4319
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
4320
|
+
# default processor features.
|
4277
4321
|
#
|
4278
4322
|
# This setting doesn't apply to RDS Custom.
|
4279
4323
|
# @option options [String] :db_parameter_group_name
|
@@ -4286,7 +4330,7 @@ module Aws::RDS
|
|
4286
4330
|
#
|
4287
4331
|
# Constraints:
|
4288
4332
|
#
|
4289
|
-
# * If supplied, must match the name of an existing
|
4333
|
+
# * If supplied, must match the name of an existing DB parameter group.
|
4290
4334
|
#
|
4291
4335
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
4292
4336
|
#
|
@@ -4294,10 +4338,10 @@ module Aws::RDS
|
|
4294
4338
|
#
|
4295
4339
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
4296
4340
|
# @option options [Boolean] :deletion_protection
|
4297
|
-
#
|
4298
|
-
#
|
4299
|
-
#
|
4300
|
-
#
|
4341
|
+
# Specifies whether the DB instance has deletion protection enabled. The
|
4342
|
+
# database can't be deleted when deletion protection is enabled. By
|
4343
|
+
# default, deletion protection isn't enabled. For more information, see
|
4344
|
+
# [ Deleting a DB Instance][1].
|
4301
4345
|
#
|
4302
4346
|
#
|
4303
4347
|
#
|
@@ -4320,12 +4364,12 @@ module Aws::RDS
|
|
4320
4364
|
# @option options [String] :source_db_instance_automated_backups_arn
|
4321
4365
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
4322
4366
|
# from which to restore, for example,
|
4323
|
-
# `arn:aws:rds:
|
4367
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
4324
4368
|
#
|
4325
4369
|
# This setting doesn't apply to RDS Custom.
|
4326
4370
|
# @option options [Boolean] :enable_customer_owned_ip
|
4327
|
-
#
|
4328
|
-
#
|
4371
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
4372
|
+
# RDS on Outposts DB instance.
|
4329
4373
|
#
|
4330
4374
|
# A *CoIP* provides local or external connectivity to resources in your
|
4331
4375
|
# Outpost subnets through your on-premises network. For some use cases,
|
@@ -4382,12 +4426,6 @@ module Aws::RDS
|
|
4382
4426
|
# @option options [String] :network_type
|
4383
4427
|
# The network type of the DB instance.
|
4384
4428
|
#
|
4385
|
-
# Valid values:
|
4386
|
-
#
|
4387
|
-
# * `IPV4`
|
4388
|
-
#
|
4389
|
-
# * `DUAL`
|
4390
|
-
#
|
4391
4429
|
# The network type is determined by the `DBSubnetGroup` specified for
|
4392
4430
|
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
4393
4431
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
@@ -4395,11 +4433,17 @@ module Aws::RDS
|
|
4395
4433
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
4396
4434
|
# the *Amazon RDS User Guide.*
|
4397
4435
|
#
|
4436
|
+
# Valid Values:
|
4437
|
+
#
|
4438
|
+
# * `IPV4`
|
4439
|
+
#
|
4440
|
+
# * `DUAL`
|
4441
|
+
#
|
4398
4442
|
#
|
4399
4443
|
#
|
4400
4444
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
4401
4445
|
# @option options [Integer] :storage_throughput
|
4402
|
-
#
|
4446
|
+
# The storage throughput value for the DB instance.
|
4403
4447
|
#
|
4404
4448
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
4405
4449
|
# @option options [Integer] :allocated_storage
|
@@ -4794,10 +4838,10 @@ module Aws::RDS
|
|
4794
4838
|
#
|
4795
4839
|
# * `engine` - Accepts names of database engines.
|
4796
4840
|
# @option options [Boolean] :include_shared
|
4797
|
-
#
|
4798
|
-
#
|
4799
|
-
#
|
4800
|
-
#
|
4841
|
+
# Specifies whether to include shared manual DB cluster snapshots from
|
4842
|
+
# other Amazon Web Services accounts that this Amazon Web Services
|
4843
|
+
# account has been given permission to copy or restore. By default,
|
4844
|
+
# these snapshots are not included.
|
4801
4845
|
#
|
4802
4846
|
# You can give an Amazon Web Services account permission to restore a
|
4803
4847
|
# manual DB snapshot from another Amazon Web Services account by using
|
@@ -4805,9 +4849,9 @@ module Aws::RDS
|
|
4805
4849
|
#
|
4806
4850
|
# This setting doesn't apply to RDS Custom.
|
4807
4851
|
# @option options [Boolean] :include_public
|
4808
|
-
#
|
4809
|
-
#
|
4810
|
-
#
|
4852
|
+
# Specifies whether to include manual DB cluster snapshots that are
|
4853
|
+
# public and can be copied or restored by any Amazon Web Services
|
4854
|
+
# account. By default, the public snapshots are not included.
|
4811
4855
|
#
|
4812
4856
|
# You can share a manual DB snapshot as public by using the
|
4813
4857
|
# ModifyDBSnapshotAttribute API.
|