aws-sdk-rds 1.195.0 → 1.196.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/certificate.rb +2 -1
- data/lib/aws-sdk-rds/client.rb +320 -319
- data/lib/aws-sdk-rds/db_cluster.rb +37 -38
- 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 +101 -104
- 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 +494 -494
- 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)
|
@@ -3928,8 +3926,7 @@ module Aws::RDS
|
|
3928
3926
|
# })
|
3929
3927
|
# @param [Hash] options ({})
|
3930
3928
|
# @option options [Boolean] :force_failover
|
3931
|
-
#
|
3932
|
-
# Multi-AZ failover.
|
3929
|
+
# Specifies whether the reboot is conducted through a Multi-AZ failover.
|
3933
3930
|
#
|
3934
3931
|
# Constraint: You can't enable force failover if the instance isn't
|
3935
3932
|
# configured for Multi-AZ.
|
@@ -4319,8 +4316,8 @@ module Aws::RDS
|
|
4319
4316
|
#
|
4320
4317
|
# This setting doesn't apply to RDS Custom.
|
4321
4318
|
# @option options [Boolean] :use_default_processor_features
|
4322
|
-
#
|
4323
|
-
#
|
4319
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
4320
|
+
# default processor features.
|
4324
4321
|
#
|
4325
4322
|
# This setting doesn't apply to RDS Custom.
|
4326
4323
|
# @option options [String] :db_parameter_group_name
|
@@ -4841,10 +4838,10 @@ module Aws::RDS
|
|
4841
4838
|
#
|
4842
4839
|
# * `engine` - Accepts names of database engines.
|
4843
4840
|
# @option options [Boolean] :include_shared
|
4844
|
-
#
|
4845
|
-
#
|
4846
|
-
#
|
4847
|
-
#
|
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.
|
4848
4845
|
#
|
4849
4846
|
# You can give an Amazon Web Services account permission to restore a
|
4850
4847
|
# manual DB snapshot from another Amazon Web Services account by using
|
@@ -4852,9 +4849,9 @@ module Aws::RDS
|
|
4852
4849
|
#
|
4853
4850
|
# This setting doesn't apply to RDS Custom.
|
4854
4851
|
# @option options [Boolean] :include_public
|
4855
|
-
#
|
4856
|
-
#
|
4857
|
-
#
|
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.
|
4858
4855
|
#
|
4859
4856
|
# You can share a manual DB snapshot as public by using the
|
4860
4857
|
# ModifyDBSnapshotAttribute API.
|
@@ -420,9 +420,9 @@ module Aws::RDS
|
|
420
420
|
# })
|
421
421
|
# @param [Hash] options ({})
|
422
422
|
# @option options [Boolean] :reset_all_parameters
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
423
|
+
# Specifies whether to reset all parameters in the DB parameter group to
|
424
|
+
# default values. By default, all parameters in the DB parameter group
|
425
|
+
# are reset to default values.
|
426
426
|
# @option options [Array<Types::Parameter>] :parameters
|
427
427
|
# To reset the entire DB parameter group, specify the `DBParameterGroup`
|
428
428
|
# name and `ResetAllParameters` parameters. To reset specific
|
@@ -167,7 +167,7 @@ module Aws::RDS
|
|
167
167
|
data[:tde_credential_arn]
|
168
168
|
end
|
169
169
|
|
170
|
-
#
|
170
|
+
# Indicates whether the DB snapshot is encrypted.
|
171
171
|
# @return [Boolean]
|
172
172
|
def encrypted
|
173
173
|
data[:encrypted]
|
@@ -198,8 +198,8 @@ module Aws::RDS
|
|
198
198
|
data[:timezone]
|
199
199
|
end
|
200
200
|
|
201
|
-
#
|
202
|
-
# (IAM) accounts to database accounts is enabled
|
201
|
+
# Indicates whether mapping of Amazon Web Services Identity and Access
|
202
|
+
# Management (IAM) accounts to database accounts is enabled.
|
203
203
|
# @return [Boolean]
|
204
204
|
def iam_database_authentication_enabled
|
205
205
|
data[:iam_database_authentication_enabled]
|
@@ -511,8 +511,8 @@ module Aws::RDS
|
|
511
511
|
#
|
512
512
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
513
513
|
# @option options [Boolean] :copy_tags
|
514
|
-
#
|
515
|
-
#
|
514
|
+
# Specifies whether to copy all tags from the source DB snapshot to the
|
515
|
+
# target DB snapshot. By default, tags aren't copied.
|
516
516
|
# @option options [String] :pre_signed_url
|
517
517
|
# When you are copying a snapshot from one Amazon Web Services GovCloud
|
518
518
|
# (US) Region to another, the URL that contains a Signature Version 4
|
@@ -600,10 +600,10 @@ module Aws::RDS
|
|
600
600
|
#
|
601
601
|
# Example: `rds-caz-aiqhTgQv`.
|
602
602
|
# @option options [Boolean] :copy_option_group
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
603
|
+
# Specifies whether to copy the DB option group associated with the
|
604
|
+
# source DB snapshot to the target Amazon Web Services account and
|
605
|
+
# associate with the target DB snapshot. The associated option group can
|
606
|
+
# be copied only with cross-account snapshot copy calls.
|
607
607
|
# @option options [String] :source_region
|
608
608
|
# The source region of the snapshot. This is only needed when the
|
609
609
|
# shapshot is encrypted and in a different region.
|
@@ -740,15 +740,14 @@ module Aws::RDS
|
|
740
740
|
#
|
741
741
|
# Example: `mydbsubnetgroup`
|
742
742
|
# @option options [Boolean] :multi_az
|
743
|
-
#
|
744
|
-
# deployment.
|
743
|
+
# Specifies whether the DB instance is a Multi-AZ deployment.
|
745
744
|
#
|
746
745
|
# This setting doesn't apply to RDS Custom.
|
747
746
|
#
|
748
747
|
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
749
748
|
# DB instance is a Multi-AZ deployment.
|
750
749
|
# @option options [Boolean] :publicly_accessible
|
751
|
-
#
|
750
|
+
# Specifies whether the DB instance is publicly accessible.
|
752
751
|
#
|
753
752
|
# When the DB instance is publicly accessible, its Domain Name System
|
754
753
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -763,8 +762,8 @@ module Aws::RDS
|
|
763
762
|
#
|
764
763
|
# For more information, see CreateDBInstance.
|
765
764
|
# @option options [Boolean] :auto_minor_version_upgrade
|
766
|
-
#
|
767
|
-
#
|
765
|
+
# Specifies whether to automatically apply minor version upgrades to the
|
766
|
+
# DB instance during the maintenance window.
|
768
767
|
#
|
769
768
|
# If you restore an RDS Custom DB instance, you must disable this
|
770
769
|
# parameter.
|
@@ -775,7 +774,7 @@ module Aws::RDS
|
|
775
774
|
#
|
776
775
|
# Default: Same as source.
|
777
776
|
#
|
778
|
-
# Valid
|
777
|
+
# Valid Values: `license-included` \| `bring-your-own-license` \|
|
779
778
|
# `general-public-license`
|
780
779
|
# @option options [String] :db_name
|
781
780
|
# The database name for the restored DB instance.
|
@@ -852,7 +851,7 @@ module Aws::RDS
|
|
852
851
|
# @option options [String] :storage_type
|
853
852
|
# Specifies the storage type to be associated with the DB instance.
|
854
853
|
#
|
855
|
-
# Valid
|
854
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
856
855
|
#
|
857
856
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
858
857
|
# `Iops` parameter.
|
@@ -914,6 +913,10 @@ module Aws::RDS
|
|
914
913
|
#
|
915
914
|
# Constraints:
|
916
915
|
#
|
916
|
+
# * Can't be longer than 64 characters.
|
917
|
+
#
|
918
|
+
# ^
|
919
|
+
#
|
917
920
|
# Example:
|
918
921
|
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
919
922
|
# @option options [Array<String>] :domain_dns_ips
|
@@ -930,8 +933,8 @@ module Aws::RDS
|
|
930
933
|
#
|
931
934
|
# Example: `123.124.125.126,234.235.236.237`
|
932
935
|
# @option options [Boolean] :copy_tags_to_snapshot
|
933
|
-
#
|
934
|
-
#
|
936
|
+
# Specifies whether to copy all tags from the restored DB instance to
|
937
|
+
# snapshots of the DB instance.
|
935
938
|
#
|
936
939
|
# In most cases, tags aren't copied by default. However, when you
|
937
940
|
# restore a DB instance from a DB snapshot, RDS checks whether you
|
@@ -952,9 +955,9 @@ module Aws::RDS
|
|
952
955
|
#
|
953
956
|
# This setting doesn't apply to RDS Custom DB instances.
|
954
957
|
# @option options [Boolean] :enable_iam_database_authentication
|
955
|
-
#
|
956
|
-
#
|
957
|
-
#
|
958
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
959
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
960
|
+
# mapping is disabled.
|
958
961
|
#
|
959
962
|
# For more information about IAM database authentication, see [ IAM
|
960
963
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -982,8 +985,8 @@ module Aws::RDS
|
|
982
985
|
#
|
983
986
|
# This setting doesn't apply to RDS Custom.
|
984
987
|
# @option options [Boolean] :use_default_processor_features
|
985
|
-
#
|
986
|
-
#
|
988
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
989
|
+
# default processor features.
|
987
990
|
#
|
988
991
|
# This setting doesn't apply to RDS Custom.
|
989
992
|
# @option options [String] :db_parameter_group_name
|
@@ -1004,17 +1007,17 @@ module Aws::RDS
|
|
1004
1007
|
#
|
1005
1008
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
1006
1009
|
# @option options [Boolean] :deletion_protection
|
1007
|
-
#
|
1008
|
-
#
|
1009
|
-
#
|
1010
|
-
#
|
1010
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
1011
|
+
# The database can't be deleted when deletion protection is enabled. By
|
1012
|
+
# default, deletion protection isn't enabled. For more information, see
|
1013
|
+
# [ Deleting a DB Instance][1].
|
1011
1014
|
#
|
1012
1015
|
#
|
1013
1016
|
#
|
1014
1017
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
|
1015
1018
|
# @option options [Boolean] :enable_customer_owned_ip
|
1016
|
-
#
|
1017
|
-
#
|
1019
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
1020
|
+
# RDS on Outposts DB instance.
|
1018
1021
|
#
|
1019
1022
|
# A *CoIP* provides local or external connectivity to resources in your
|
1020
1023
|
# Outpost subnets through your on-premises network. For some use cases,
|
@@ -1071,7 +1074,7 @@ module Aws::RDS
|
|
1071
1074
|
# @option options [String] :network_type
|
1072
1075
|
# The network type of the DB instance.
|
1073
1076
|
#
|
1074
|
-
# Valid
|
1077
|
+
# Valid Values:
|
1075
1078
|
#
|
1076
1079
|
# * `IPV4`
|
1077
1080
|
#
|
@@ -310,7 +310,7 @@ module Aws::RDS
|
|
310
310
|
# parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`.
|
311
311
|
# If this value isn't specified, all events are returned.
|
312
312
|
#
|
313
|
-
# Valid
|
313
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
314
314
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
315
315
|
# `db-proxy`
|
316
316
|
# @option options [Array<String>] :event_categories
|
@@ -357,8 +357,8 @@ module Aws::RDS
|
|
357
357
|
# * If the source type is an RDS Proxy, a `DBProxyName` value must be
|
358
358
|
# supplied.
|
359
359
|
# @option options [Boolean] :enabled
|
360
|
-
#
|
361
|
-
#
|
360
|
+
# Specifies whether to activate the subscription. If the event
|
361
|
+
# notification subscription isn't activated, the subscription is
|
362
362
|
# created but not active.
|
363
363
|
# @option options [Array<Types::Tag>] :tags
|
364
364
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -416,7 +416,7 @@ module Aws::RDS
|
|
416
416
|
# set this parameter to db-instance. For RDS Proxy events, specify
|
417
417
|
# `db-proxy`. If this value isn't specified, all events are returned.
|
418
418
|
#
|
419
|
-
# Valid
|
419
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
420
420
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
421
421
|
# `db-proxy`
|
422
422
|
# @option options [Array<String>] :event_categories
|
@@ -429,7 +429,7 @@ module Aws::RDS
|
|
429
429
|
#
|
430
430
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
|
431
431
|
# @option options [Boolean] :enabled
|
432
|
-
#
|
432
|
+
# Specifies whether to activate the subscription.
|
433
433
|
# @return [EventSubscription]
|
434
434
|
def modify(options = {})
|
435
435
|
options = options.merge(subscription_name: @name)
|