aws-sdk-rds 1.181.0 → 1.182.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1040 -1099
- data/lib/aws-sdk-rds/db_cluster.rb +425 -444
- data/lib/aws-sdk-rds/db_instance.rb +761 -847
- data/lib/aws-sdk-rds/resource.rb +600 -688
- data/lib/aws-sdk-rds/types.rb +1246 -1348
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/client.rb
CHANGED
|
@@ -2434,7 +2434,7 @@ module Aws::RDS
|
|
|
2434
2434
|
# see [Choosing the Regions and Availability Zones][1] in the *Amazon
|
|
2435
2435
|
# Aurora User Guide*.
|
|
2436
2436
|
#
|
|
2437
|
-
# Valid for: Aurora DB clusters only
|
|
2437
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2438
2438
|
#
|
|
2439
2439
|
#
|
|
2440
2440
|
#
|
|
@@ -2443,32 +2443,34 @@ module Aws::RDS
|
|
|
2443
2443
|
# @option params [Integer] :backup_retention_period
|
|
2444
2444
|
# The number of days for which automated backups are retained.
|
|
2445
2445
|
#
|
|
2446
|
-
#
|
|
2446
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2447
|
+
#
|
|
2448
|
+
# Default: `1`
|
|
2447
2449
|
#
|
|
2448
2450
|
# Constraints:
|
|
2449
2451
|
#
|
|
2450
|
-
# * Must be a value from 1 to 35
|
|
2452
|
+
# * Must be a value from 1 to 35.
|
|
2451
2453
|
#
|
|
2452
2454
|
# ^
|
|
2453
2455
|
#
|
|
2454
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2455
|
-
#
|
|
2456
2456
|
# @option params [String] :character_set_name
|
|
2457
|
-
#
|
|
2458
|
-
#
|
|
2457
|
+
# The name of the character set (`CharacterSet`) to associate the DB
|
|
2458
|
+
# cluster with.
|
|
2459
2459
|
#
|
|
2460
|
-
# Valid for: Aurora DB clusters only
|
|
2460
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2461
2461
|
#
|
|
2462
2462
|
# @option params [String] :database_name
|
|
2463
2463
|
# The name for your database of up to 64 alphanumeric characters. If you
|
|
2464
|
-
#
|
|
2464
|
+
# don't provide a name, Amazon RDS doesn't create a database in the DB
|
|
2465
2465
|
# cluster you are creating.
|
|
2466
2466
|
#
|
|
2467
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2467
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2468
2468
|
#
|
|
2469
2469
|
# @option params [required, String] :db_cluster_identifier
|
|
2470
|
-
# The DB cluster
|
|
2471
|
-
# string.
|
|
2470
|
+
# The identifier for this DB cluster. This parameter is stored as a
|
|
2471
|
+
# lowercase string.
|
|
2472
|
+
#
|
|
2473
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2472
2474
|
#
|
|
2473
2475
|
# Constraints:
|
|
2474
2476
|
#
|
|
@@ -2480,13 +2482,13 @@ module Aws::RDS
|
|
|
2480
2482
|
#
|
|
2481
2483
|
# Example: `my-cluster1`
|
|
2482
2484
|
#
|
|
2483
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2484
|
-
#
|
|
2485
2485
|
# @option params [String] :db_cluster_parameter_group_name
|
|
2486
2486
|
# The name of the DB cluster parameter group to associate with this DB
|
|
2487
|
-
# cluster. If you
|
|
2487
|
+
# cluster. If you don't specify a value, then the default DB cluster
|
|
2488
2488
|
# parameter group for the specified DB engine and version is used.
|
|
2489
2489
|
#
|
|
2490
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2491
|
+
#
|
|
2490
2492
|
# Constraints:
|
|
2491
2493
|
#
|
|
2492
2494
|
# * If supplied, must match the name of an existing DB cluster parameter
|
|
@@ -2494,39 +2496,32 @@ module Aws::RDS
|
|
|
2494
2496
|
#
|
|
2495
2497
|
# ^
|
|
2496
2498
|
#
|
|
2497
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2498
|
-
#
|
|
2499
2499
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
2500
2500
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
|
2501
2501
|
#
|
|
2502
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2502
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2503
2503
|
#
|
|
2504
2504
|
# @option params [String] :db_subnet_group_name
|
|
2505
2505
|
# A DB subnet group to associate with this DB cluster.
|
|
2506
2506
|
#
|
|
2507
2507
|
# This setting is required to create a Multi-AZ DB cluster.
|
|
2508
2508
|
#
|
|
2509
|
-
#
|
|
2510
|
-
# not be default.
|
|
2511
|
-
#
|
|
2512
|
-
# Example: `mydbsubnetgroup`
|
|
2509
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2513
2510
|
#
|
|
2514
|
-
#
|
|
2511
|
+
# Constraints:
|
|
2515
2512
|
#
|
|
2516
|
-
#
|
|
2517
|
-
# The name of the database engine to be used for this DB cluster.
|
|
2513
|
+
# * Must match the name of an existing DB subnet group.
|
|
2518
2514
|
#
|
|
2519
|
-
#
|
|
2515
|
+
# * Must not be `default`.
|
|
2520
2516
|
#
|
|
2521
|
-
#
|
|
2522
|
-
#
|
|
2523
|
-
# * `aurora-postgresql`
|
|
2517
|
+
# Example: `mydbsubnetgroup`
|
|
2524
2518
|
#
|
|
2525
|
-
#
|
|
2519
|
+
# @option params [required, String] :engine
|
|
2520
|
+
# The database engine to use for this DB cluster.
|
|
2526
2521
|
#
|
|
2527
|
-
#
|
|
2522
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2528
2523
|
#
|
|
2529
|
-
# Valid
|
|
2524
|
+
# Valid Values: `aurora-mysql | aurora-postgresql | mysql | postgres`
|
|
2530
2525
|
#
|
|
2531
2526
|
# @option params [String] :engine_version
|
|
2532
2527
|
# The version number of the database engine to use.
|
|
@@ -2559,27 +2554,21 @@ module Aws::RDS
|
|
|
2559
2554
|
# `aws rds describe-db-engine-versions --engine postgres --query
|
|
2560
2555
|
# "DBEngineVersions[].EngineVersion"`
|
|
2561
2556
|
#
|
|
2562
|
-
#
|
|
2563
|
-
#
|
|
2564
|
-
# For information, see [Database engine updates for Amazon Aurora
|
|
2565
|
-
# MySQL][1] in the *Amazon Aurora User Guide*.
|
|
2557
|
+
# For information about a specific engine, see the following topics:
|
|
2566
2558
|
#
|
|
2567
|
-
#
|
|
2559
|
+
# * Aurora MySQL - see [Database engine updates for Amazon Aurora
|
|
2560
|
+
# MySQL][1] in the *Amazon Aurora User Guide*.
|
|
2568
2561
|
#
|
|
2569
|
-
#
|
|
2570
|
-
#
|
|
2562
|
+
# * Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and
|
|
2563
|
+
# engine versions][2] in the *Amazon Aurora User Guide*.
|
|
2571
2564
|
#
|
|
2572
|
-
#
|
|
2573
|
-
#
|
|
2574
|
-
# For information, see [Amazon RDS for MySQL][3] in the *Amazon RDS User
|
|
2575
|
-
# Guide*.
|
|
2576
|
-
#
|
|
2577
|
-
# **PostgreSQL**
|
|
2565
|
+
# * RDS for MySQL - see [Amazon RDS for MySQL][3] in the *Amazon RDS
|
|
2566
|
+
# User Guide*.
|
|
2578
2567
|
#
|
|
2579
|
-
#
|
|
2580
|
-
#
|
|
2568
|
+
# * RDS for PostgreSQL - see [Amazon RDS for PostgreSQL][4] in the
|
|
2569
|
+
# *Amazon RDS User Guide*.
|
|
2581
2570
|
#
|
|
2582
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2571
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2583
2572
|
#
|
|
2584
2573
|
#
|
|
2585
2574
|
#
|
|
@@ -2592,23 +2581,21 @@ module Aws::RDS
|
|
|
2592
2581
|
# The port number on which the instances in the DB cluster accept
|
|
2593
2582
|
# connections.
|
|
2594
2583
|
#
|
|
2595
|
-
#
|
|
2596
|
-
#
|
|
2597
|
-
# Default: `3306`
|
|
2598
|
-
#
|
|
2599
|
-
# Valid values: `1150-65535`
|
|
2584
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2600
2585
|
#
|
|
2601
|
-
#
|
|
2586
|
+
# Valid Values: `1150-65535`
|
|
2602
2587
|
#
|
|
2603
|
-
# Default:
|
|
2588
|
+
# Default:
|
|
2604
2589
|
#
|
|
2605
|
-
#
|
|
2590
|
+
# * RDS for MySQL and Aurora MySQL - `3306`
|
|
2606
2591
|
#
|
|
2607
|
-
#
|
|
2592
|
+
# * RDS for PostgreSQL and Aurora PostgreSQL - `5432`
|
|
2608
2593
|
#
|
|
2609
2594
|
# @option params [String] :master_username
|
|
2610
2595
|
# The name of the master user for the DB cluster.
|
|
2611
2596
|
#
|
|
2597
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2598
|
+
#
|
|
2612
2599
|
# Constraints:
|
|
2613
2600
|
#
|
|
2614
2601
|
# * Must be 1 to 16 letters or numbers.
|
|
@@ -2617,23 +2604,22 @@ module Aws::RDS
|
|
|
2617
2604
|
#
|
|
2618
2605
|
# * Can't be a reserved word for the chosen database engine.
|
|
2619
2606
|
#
|
|
2620
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2621
|
-
#
|
|
2622
2607
|
# @option params [String] :master_user_password
|
|
2623
|
-
# The password for the master database user.
|
|
2624
|
-
#
|
|
2608
|
+
# The password for the master database user.
|
|
2609
|
+
#
|
|
2610
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2625
2611
|
#
|
|
2626
2612
|
# Constraints:
|
|
2627
2613
|
#
|
|
2628
2614
|
# * Must contain from 8 to 41 characters.
|
|
2629
2615
|
#
|
|
2630
|
-
# * Can
|
|
2616
|
+
# * Can contain any printable ASCII character except "/", """, or
|
|
2617
|
+
# "@".
|
|
2631
2618
|
#
|
|
2632
|
-
#
|
|
2619
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
|
2633
2620
|
#
|
|
2634
2621
|
# @option params [String] :option_group_name
|
|
2635
|
-
#
|
|
2636
|
-
# the specified option group.
|
|
2622
|
+
# The option group to associate the DB cluster with.
|
|
2637
2623
|
#
|
|
2638
2624
|
# DB clusters are associated with a default option group that can't be
|
|
2639
2625
|
# modified.
|
|
@@ -2643,6 +2629,8 @@ module Aws::RDS
|
|
|
2643
2629
|
# automated backups are enabled using the `BackupRetentionPeriod`
|
|
2644
2630
|
# parameter.
|
|
2645
2631
|
#
|
|
2632
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2633
|
+
#
|
|
2646
2634
|
# The default is a 30-minute window selected at random from an 8-hour
|
|
2647
2635
|
# block of time for each Amazon Web Services Region. To view the time
|
|
2648
2636
|
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
|
@@ -2658,17 +2646,14 @@ module Aws::RDS
|
|
|
2658
2646
|
#
|
|
2659
2647
|
# * Must be at least 30 minutes.
|
|
2660
2648
|
#
|
|
2661
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2662
|
-
#
|
|
2663
2649
|
#
|
|
2664
2650
|
#
|
|
2665
2651
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
|
2666
2652
|
#
|
|
2667
2653
|
# @option params [String] :preferred_maintenance_window
|
|
2668
|
-
# The weekly time range during which system maintenance can occur
|
|
2669
|
-
# Universal Coordinated Time (UTC).
|
|
2654
|
+
# The weekly time range during which system maintenance can occur.
|
|
2670
2655
|
#
|
|
2671
|
-
#
|
|
2656
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2672
2657
|
#
|
|
2673
2658
|
# The default is a 30-minute window selected at random from an 8-hour
|
|
2674
2659
|
# block of time for each Amazon Web Services Region, occurring on a
|
|
@@ -2676,11 +2661,15 @@ module Aws::RDS
|
|
|
2676
2661
|
# Adjusting the Preferred DB Cluster Maintenance Window][1] in the
|
|
2677
2662
|
# *Amazon Aurora User Guide*.
|
|
2678
2663
|
#
|
|
2679
|
-
#
|
|
2664
|
+
# Constraints:
|
|
2680
2665
|
#
|
|
2681
|
-
#
|
|
2666
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
|
2682
2667
|
#
|
|
2683
|
-
#
|
|
2668
|
+
# * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
|
|
2669
|
+
#
|
|
2670
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
2671
|
+
#
|
|
2672
|
+
# * Must be at least 30 minutes.
|
|
2684
2673
|
#
|
|
2685
2674
|
#
|
|
2686
2675
|
#
|
|
@@ -2690,17 +2679,17 @@ module Aws::RDS
|
|
|
2690
2679
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
|
2691
2680
|
# if this DB cluster is created as a read replica.
|
|
2692
2681
|
#
|
|
2693
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2682
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2694
2683
|
#
|
|
2695
2684
|
# @option params [Array<Types::Tag>] :tags
|
|
2696
2685
|
# Tags to assign to the DB cluster.
|
|
2697
2686
|
#
|
|
2698
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2687
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2699
2688
|
#
|
|
2700
2689
|
# @option params [Boolean] :storage_encrypted
|
|
2701
|
-
#
|
|
2690
|
+
# Specifies whether the DB cluster is encrypted.
|
|
2702
2691
|
#
|
|
2703
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2692
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2704
2693
|
#
|
|
2705
2694
|
# @option params [String] :kms_key_id
|
|
2706
2695
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
|
@@ -2714,24 +2703,24 @@ module Aws::RDS
|
|
|
2714
2703
|
# When a KMS key isn't specified in `KmsKeyId`:
|
|
2715
2704
|
#
|
|
2716
2705
|
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
|
2717
|
-
# then Amazon RDS
|
|
2718
|
-
# Otherwise, Amazon RDS
|
|
2706
|
+
# then Amazon RDS uses the KMS key used to encrypt the source.
|
|
2707
|
+
# Otherwise, Amazon RDS uses your default KMS key.
|
|
2719
2708
|
#
|
|
2720
2709
|
# * If the `StorageEncrypted` parameter is enabled and
|
|
2721
|
-
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS
|
|
2722
|
-
#
|
|
2710
|
+
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS uses
|
|
2711
|
+
# your default KMS key.
|
|
2723
2712
|
#
|
|
2724
2713
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
2725
2714
|
# Amazon Web Services account has a different default KMS key for each
|
|
2726
2715
|
# Amazon Web Services Region.
|
|
2727
2716
|
#
|
|
2728
2717
|
# If you create a read replica of an encrypted DB cluster in another
|
|
2729
|
-
# Amazon Web Services Region,
|
|
2718
|
+
# Amazon Web Services Region, make sure to set `KmsKeyId` to a KMS key
|
|
2730
2719
|
# identifier that is valid in the destination Amazon Web Services
|
|
2731
2720
|
# Region. This KMS key is used to encrypt the read replica in that
|
|
2732
2721
|
# Amazon Web Services Region.
|
|
2733
2722
|
#
|
|
2734
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2723
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2735
2724
|
#
|
|
2736
2725
|
# @option params [String] :pre_signed_url
|
|
2737
2726
|
# When you are replicating a DB cluster from one Amazon Web Services
|
|
@@ -2778,7 +2767,7 @@ module Aws::RDS
|
|
|
2778
2767
|
#
|
|
2779
2768
|
# </note>
|
|
2780
2769
|
#
|
|
2781
|
-
# Valid for: Aurora DB clusters only
|
|
2770
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2782
2771
|
#
|
|
2783
2772
|
#
|
|
2784
2773
|
#
|
|
@@ -2786,14 +2775,14 @@ module Aws::RDS
|
|
|
2786
2775
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
|
2787
2776
|
#
|
|
2788
2777
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
2789
|
-
#
|
|
2790
|
-
#
|
|
2791
|
-
#
|
|
2778
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
|
2779
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
|
2780
|
+
# mapping isn't enabled.
|
|
2792
2781
|
#
|
|
2793
2782
|
# For more information, see [ IAM Database Authentication][1] in the
|
|
2794
2783
|
# *Amazon Aurora User Guide*.
|
|
2795
2784
|
#
|
|
2796
|
-
# Valid for: Aurora DB clusters only
|
|
2785
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2797
2786
|
#
|
|
2798
2787
|
#
|
|
2799
2788
|
#
|
|
@@ -2801,9 +2790,11 @@ module Aws::RDS
|
|
|
2801
2790
|
#
|
|
2802
2791
|
# @option params [Integer] :backtrack_window
|
|
2803
2792
|
# The target backtrack window, in seconds. To disable backtracking, set
|
|
2804
|
-
# this value to 0
|
|
2793
|
+
# this value to `0`.
|
|
2805
2794
|
#
|
|
2806
|
-
#
|
|
2795
|
+
# Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
2796
|
+
#
|
|
2797
|
+
# Default: `0`
|
|
2807
2798
|
#
|
|
2808
2799
|
# Constraints:
|
|
2809
2800
|
#
|
|
@@ -2812,28 +2803,21 @@ module Aws::RDS
|
|
|
2812
2803
|
#
|
|
2813
2804
|
# ^
|
|
2814
2805
|
#
|
|
2815
|
-
# Valid for: Aurora MySQL DB clusters only
|
|
2816
|
-
#
|
|
2817
2806
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
|
2818
2807
|
# The list of log types that need to be enabled for exporting to
|
|
2819
|
-
# CloudWatch Logs.
|
|
2820
|
-
# used.
|
|
2808
|
+
# CloudWatch Logs.
|
|
2821
2809
|
#
|
|
2822
|
-
#
|
|
2823
|
-
#
|
|
2824
|
-
# Possible values are `error`, `general`, and `slowquery`.
|
|
2825
|
-
#
|
|
2826
|
-
# **RDS for PostgreSQL**
|
|
2810
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2827
2811
|
#
|
|
2828
|
-
#
|
|
2812
|
+
# The following values are valid for each DB engine:
|
|
2829
2813
|
#
|
|
2830
|
-
#
|
|
2814
|
+
# * Aurora MySQL - `audit | error | general | slowquery`
|
|
2831
2815
|
#
|
|
2832
|
-
#
|
|
2816
|
+
# * Aurora PostgreSQL - `postgresql`
|
|
2833
2817
|
#
|
|
2834
|
-
#
|
|
2818
|
+
# * RDS for MySQL - `error | general | slowquery`
|
|
2835
2819
|
#
|
|
2836
|
-
#
|
|
2820
|
+
# * RDS for PostgreSQL - `postgresql | upgrade`
|
|
2837
2821
|
#
|
|
2838
2822
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
|
2839
2823
|
# see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
|
@@ -2843,8 +2827,6 @@ module Aws::RDS
|
|
|
2843
2827
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
|
2844
2828
|
# the *Amazon Aurora User Guide*.
|
|
2845
2829
|
#
|
|
2846
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2847
|
-
#
|
|
2848
2830
|
#
|
|
2849
2831
|
#
|
|
2850
2832
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
|
@@ -2865,7 +2847,7 @@ module Aws::RDS
|
|
|
2865
2847
|
#
|
|
2866
2848
|
# * [Requirements for Aurora Serverless v2][2]
|
|
2867
2849
|
#
|
|
2868
|
-
# Valid for: Aurora DB clusters only
|
|
2850
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2869
2851
|
#
|
|
2870
2852
|
#
|
|
2871
2853
|
#
|
|
@@ -2876,25 +2858,24 @@ module Aws::RDS
|
|
|
2876
2858
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
|
2877
2859
|
# of the DB cluster.
|
|
2878
2860
|
#
|
|
2879
|
-
# Valid for: Aurora DB clusters only
|
|
2861
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2880
2862
|
#
|
|
2881
2863
|
# @option params [Boolean] :deletion_protection
|
|
2882
|
-
#
|
|
2883
|
-
#
|
|
2884
|
-
#
|
|
2864
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
2865
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
2866
|
+
# default, deletion protection isn't enabled.
|
|
2885
2867
|
#
|
|
2886
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2868
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2887
2869
|
#
|
|
2888
2870
|
# @option params [String] :global_cluster_identifier
|
|
2889
2871
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
|
2890
2872
|
# cluster in the new global database cluster.
|
|
2891
2873
|
#
|
|
2892
|
-
# Valid for: Aurora DB clusters only
|
|
2874
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2893
2875
|
#
|
|
2894
2876
|
# @option params [Boolean] :enable_http_endpoint
|
|
2895
|
-
#
|
|
2896
|
-
#
|
|
2897
|
-
# disabled.
|
|
2877
|
+
# Specifies whether to enable the HTTP endpoint for an Aurora Serverless
|
|
2878
|
+
# v1 DB cluster. By default, the HTTP endpoint is disabled.
|
|
2898
2879
|
#
|
|
2899
2880
|
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
2900
2881
|
# API for running SQL queries on the Aurora Serverless v1 DB cluster.
|
|
@@ -2904,17 +2885,17 @@ module Aws::RDS
|
|
|
2904
2885
|
# For more information, see [Using the Data API for Aurora Serverless
|
|
2905
2886
|
# v1][1] in the *Amazon Aurora User Guide*.
|
|
2906
2887
|
#
|
|
2907
|
-
# Valid for: Aurora DB clusters only
|
|
2888
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2908
2889
|
#
|
|
2909
2890
|
#
|
|
2910
2891
|
#
|
|
2911
2892
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
2912
2893
|
#
|
|
2913
2894
|
# @option params [Boolean] :copy_tags_to_snapshot
|
|
2914
|
-
#
|
|
2915
|
-
#
|
|
2895
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
2896
|
+
# the DB cluster. The default is not to copy them.
|
|
2916
2897
|
#
|
|
2917
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
2898
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2918
2899
|
#
|
|
2919
2900
|
# @option params [String] :domain
|
|
2920
2901
|
# The Active Directory directory ID to create the DB cluster in.
|
|
@@ -2925,38 +2906,37 @@ module Aws::RDS
|
|
|
2925
2906
|
# For more information, see [Kerberos authentication][1] in the *Amazon
|
|
2926
2907
|
# Aurora User Guide*.
|
|
2927
2908
|
#
|
|
2928
|
-
# Valid for: Aurora DB clusters only
|
|
2909
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2929
2910
|
#
|
|
2930
2911
|
#
|
|
2931
2912
|
#
|
|
2932
2913
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
2933
2914
|
#
|
|
2934
2915
|
# @option params [String] :domain_iam_role_name
|
|
2935
|
-
#
|
|
2936
|
-
#
|
|
2916
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
2917
|
+
# Service.
|
|
2937
2918
|
#
|
|
2938
|
-
# Valid for: Aurora DB clusters only
|
|
2919
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2939
2920
|
#
|
|
2940
2921
|
# @option params [Boolean] :enable_global_write_forwarding
|
|
2941
|
-
#
|
|
2942
|
-
#
|
|
2943
|
-
#
|
|
2944
|
-
#
|
|
2945
|
-
# database.
|
|
2922
|
+
# Specifies whether to enable this DB cluster to forward write
|
|
2923
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
|
2924
|
+
# database). By default, write operations are not allowed on Aurora DB
|
|
2925
|
+
# clusters that are secondary clusters in an Aurora global database.
|
|
2946
2926
|
#
|
|
2947
2927
|
# You can set this value only on Aurora DB clusters that are members of
|
|
2948
2928
|
# an Aurora global database. With this parameter enabled, a secondary
|
|
2949
|
-
# cluster can forward writes to the current primary cluster and the
|
|
2929
|
+
# cluster can forward writes to the current primary cluster, and the
|
|
2950
2930
|
# resulting changes are replicated back to this cluster. For the primary
|
|
2951
2931
|
# DB cluster of an Aurora global database, this value is used
|
|
2952
|
-
# immediately if the primary is demoted by
|
|
2932
|
+
# immediately if the primary is demoted by a global cluster API
|
|
2953
2933
|
# operation, but it does nothing until then.
|
|
2954
2934
|
#
|
|
2955
|
-
# Valid for: Aurora DB clusters only
|
|
2935
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2956
2936
|
#
|
|
2957
2937
|
# @option params [String] :db_cluster_instance_class
|
|
2958
2938
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
|
2959
|
-
# cluster, for example db.m6gd.xlarge
|
|
2939
|
+
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
|
2960
2940
|
# available in all Amazon Web Services Regions, or for all database
|
|
2961
2941
|
# engines.
|
|
2962
2942
|
#
|
|
@@ -2965,7 +2945,7 @@ module Aws::RDS
|
|
|
2965
2945
|
#
|
|
2966
2946
|
# This setting is required to create a Multi-AZ DB cluster.
|
|
2967
2947
|
#
|
|
2968
|
-
# Valid for: Multi-AZ DB clusters only
|
|
2948
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
2969
2949
|
#
|
|
2970
2950
|
#
|
|
2971
2951
|
#
|
|
@@ -2975,29 +2955,36 @@ module Aws::RDS
|
|
|
2975
2955
|
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
|
2976
2956
|
# instance in the Multi-AZ DB cluster.
|
|
2977
2957
|
#
|
|
2978
|
-
#
|
|
2958
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
2979
2959
|
#
|
|
2980
|
-
#
|
|
2960
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
|
2981
2961
|
#
|
|
2982
2962
|
# @option params [String] :storage_type
|
|
2983
|
-
#
|
|
2963
|
+
# The storage type to associate with the DB cluster.
|
|
2964
|
+
#
|
|
2965
|
+
# For information on storage types for Aurora DB clusters, see [Storage
|
|
2966
|
+
# configurations for Amazon Aurora DB clusters][1]. For information on
|
|
2967
|
+
# storage types for Multi-AZ DB clusters, see [Settings for creating
|
|
2968
|
+
# Multi-AZ DB clusters][2].
|
|
2984
2969
|
#
|
|
2985
2970
|
# This setting is required to create a Multi-AZ DB cluster.
|
|
2986
2971
|
#
|
|
2987
2972
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
|
2988
2973
|
# parameter is required.
|
|
2989
2974
|
#
|
|
2990
|
-
# Valid
|
|
2991
|
-
# (Multi-AZ DB clusters)
|
|
2975
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2992
2976
|
#
|
|
2993
|
-
#
|
|
2977
|
+
# Valid Values:
|
|
2994
2978
|
#
|
|
2995
|
-
#
|
|
2979
|
+
# * Aurora DB clusters - `aurora | aurora-iopt1`
|
|
2980
|
+
#
|
|
2981
|
+
# * Multi-AZ DB clusters - `io1`
|
|
2982
|
+
#
|
|
2983
|
+
# Default:
|
|
2984
|
+
#
|
|
2985
|
+
# * Aurora DB clusters - `aurora`
|
|
2996
2986
|
#
|
|
2997
|
-
#
|
|
2998
|
-
# [Storage configurations for Amazon Aurora DB clusters][1]. For more
|
|
2999
|
-
# information on storage types for Multi-AZ DB clusters, see [Settings
|
|
3000
|
-
# for creating Multi-AZ DB clusters][2].
|
|
2987
|
+
# * Multi-AZ DB clusters - `io1`
|
|
3001
2988
|
#
|
|
3002
2989
|
#
|
|
3003
2990
|
#
|
|
@@ -3014,17 +3001,21 @@ module Aws::RDS
|
|
|
3014
3001
|
#
|
|
3015
3002
|
# This setting is required to create a Multi-AZ DB cluster.
|
|
3016
3003
|
#
|
|
3017
|
-
#
|
|
3018
|
-
# amount for the DB cluster.
|
|
3004
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3019
3005
|
#
|
|
3020
|
-
#
|
|
3006
|
+
# Constraints:
|
|
3007
|
+
#
|
|
3008
|
+
# * Must be a multiple between .5 and 50 of the storage amount for the
|
|
3009
|
+
# DB cluster.
|
|
3010
|
+
#
|
|
3011
|
+
# ^
|
|
3021
3012
|
#
|
|
3022
3013
|
#
|
|
3023
3014
|
#
|
|
3024
3015
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
|
3025
3016
|
#
|
|
3026
3017
|
# @option params [Boolean] :publicly_accessible
|
|
3027
|
-
#
|
|
3018
|
+
# Specifies whether the DB cluster is publicly accessible.
|
|
3028
3019
|
#
|
|
3029
3020
|
# When the DB cluster is publicly accessible, its Domain Name System
|
|
3030
3021
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
|
@@ -3037,6 +3028,8 @@ module Aws::RDS
|
|
|
3037
3028
|
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
3038
3029
|
# cluster with a DNS name that resolves to a private IP address.
|
|
3039
3030
|
#
|
|
3031
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3032
|
+
#
|
|
3040
3033
|
# Default: The default behavior varies depending on whether
|
|
3041
3034
|
# `DBSubnetGroupName` is specified.
|
|
3042
3035
|
#
|
|
@@ -3058,26 +3051,26 @@ module Aws::RDS
|
|
|
3058
3051
|
# * If the subnets are part of a VPC that has an internet gateway
|
|
3059
3052
|
# attached to it, the DB cluster is public.
|
|
3060
3053
|
#
|
|
3061
|
-
# Valid for: Multi-AZ DB clusters only
|
|
3062
|
-
#
|
|
3063
3054
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
3064
|
-
#
|
|
3065
|
-
#
|
|
3066
|
-
#
|
|
3055
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
|
3056
|
+
# the DB cluster during the maintenance window. By default, minor engine
|
|
3057
|
+
# upgrades are applied automatically.
|
|
3067
3058
|
#
|
|
3068
|
-
# Valid for: Multi-AZ DB clusters only
|
|
3059
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3069
3060
|
#
|
|
3070
3061
|
# @option params [Integer] :monitoring_interval
|
|
3071
3062
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
3072
3063
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
3073
|
-
# Enhanced Monitoring metrics, specify 0
|
|
3064
|
+
# Enhanced Monitoring metrics, specify `0`.
|
|
3074
3065
|
#
|
|
3075
3066
|
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
|
3076
|
-
# a value other than 0
|
|
3067
|
+
# a value other than `0`.
|
|
3077
3068
|
#
|
|
3078
|
-
# Valid
|
|
3069
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3079
3070
|
#
|
|
3080
|
-
# Valid
|
|
3071
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
|
3072
|
+
#
|
|
3073
|
+
# Default: `0`
|
|
3081
3074
|
#
|
|
3082
3075
|
# @option params [String] :monitoring_role_arn
|
|
3083
3076
|
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
|
@@ -3086,23 +3079,22 @@ module Aws::RDS
|
|
|
3086
3079
|
# creating a monitoring role, see [Setting up and enabling Enhanced
|
|
3087
3080
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
|
3088
3081
|
#
|
|
3089
|
-
# If `MonitoringInterval` is set to a value other than 0
|
|
3082
|
+
# If `MonitoringInterval` is set to a value other than `0`, supply a
|
|
3090
3083
|
# `MonitoringRoleArn` value.
|
|
3091
3084
|
#
|
|
3092
|
-
# Valid for: Multi-AZ DB clusters only
|
|
3085
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3093
3086
|
#
|
|
3094
3087
|
#
|
|
3095
3088
|
#
|
|
3096
3089
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
|
3097
3090
|
#
|
|
3098
3091
|
# @option params [Boolean] :enable_performance_insights
|
|
3099
|
-
#
|
|
3100
|
-
# DB cluster.
|
|
3092
|
+
# Specifies whether to turn on Performance Insights for the DB cluster.
|
|
3101
3093
|
#
|
|
3102
3094
|
# For more information, see [ Using Amazon Performance Insights][1] in
|
|
3103
3095
|
# the *Amazon RDS User Guide*.
|
|
3104
3096
|
#
|
|
3105
|
-
# Valid for: Multi-AZ DB clusters only
|
|
3097
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3106
3098
|
#
|
|
3107
3099
|
#
|
|
3108
3100
|
#
|
|
@@ -3120,32 +3112,27 @@ module Aws::RDS
|
|
|
3120
3112
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
|
3121
3113
|
# a different default KMS key for each Amazon Web Services Region.
|
|
3122
3114
|
#
|
|
3123
|
-
# Valid for: Multi-AZ DB clusters only
|
|
3115
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3124
3116
|
#
|
|
3125
3117
|
# @option params [Integer] :performance_insights_retention_period
|
|
3126
|
-
# The number of days to retain Performance Insights data.
|
|
3127
|
-
# 7 days. The following values are valid:
|
|
3118
|
+
# The number of days to retain Performance Insights data.
|
|
3128
3119
|
#
|
|
3129
|
-
#
|
|
3120
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
3130
3121
|
#
|
|
3131
|
-
#
|
|
3132
|
-
#
|
|
3133
|
-
# * 731
|
|
3134
|
-
#
|
|
3135
|
-
# For example, the following values are valid:
|
|
3136
|
-
#
|
|
3137
|
-
# * 93 (3 months * 31)
|
|
3122
|
+
# Valid Values:
|
|
3138
3123
|
#
|
|
3139
|
-
# *
|
|
3124
|
+
# * `7`
|
|
3140
3125
|
#
|
|
3141
|
-
# *
|
|
3126
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
|
3127
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
|
3128
|
+
# months * 31)
|
|
3142
3129
|
#
|
|
3143
|
-
# * 731
|
|
3130
|
+
# * `731`
|
|
3144
3131
|
#
|
|
3145
|
-
#
|
|
3146
|
-
# value, RDS issues an error.
|
|
3132
|
+
# Default: `7` days
|
|
3147
3133
|
#
|
|
3148
|
-
#
|
|
3134
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
|
3135
|
+
# Amazon RDS issues an error.
|
|
3149
3136
|
#
|
|
3150
3137
|
# @option params [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
3151
3138
|
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
@@ -3161,12 +3148,6 @@ module Aws::RDS
|
|
|
3161
3148
|
# @option params [String] :network_type
|
|
3162
3149
|
# The network type of the DB cluster.
|
|
3163
3150
|
#
|
|
3164
|
-
# Valid values:
|
|
3165
|
-
#
|
|
3166
|
-
# * `IPV4`
|
|
3167
|
-
#
|
|
3168
|
-
# * `DUAL`
|
|
3169
|
-
#
|
|
3170
3151
|
# The network type is determined by the `DBSubnetGroup` specified for
|
|
3171
3152
|
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
3172
3153
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
@@ -3174,7 +3155,9 @@ module Aws::RDS
|
|
|
3174
3155
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
3175
3156
|
# the *Amazon Aurora User Guide.*
|
|
3176
3157
|
#
|
|
3177
|
-
# Valid for: Aurora DB clusters only
|
|
3158
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
3159
|
+
#
|
|
3160
|
+
# Valid Values: `IPV4 | DUAL`
|
|
3178
3161
|
#
|
|
3179
3162
|
#
|
|
3180
3163
|
#
|
|
@@ -3184,14 +3167,16 @@ module Aws::RDS
|
|
|
3184
3167
|
# Reserved for future use.
|
|
3185
3168
|
#
|
|
3186
3169
|
# @option params [Boolean] :manage_master_user_password
|
|
3187
|
-
#
|
|
3188
|
-
#
|
|
3170
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
3171
|
+
# Services Secrets Manager.
|
|
3189
3172
|
#
|
|
3190
3173
|
# For more information, see [Password management with Amazon Web
|
|
3191
3174
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
|
3192
3175
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
|
3193
3176
|
# the *Amazon Aurora User Guide.*
|
|
3194
3177
|
#
|
|
3178
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
3179
|
+
#
|
|
3195
3180
|
# Constraints:
|
|
3196
3181
|
#
|
|
3197
3182
|
# * Can't manage the master user password with Amazon Web Services
|
|
@@ -3199,8 +3184,6 @@ module Aws::RDS
|
|
|
3199
3184
|
#
|
|
3200
3185
|
# ^
|
|
3201
3186
|
#
|
|
3202
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
3203
|
-
#
|
|
3204
3187
|
#
|
|
3205
3188
|
#
|
|
3206
3189
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
@@ -3229,7 +3212,7 @@ module Aws::RDS
|
|
|
3229
3212
|
# Amazon Web Services account has a different default KMS key for each
|
|
3230
3213
|
# Amazon Web Services Region.
|
|
3231
3214
|
#
|
|
3232
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
3215
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
3233
3216
|
#
|
|
3234
3217
|
# @option params [String] :source_region
|
|
3235
3218
|
# The source region of the snapshot. This is only needed when the
|
|
@@ -4006,123 +3989,112 @@ module Aws::RDS
|
|
|
4006
3989
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html
|
|
4007
3990
|
#
|
|
4008
3991
|
# @option params [String] :db_name
|
|
4009
|
-
# The meaning of this parameter differs
|
|
4010
|
-
#
|
|
4011
|
-
#
|
|
4012
|
-
# **MySQL**
|
|
4013
|
-
#
|
|
4014
|
-
# The name of the database to create when the DB instance is created. If
|
|
4015
|
-
# this parameter isn't specified, no database is created in the DB
|
|
4016
|
-
# instance.
|
|
4017
|
-
#
|
|
4018
|
-
# Constraints:
|
|
4019
|
-
#
|
|
4020
|
-
# * Must contain 1 to 64 letters or numbers.
|
|
3992
|
+
# The meaning of this parameter differs depending on the database
|
|
3993
|
+
# engine.
|
|
4021
3994
|
#
|
|
4022
|
-
#
|
|
4023
|
-
#
|
|
3995
|
+
# Amazon Aurora MySQL
|
|
3996
|
+
# Amazon Aurora PostgreSQL
|
|
3997
|
+
# Amazon RDS Custom for Oracle
|
|
3998
|
+
# Amazon RDS Custom for SQL Server
|
|
3999
|
+
# RDS for MariaDB
|
|
4000
|
+
# RDS for MySQL
|
|
4001
|
+
# RDS for Oracle
|
|
4002
|
+
# RDS for PostgreSQL
|
|
4003
|
+
# RDS for SQL Server
|
|
4024
4004
|
#
|
|
4025
|
-
#
|
|
4005
|
+
# : The name of the database to create when the primary DB instance of
|
|
4006
|
+
# the Aurora MySQL DB cluster is created. If you don't specify a
|
|
4007
|
+
# value, Amazon RDS doesn't create a database in the DB cluster.
|
|
4026
4008
|
#
|
|
4027
|
-
#
|
|
4009
|
+
# Constraints:
|
|
4028
4010
|
#
|
|
4029
|
-
#
|
|
4030
|
-
# this parameter isn't specified, no database is created in the DB
|
|
4031
|
-
# instance.
|
|
4011
|
+
# * Must contain 1 to 64 alphanumeric characters.
|
|
4032
4012
|
#
|
|
4033
|
-
#
|
|
4013
|
+
# * Can't be a word reserved by the database engine.
|
|
4034
4014
|
#
|
|
4035
|
-
#
|
|
4015
|
+
# : The name of the database to create when the primary DB instance of
|
|
4016
|
+
# the Aurora PostgreSQL DB cluster is created.
|
|
4036
4017
|
#
|
|
4037
|
-
#
|
|
4038
|
-
# underscores, or digits (0-9).
|
|
4018
|
+
# Default: `postgres`
|
|
4039
4019
|
#
|
|
4040
|
-
#
|
|
4020
|
+
# Constraints:
|
|
4041
4021
|
#
|
|
4042
|
-
#
|
|
4022
|
+
# * Must contain 1 to 63 alphanumeric characters.
|
|
4043
4023
|
#
|
|
4044
|
-
#
|
|
4045
|
-
#
|
|
4046
|
-
# created in the DB instance.
|
|
4024
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4025
|
+
# underscores, or digits (0 to 9).
|
|
4047
4026
|
#
|
|
4048
|
-
#
|
|
4027
|
+
# * Can't be a word reserved by the database engine.
|
|
4049
4028
|
#
|
|
4050
|
-
#
|
|
4029
|
+
# : The Oracle System ID (SID) of the created RDS Custom DB instance.
|
|
4051
4030
|
#
|
|
4052
|
-
#
|
|
4053
|
-
# underscores, or digits (0-9).
|
|
4031
|
+
# Default: `ORCL`
|
|
4054
4032
|
#
|
|
4055
|
-
#
|
|
4033
|
+
# Constraints:
|
|
4056
4034
|
#
|
|
4057
|
-
#
|
|
4035
|
+
# * Must contain 1 to 8 alphanumeric characters.
|
|
4058
4036
|
#
|
|
4059
|
-
#
|
|
4060
|
-
# `null`, the default value `ORCL` is used. You can't specify the
|
|
4061
|
-
# string NULL, or any other reserved word, for `DBName`.
|
|
4037
|
+
# * Must contain a letter.
|
|
4062
4038
|
#
|
|
4063
|
-
#
|
|
4039
|
+
# * Can't be a word reserved by the database engine.
|
|
4064
4040
|
#
|
|
4065
|
-
#
|
|
4066
|
-
#
|
|
4067
|
-
# * Can't be longer than 8 characters
|
|
4041
|
+
# : Not applicable. Must be null.
|
|
4068
4042
|
#
|
|
4069
|
-
#
|
|
4043
|
+
# : The name of the database to create when the DB instance is created.
|
|
4044
|
+
# If you don't specify a value, Amazon RDS doesn't create a database
|
|
4045
|
+
# in the DB instance.
|
|
4070
4046
|
#
|
|
4071
|
-
#
|
|
4047
|
+
# Constraints:
|
|
4072
4048
|
#
|
|
4073
|
-
#
|
|
4074
|
-
# you don't specify a value, the default value is `ORCL`.
|
|
4049
|
+
# * Must contain 1 to 64 letters or numbers.
|
|
4075
4050
|
#
|
|
4076
|
-
#
|
|
4077
|
-
#
|
|
4078
|
-
# Constraints:
|
|
4051
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4052
|
+
# underscores, or digits (0-9).
|
|
4079
4053
|
#
|
|
4080
|
-
#
|
|
4054
|
+
# * Can't be a word reserved by the database engine.
|
|
4081
4055
|
#
|
|
4082
|
-
#
|
|
4056
|
+
# : The name of the database to create when the DB instance is created.
|
|
4057
|
+
# If you don't specify a value, Amazon RDS doesn't create a database
|
|
4058
|
+
# in the DB instance.
|
|
4083
4059
|
#
|
|
4084
|
-
#
|
|
4060
|
+
# Constraints:
|
|
4085
4061
|
#
|
|
4086
|
-
#
|
|
4062
|
+
# * Must contain 1 to 64 letters or numbers.
|
|
4087
4063
|
#
|
|
4088
|
-
#
|
|
4064
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4065
|
+
# underscores, or digits (0-9).
|
|
4089
4066
|
#
|
|
4090
|
-
#
|
|
4067
|
+
# * Can't be a word reserved by the database engine.
|
|
4091
4068
|
#
|
|
4092
|
-
#
|
|
4069
|
+
# : The Oracle System ID (SID) of the created DB instance.
|
|
4093
4070
|
#
|
|
4094
|
-
#
|
|
4071
|
+
# Default: `ORCL`
|
|
4095
4072
|
#
|
|
4096
|
-
#
|
|
4097
|
-
# Aurora MySQL DB cluster is created. If this parameter isn't specified
|
|
4098
|
-
# for an Aurora MySQL DB cluster, no database is created in the DB
|
|
4099
|
-
# cluster.
|
|
4073
|
+
# Constraints:
|
|
4100
4074
|
#
|
|
4101
|
-
#
|
|
4075
|
+
# * Can't be longer than 8 characters.
|
|
4102
4076
|
#
|
|
4103
|
-
#
|
|
4077
|
+
# * Can't be a word reserved by the database engine, such as the
|
|
4078
|
+
# string `NULL`.
|
|
4104
4079
|
#
|
|
4105
|
-
#
|
|
4080
|
+
# : The name of the database to create when the DB instance is created.
|
|
4106
4081
|
#
|
|
4107
|
-
#
|
|
4082
|
+
# Default: `postgres`
|
|
4108
4083
|
#
|
|
4109
|
-
#
|
|
4110
|
-
# Aurora PostgreSQL DB cluster is created. If this parameter isn't
|
|
4111
|
-
# specified for an Aurora PostgreSQL DB cluster, a database named
|
|
4112
|
-
# `postgres` is created in the DB cluster.
|
|
4084
|
+
# Constraints:
|
|
4113
4085
|
#
|
|
4114
|
-
#
|
|
4086
|
+
# * Must contain 1 to 63 letters, numbers, or underscores.
|
|
4115
4087
|
#
|
|
4116
|
-
#
|
|
4088
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4089
|
+
# underscores, or digits (0-9).
|
|
4117
4090
|
#
|
|
4118
|
-
#
|
|
4119
|
-
# underscores, or digits (0 to 9).
|
|
4091
|
+
# * Can't be a word reserved by the database engine.
|
|
4120
4092
|
#
|
|
4121
|
-
#
|
|
4093
|
+
# : Not applicable. Must be null.
|
|
4122
4094
|
#
|
|
4123
4095
|
# @option params [required, String] :db_instance_identifier
|
|
4124
|
-
# The DB instance
|
|
4125
|
-
# string.
|
|
4096
|
+
# The identifier for this DB instance. This parameter is stored as a
|
|
4097
|
+
# lowercase string.
|
|
4126
4098
|
#
|
|
4127
4099
|
# Constraints:
|
|
4128
4100
|
#
|
|
@@ -4138,107 +4110,100 @@ module Aws::RDS
|
|
|
4138
4110
|
# The amount of storage in gibibytes (GiB) to allocate for the DB
|
|
4139
4111
|
# instance.
|
|
4140
4112
|
#
|
|
4141
|
-
#
|
|
4113
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Aurora
|
|
4114
|
+
# cluster volumes automatically grow as the amount of data in your
|
|
4115
|
+
# database increases, though you are only charged for the space that you
|
|
4116
|
+
# use in an Aurora cluster volume.
|
|
4142
4117
|
#
|
|
4143
|
-
#
|
|
4118
|
+
# Amazon RDS Custom
|
|
4119
|
+
# RDS for MariaDB
|
|
4120
|
+
# RDS for MySQL
|
|
4121
|
+
# RDS for Oracle
|
|
4122
|
+
# RDS for PostgreSQL
|
|
4123
|
+
# RDS for SQL Server
|
|
4144
4124
|
#
|
|
4145
|
-
#
|
|
4146
|
-
#
|
|
4147
|
-
# for the space that you use in an Aurora cluster volume.
|
|
4125
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4126
|
+
# following:
|
|
4148
4127
|
#
|
|
4149
|
-
#
|
|
4128
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4129
|
+
# 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for
|
|
4130
|
+
# SQL Server.
|
|
4150
4131
|
#
|
|
4151
|
-
#
|
|
4152
|
-
#
|
|
4132
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to
|
|
4133
|
+
# 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
|
|
4134
|
+
# Server.
|
|
4153
4135
|
#
|
|
4154
|
-
#
|
|
4155
|
-
#
|
|
4156
|
-
# Server.
|
|
4136
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4137
|
+
# following:
|
|
4157
4138
|
#
|
|
4158
|
-
#
|
|
4159
|
-
#
|
|
4139
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4140
|
+
# 20 to 65536.
|
|
4160
4141
|
#
|
|
4161
|
-
#
|
|
4142
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4143
|
+
# 65536.
|
|
4162
4144
|
#
|
|
4163
|
-
#
|
|
4164
|
-
# following:
|
|
4145
|
+
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
4165
4146
|
#
|
|
4166
|
-
#
|
|
4167
|
-
#
|
|
4147
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4148
|
+
# following:
|
|
4168
4149
|
#
|
|
4169
|
-
#
|
|
4170
|
-
#
|
|
4150
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4151
|
+
# 20 to 65536.
|
|
4171
4152
|
#
|
|
4172
|
-
#
|
|
4153
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4154
|
+
# 65536.
|
|
4173
4155
|
#
|
|
4174
|
-
#
|
|
4156
|
+
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
4175
4157
|
#
|
|
4176
|
-
# Constraints to the amount of storage for each storage type are the
|
|
4177
|
-
#
|
|
4158
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4159
|
+
# following:
|
|
4178
4160
|
#
|
|
4179
|
-
#
|
|
4180
|
-
#
|
|
4161
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4162
|
+
# 20 to 65536.
|
|
4181
4163
|
#
|
|
4182
|
-
#
|
|
4183
|
-
#
|
|
4164
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4165
|
+
# 65536.
|
|
4184
4166
|
#
|
|
4185
|
-
#
|
|
4167
|
+
# * Magnetic storage (standard): Must be an integer from 10 to 3072.
|
|
4186
4168
|
#
|
|
4187
|
-
#
|
|
4169
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4170
|
+
# following:
|
|
4188
4171
|
#
|
|
4189
|
-
#
|
|
4190
|
-
#
|
|
4172
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4173
|
+
# 20 to 65536.
|
|
4191
4174
|
#
|
|
4192
|
-
#
|
|
4193
|
-
#
|
|
4175
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4176
|
+
# 65536.
|
|
4194
4177
|
#
|
|
4195
|
-
#
|
|
4196
|
-
# 65536.
|
|
4178
|
+
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
4197
4179
|
#
|
|
4198
|
-
#
|
|
4180
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4181
|
+
# following:
|
|
4199
4182
|
#
|
|
4200
|
-
#
|
|
4201
|
-
#
|
|
4202
|
-
# Constraints to the amount of storage for each storage type are the
|
|
4203
|
-
# following:
|
|
4204
|
-
#
|
|
4205
|
-
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
|
|
4206
|
-
# to 65536.
|
|
4183
|
+
# * General Purpose (SSD) storage (gp2, gp3):
|
|
4207
4184
|
#
|
|
4208
|
-
#
|
|
4209
|
-
#
|
|
4210
|
-
#
|
|
4211
|
-
# * Magnetic storage (standard): Must be an integer from 10 to 3072.
|
|
4212
|
-
#
|
|
4213
|
-
# **SQL Server**
|
|
4185
|
+
# * Enterprise and Standard editions: Must be an integer from 20 to
|
|
4186
|
+
# 16384.
|
|
4214
4187
|
#
|
|
4215
|
-
#
|
|
4216
|
-
# following:
|
|
4188
|
+
# * Web and Express editions: Must be an integer from 20 to 16384.
|
|
4217
4189
|
#
|
|
4218
|
-
#
|
|
4190
|
+
# * Provisioned IOPS storage (io1):
|
|
4219
4191
|
#
|
|
4220
|
-
#
|
|
4221
|
-
#
|
|
4192
|
+
# * Enterprise and Standard editions: Must be an integer from 100 to
|
|
4193
|
+
# 16384.
|
|
4222
4194
|
#
|
|
4223
|
-
#
|
|
4195
|
+
# * Web and Express editions: Must be an integer from 100 to 16384.
|
|
4224
4196
|
#
|
|
4225
|
-
#
|
|
4197
|
+
# * Magnetic storage (standard):
|
|
4226
4198
|
#
|
|
4227
|
-
#
|
|
4228
|
-
#
|
|
4199
|
+
# * Enterprise and Standard editions: Must be an integer from 20 to
|
|
4200
|
+
# 1024.
|
|
4229
4201
|
#
|
|
4230
|
-
#
|
|
4231
|
-
#
|
|
4232
|
-
# * Magnetic storage (standard):
|
|
4233
|
-
#
|
|
4234
|
-
# * Enterprise and Standard editions: Must be an integer from 20 to
|
|
4235
|
-
# 1024.
|
|
4236
|
-
#
|
|
4237
|
-
# * Web and Express editions: Must be an integer from 20 to 1024.
|
|
4202
|
+
# * Web and Express editions: Must be an integer from 20 to 1024.
|
|
4238
4203
|
#
|
|
4239
4204
|
# @option params [required, String] :db_instance_class
|
|
4240
4205
|
# The compute and memory capacity of the DB instance, for example
|
|
4241
|
-
# db.m5.large
|
|
4206
|
+
# `db.m5.large`. Not all DB instance classes are available in all Amazon
|
|
4242
4207
|
# Web Services Regions, or for all database engines. For the full list
|
|
4243
4208
|
# of DB instance classes, and availability for your engine, see [DB
|
|
4244
4209
|
# instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
|
|
@@ -4250,9 +4215,9 @@ module Aws::RDS
|
|
|
4250
4215
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
|
|
4251
4216
|
#
|
|
4252
4217
|
# @option params [required, String] :engine
|
|
4253
|
-
# The
|
|
4218
|
+
# The database engine to use for this DB instance.
|
|
4254
4219
|
#
|
|
4255
|
-
# Not every database engine is available
|
|
4220
|
+
# Not every database engine is available in every Amazon Web Services
|
|
4256
4221
|
# Region.
|
|
4257
4222
|
#
|
|
4258
4223
|
# Valid Values:
|
|
@@ -4261,15 +4226,15 @@ module Aws::RDS
|
|
|
4261
4226
|
#
|
|
4262
4227
|
# * `aurora-postgresql` (for Aurora PostgreSQL DB instances)
|
|
4263
4228
|
#
|
|
4264
|
-
# * `custom-oracle-ee (for RDS Custom for Oracle DB instances)
|
|
4229
|
+
# * `custom-oracle-ee` (for RDS Custom for Oracle DB instances)
|
|
4265
4230
|
#
|
|
4266
|
-
# * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
|
|
4231
|
+
# * `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)
|
|
4267
4232
|
#
|
|
4268
|
-
# * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
|
|
4233
|
+
# * `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)
|
|
4269
4234
|
#
|
|
4270
|
-
# * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
|
|
4235
|
+
# * `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)
|
|
4271
4236
|
#
|
|
4272
|
-
# * `custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
|
|
4237
|
+
# * `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)
|
|
4273
4238
|
#
|
|
4274
4239
|
# * `mariadb`
|
|
4275
4240
|
#
|
|
@@ -4296,17 +4261,13 @@ module Aws::RDS
|
|
|
4296
4261
|
# @option params [String] :master_username
|
|
4297
4262
|
# The name for the master user.
|
|
4298
4263
|
#
|
|
4299
|
-
#
|
|
4300
|
-
#
|
|
4301
|
-
# Not applicable. The name for the master user is managed by the DB
|
|
4302
|
-
# cluster.
|
|
4264
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The name
|
|
4265
|
+
# for the master user is managed by the DB cluster.
|
|
4303
4266
|
#
|
|
4304
|
-
#
|
|
4267
|
+
# This setting is required for RDS DB instances.
|
|
4305
4268
|
#
|
|
4306
4269
|
# Constraints:
|
|
4307
4270
|
#
|
|
4308
|
-
# * Required.
|
|
4309
|
-
#
|
|
4310
4271
|
# * Must be 1 to 16 letters, numbers, or underscores.
|
|
4311
4272
|
#
|
|
4312
4273
|
# * First character must be a letter.
|
|
@@ -4314,36 +4275,30 @@ module Aws::RDS
|
|
|
4314
4275
|
# * Can't be a reserved word for the chosen database engine.
|
|
4315
4276
|
#
|
|
4316
4277
|
# @option params [String] :master_user_password
|
|
4317
|
-
# The password for the master user.
|
|
4318
|
-
# printable ASCII character except "/", """, or "@".
|
|
4319
|
-
#
|
|
4320
|
-
# **Amazon Aurora**
|
|
4278
|
+
# The password for the master user.
|
|
4321
4279
|
#
|
|
4322
|
-
#
|
|
4323
|
-
# cluster.
|
|
4324
|
-
#
|
|
4325
|
-
# Constraints: Can't be specified if `ManageMasterUserPassword` is
|
|
4326
|
-
# turned on.
|
|
4327
|
-
#
|
|
4328
|
-
# **MariaDB**
|
|
4280
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4281
|
+
# password for the master user is managed by the DB cluster.
|
|
4329
4282
|
#
|
|
4330
|
-
# Constraints:
|
|
4283
|
+
# Constraints:
|
|
4331
4284
|
#
|
|
4332
|
-
#
|
|
4285
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
|
4333
4286
|
#
|
|
4334
|
-
#
|
|
4287
|
+
# * Can include any printable ASCII character except "/", """, or
|
|
4288
|
+
# "@".
|
|
4335
4289
|
#
|
|
4336
|
-
#
|
|
4290
|
+
# Length Constraints:
|
|
4337
4291
|
#
|
|
4338
|
-
#
|
|
4292
|
+
# * RDS for MariaDB - Must contain from 8 to 41 characters.
|
|
4339
4293
|
#
|
|
4340
|
-
#
|
|
4294
|
+
# * RDS for Microsoft SQL Server - Must contain from 8 to 128
|
|
4295
|
+
# characters.
|
|
4341
4296
|
#
|
|
4342
|
-
#
|
|
4297
|
+
# * RDS for MySQL - Must contain from 8 to 41 characters.
|
|
4343
4298
|
#
|
|
4344
|
-
#
|
|
4299
|
+
# * RDS for Oracle - Must contain from 8 to 30 characters.
|
|
4345
4300
|
#
|
|
4346
|
-
#
|
|
4301
|
+
# * RDS for PostgreSQL - Must contain from 8 to 128 characters.
|
|
4347
4302
|
#
|
|
4348
4303
|
# @option params [Array<String>] :db_security_groups
|
|
4349
4304
|
# A list of DB security groups to associate with this DB instance.
|
|
@@ -4356,10 +4311,9 @@ module Aws::RDS
|
|
|
4356
4311
|
# A list of Amazon EC2 VPC security groups to associate with this DB
|
|
4357
4312
|
# instance.
|
|
4358
4313
|
#
|
|
4359
|
-
#
|
|
4360
|
-
#
|
|
4361
|
-
#
|
|
4362
|
-
# managed by the DB cluster.
|
|
4314
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4315
|
+
# associated list of EC2 VPC security groups is managed by the DB
|
|
4316
|
+
# cluster.
|
|
4363
4317
|
#
|
|
4364
4318
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
|
4365
4319
|
# VPC.
|
|
@@ -4369,22 +4323,23 @@ module Aws::RDS
|
|
|
4369
4323
|
# information on Amazon Web Services Regions and Availability Zones, see
|
|
4370
4324
|
# [Regions and Availability Zones][1].
|
|
4371
4325
|
#
|
|
4372
|
-
#
|
|
4373
|
-
#
|
|
4374
|
-
#
|
|
4375
|
-
# Availability
|
|
4376
|
-
# automatically chooses an appropriate Availability Zone if you don't
|
|
4377
|
-
# specify one.
|
|
4326
|
+
# For Amazon Aurora, each Aurora DB cluster hosts copies of its storage
|
|
4327
|
+
# in three separate Availability Zones. Specify one of these
|
|
4328
|
+
# Availability Zones. Aurora automatically chooses an appropriate
|
|
4329
|
+
# Availability Zone if you don't specify one.
|
|
4378
4330
|
#
|
|
4379
4331
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
|
4380
4332
|
# Amazon Web Services Region.
|
|
4381
4333
|
#
|
|
4382
|
-
#
|
|
4334
|
+
# Constraints:
|
|
4383
4335
|
#
|
|
4384
|
-
#
|
|
4385
|
-
#
|
|
4386
|
-
#
|
|
4387
|
-
#
|
|
4336
|
+
# * The `AvailabilityZone` parameter can't be specified if the DB
|
|
4337
|
+
# instance is a Multi-AZ deployment.
|
|
4338
|
+
#
|
|
4339
|
+
# * The specified Availability Zone must be in the same Amazon Web
|
|
4340
|
+
# Services Region as the current endpoint.
|
|
4341
|
+
#
|
|
4342
|
+
# Example: `us-east-1d`
|
|
4388
4343
|
#
|
|
4389
4344
|
#
|
|
4390
4345
|
#
|
|
@@ -4393,25 +4348,34 @@ module Aws::RDS
|
|
|
4393
4348
|
# @option params [String] :db_subnet_group_name
|
|
4394
4349
|
# A DB subnet group to associate with this DB instance.
|
|
4395
4350
|
#
|
|
4396
|
-
# Constraints:
|
|
4397
|
-
#
|
|
4351
|
+
# Constraints:
|
|
4352
|
+
#
|
|
4353
|
+
# * Must match the name of an existing DB subnet group.
|
|
4354
|
+
#
|
|
4355
|
+
# * Must not be `default`.
|
|
4398
4356
|
#
|
|
4399
4357
|
# Example: `mydbsubnetgroup`
|
|
4400
4358
|
#
|
|
4401
4359
|
# @option params [String] :preferred_maintenance_window
|
|
4402
|
-
# The time range each week during which system maintenance can occur
|
|
4403
|
-
#
|
|
4404
|
-
# RDS
|
|
4405
|
-
#
|
|
4406
|
-
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
|
4360
|
+
# The time range each week during which system maintenance can occur.
|
|
4361
|
+
# For more information, see [Amazon RDS Maintenance Window][1] in the
|
|
4362
|
+
# *Amazon RDS User Guide.*
|
|
4407
4363
|
#
|
|
4408
4364
|
# The default is a 30-minute window selected at random from an 8-hour
|
|
4409
4365
|
# block of time for each Amazon Web Services Region, occurring on a
|
|
4410
4366
|
# random day of the week.
|
|
4411
4367
|
#
|
|
4412
|
-
#
|
|
4368
|
+
# Constraints:
|
|
4413
4369
|
#
|
|
4414
|
-
#
|
|
4370
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
|
4371
|
+
#
|
|
4372
|
+
# * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
|
|
4373
|
+
#
|
|
4374
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
4375
|
+
#
|
|
4376
|
+
# * Must not conflict with the preferred backup window.
|
|
4377
|
+
#
|
|
4378
|
+
# * Must be at least 30 minutes.
|
|
4415
4379
|
#
|
|
4416
4380
|
#
|
|
4417
4381
|
#
|
|
@@ -4419,38 +4383,36 @@ module Aws::RDS
|
|
|
4419
4383
|
#
|
|
4420
4384
|
# @option params [String] :db_parameter_group_name
|
|
4421
4385
|
# The name of the DB parameter group to associate with this DB instance.
|
|
4422
|
-
# If you
|
|
4423
|
-
# the specified DB engine and version
|
|
4386
|
+
# If you don't specify a value, then Amazon RDS uses the default DB
|
|
4387
|
+
# parameter group for the specified DB engine and version.
|
|
4424
4388
|
#
|
|
4425
|
-
# This setting doesn't apply to RDS Custom.
|
|
4389
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4426
4390
|
#
|
|
4427
4391
|
# Constraints:
|
|
4428
4392
|
#
|
|
4429
|
-
# *
|
|
4393
|
+
# * Must be 1 to 255 letters, numbers, or hyphens.
|
|
4430
4394
|
#
|
|
4431
4395
|
# * The first character must be a letter.
|
|
4432
4396
|
#
|
|
4433
|
-
# *
|
|
4397
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
|
4434
4398
|
#
|
|
4435
4399
|
# @option params [Integer] :backup_retention_period
|
|
4436
4400
|
# The number of days for which automated backups are retained. Setting
|
|
4437
4401
|
# this parameter to a positive number enables backups. Setting this
|
|
4438
|
-
# parameter to 0 disables automated backups.
|
|
4439
|
-
#
|
|
4440
|
-
# **Amazon Aurora**
|
|
4402
|
+
# parameter to `0` disables automated backups.
|
|
4441
4403
|
#
|
|
4442
|
-
#
|
|
4443
|
-
# by the DB cluster.
|
|
4404
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4405
|
+
# retention period for automated backups is managed by the DB cluster.
|
|
4444
4406
|
#
|
|
4445
|
-
# Default: 1
|
|
4407
|
+
# Default: `1`
|
|
4446
4408
|
#
|
|
4447
4409
|
# Constraints:
|
|
4448
4410
|
#
|
|
4449
|
-
# * Must be a value from 0 to 35
|
|
4411
|
+
# * Must be a value from 0 to 35.
|
|
4450
4412
|
#
|
|
4451
|
-
# * Can't be set to 0 if the DB instance is a source to read replicas
|
|
4413
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas.
|
|
4452
4414
|
#
|
|
4453
|
-
# * Can't be set to 0 for an RDS Custom for Oracle DB instance
|
|
4415
|
+
# * Can't be set to 0 for an RDS Custom for Oracle DB instance.
|
|
4454
4416
|
#
|
|
4455
4417
|
# @option params [String] :preferred_backup_window
|
|
4456
4418
|
# The daily time range during which automated backups are created if
|
|
@@ -4459,10 +4421,9 @@ module Aws::RDS
|
|
|
4459
4421
|
# an 8-hour block of time for each Amazon Web Services Region. For more
|
|
4460
4422
|
# information, see [Backup window][1] in the *Amazon RDS User Guide*.
|
|
4461
4423
|
#
|
|
4462
|
-
#
|
|
4463
|
-
#
|
|
4464
|
-
#
|
|
4465
|
-
# managed by the DB cluster.
|
|
4424
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The daily
|
|
4425
|
+
# time range for creating automated backups is managed by the DB
|
|
4426
|
+
# cluster.
|
|
4466
4427
|
#
|
|
4467
4428
|
# Constraints:
|
|
4468
4429
|
#
|
|
@@ -4481,66 +4442,49 @@ module Aws::RDS
|
|
|
4481
4442
|
# @option params [Integer] :port
|
|
4482
4443
|
# The port number on which the database accepts connections.
|
|
4483
4444
|
#
|
|
4484
|
-
#
|
|
4485
|
-
#
|
|
4486
|
-
# Default: `3306`
|
|
4487
|
-
#
|
|
4488
|
-
# Valid values: `1150-65535`
|
|
4489
|
-
#
|
|
4490
|
-
# Type: Integer
|
|
4491
|
-
#
|
|
4492
|
-
# **MariaDB**
|
|
4493
|
-
#
|
|
4494
|
-
# Default: `3306`
|
|
4495
|
-
#
|
|
4496
|
-
# Valid values: `1150-65535`
|
|
4497
|
-
#
|
|
4498
|
-
# Type: Integer
|
|
4499
|
-
#
|
|
4500
|
-
# **PostgreSQL**
|
|
4501
|
-
#
|
|
4502
|
-
# Default: `5432`
|
|
4503
|
-
#
|
|
4504
|
-
# Valid values: `1150-65535`
|
|
4445
|
+
# This setting doesn't apply to Aurora DB instances. The port number is
|
|
4446
|
+
# managed by the cluster.
|
|
4505
4447
|
#
|
|
4506
|
-
#
|
|
4507
|
-
#
|
|
4508
|
-
# **Oracle**
|
|
4448
|
+
# Valid Values: `1150-65535`
|
|
4509
4449
|
#
|
|
4510
|
-
# Default:
|
|
4450
|
+
# Default:
|
|
4511
4451
|
#
|
|
4512
|
-
#
|
|
4452
|
+
# * RDS for MariaDB - `3306`
|
|
4513
4453
|
#
|
|
4514
|
-
#
|
|
4454
|
+
# * RDS for Microsoft SQL Server - `1433`
|
|
4515
4455
|
#
|
|
4516
|
-
#
|
|
4456
|
+
# * RDS for MySQL - `3306`
|
|
4517
4457
|
#
|
|
4518
|
-
#
|
|
4519
|
-
# `3389`, `47001`, and `49152-49156`.
|
|
4458
|
+
# * RDS for Oracle - `1521`
|
|
4520
4459
|
#
|
|
4521
|
-
#
|
|
4460
|
+
# * RDS for PostgreSQL - `5432`
|
|
4522
4461
|
#
|
|
4523
|
-
#
|
|
4462
|
+
# Constraints:
|
|
4524
4463
|
#
|
|
4525
|
-
#
|
|
4464
|
+
# * For RDS for Microsoft SQL Server, the value can't be `1234`,
|
|
4465
|
+
# `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
|
|
4526
4466
|
#
|
|
4527
|
-
#
|
|
4467
|
+
# ^
|
|
4528
4468
|
#
|
|
4529
4469
|
# @option params [Boolean] :multi_az
|
|
4530
|
-
#
|
|
4531
|
-
#
|
|
4532
|
-
#
|
|
4470
|
+
# Specifies whether the DB instance is a Multi-AZ deployment. You can't
|
|
4471
|
+
# set the `AvailabilityZone` parameter if the DB instance is a Multi-AZ
|
|
4472
|
+
# deployment.
|
|
4533
4473
|
#
|
|
4534
|
-
# This setting doesn't apply to
|
|
4474
|
+
# This setting doesn't apply to the following DB instances:
|
|
4535
4475
|
#
|
|
4536
|
-
#
|
|
4476
|
+
# * Amazon Aurora (DB instance Availability Zones (AZs) are managed by
|
|
4477
|
+
# the DB cluster.)
|
|
4537
4478
|
#
|
|
4538
|
-
#
|
|
4539
|
-
# the DB cluster.
|
|
4479
|
+
# * RDS Custom
|
|
4540
4480
|
#
|
|
4541
4481
|
# @option params [String] :engine_version
|
|
4542
4482
|
# The version number of the database engine to use.
|
|
4543
4483
|
#
|
|
4484
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The version
|
|
4485
|
+
# number of the database engine the DB instance uses is managed by the
|
|
4486
|
+
# DB cluster.
|
|
4487
|
+
#
|
|
4544
4488
|
# For a list of valid engine versions, use the
|
|
4545
4489
|
# `DescribeDBEngineVersions` operation.
|
|
4546
4490
|
#
|
|
@@ -4549,48 +4493,37 @@ module Aws::RDS
|
|
|
4549
4493
|
# every database engine is available for every Amazon Web Services
|
|
4550
4494
|
# Region.
|
|
4551
4495
|
#
|
|
4552
|
-
#
|
|
4553
|
-
#
|
|
4554
|
-
#
|
|
4555
|
-
#
|
|
4556
|
-
#
|
|
4557
|
-
#
|
|
4558
|
-
#
|
|
4559
|
-
#
|
|
4560
|
-
#
|
|
4561
|
-
#
|
|
4562
|
-
#
|
|
4563
|
-
#
|
|
4564
|
-
#
|
|
4565
|
-
#
|
|
4566
|
-
#
|
|
4567
|
-
#
|
|
4568
|
-
# RDS User Guide*.
|
|
4569
|
-
#
|
|
4570
|
-
# **MariaDB**
|
|
4571
|
-
#
|
|
4572
|
-
# For information, see [MariaDB on Amazon RDS Versions][3] in the
|
|
4573
|
-
# *Amazon RDS User Guide*.
|
|
4574
|
-
#
|
|
4575
|
-
# **Microsoft SQL Server**
|
|
4576
|
-
#
|
|
4577
|
-
# For information, see [Microsoft SQL Server Versions on Amazon RDS][4]
|
|
4578
|
-
# in the *Amazon RDS User Guide*.
|
|
4579
|
-
#
|
|
4580
|
-
# **MySQL**
|
|
4496
|
+
# Amazon RDS Custom for Oracle
|
|
4497
|
+
# Amazon RDS Custom for SQL Server
|
|
4498
|
+
# RDS for MariaDB
|
|
4499
|
+
# RDS for Microsoft SQL Server
|
|
4500
|
+
# RDS for MySQL
|
|
4501
|
+
# RDS for Oracle
|
|
4502
|
+
# RDS for PostgreSQL
|
|
4503
|
+
#
|
|
4504
|
+
# : A custom engine version (CEV) that you have previously created. This
|
|
4505
|
+
# setting is required for RDS Custom for Oracle. The CEV name has the
|
|
4506
|
+
# following format: 19.*customized\_string*. A valid CEV name is
|
|
4507
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom for
|
|
4508
|
+
# Oracle DB instance][1] in the *Amazon RDS User Guide*.
|
|
4509
|
+
#
|
|
4510
|
+
# : See [RDS Custom for SQL Server general requirements][2] in the
|
|
4511
|
+
# *Amazon RDS User Guide*.
|
|
4581
4512
|
#
|
|
4582
|
-
# For information, see [
|
|
4583
|
-
#
|
|
4513
|
+
# : For information, see [MariaDB on Amazon RDS versions][3] in the
|
|
4514
|
+
# *Amazon RDS User Guide*.
|
|
4584
4515
|
#
|
|
4585
|
-
#
|
|
4516
|
+
# : For information, see [Microsoft SQL Server versions on Amazon
|
|
4517
|
+
# RDS][4] in the *Amazon RDS User Guide*.
|
|
4586
4518
|
#
|
|
4587
|
-
# For information, see [
|
|
4588
|
-
#
|
|
4519
|
+
# : For information, see [MySQL on Amazon RDS versions][5] in the
|
|
4520
|
+
# *Amazon RDS User Guide*.
|
|
4589
4521
|
#
|
|
4590
|
-
#
|
|
4522
|
+
# : For information, see [Oracle Database Engine release notes][6] in
|
|
4523
|
+
# the *Amazon RDS User Guide*.
|
|
4591
4524
|
#
|
|
4592
|
-
# For information, see [Amazon RDS for PostgreSQL versions and
|
|
4593
|
-
#
|
|
4525
|
+
# : For information, see [Amazon RDS for PostgreSQL versions and
|
|
4526
|
+
# extensions][7] in the *Amazon RDS User Guide*.
|
|
4594
4527
|
#
|
|
4595
4528
|
#
|
|
4596
4529
|
#
|
|
@@ -4603,78 +4536,83 @@ module Aws::RDS
|
|
|
4603
4536
|
# [7]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
|
4604
4537
|
#
|
|
4605
4538
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
4606
|
-
#
|
|
4607
|
-
#
|
|
4608
|
-
#
|
|
4539
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
|
4540
|
+
# the DB instance during the maintenance window. By default, minor
|
|
4541
|
+
# engine upgrades are applied automatically.
|
|
4609
4542
|
#
|
|
4610
4543
|
# If you create an RDS Custom DB instance, you must set
|
|
4611
4544
|
# `AutoMinorVersionUpgrade` to `false`.
|
|
4612
4545
|
#
|
|
4613
4546
|
# @option params [String] :license_model
|
|
4614
|
-
#
|
|
4547
|
+
# The license model information for this DB instance.
|
|
4615
4548
|
#
|
|
4616
|
-
#
|
|
4617
|
-
#
|
|
4549
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4550
|
+
# instances.
|
|
4618
4551
|
#
|
|
4619
|
-
#
|
|
4552
|
+
# Valid Values:
|
|
4620
4553
|
#
|
|
4621
|
-
#
|
|
4554
|
+
# * RDS for MariaDB - `general-public-license`
|
|
4622
4555
|
#
|
|
4623
|
-
#
|
|
4556
|
+
# * RDS for Microsoft SQL Server - `license-included`
|
|
4557
|
+
#
|
|
4558
|
+
# * RDS for MySQL - `general-public-license`
|
|
4559
|
+
#
|
|
4560
|
+
# * RDS for Oracle - `bring-your-own-license | license-included`
|
|
4561
|
+
#
|
|
4562
|
+
# * RDS for PostgreSQL - `postgresql-license`
|
|
4624
4563
|
#
|
|
4625
4564
|
# @option params [Integer] :iops
|
|
4626
4565
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
|
4627
|
-
#
|
|
4628
|
-
#
|
|
4629
|
-
#
|
|
4566
|
+
# initially allocate for the DB instance. For information about valid
|
|
4567
|
+
# IOPS values, see [Amazon RDS DB instance storage][1] in the *Amazon
|
|
4568
|
+
# RDS User Guide*.
|
|
4569
|
+
#
|
|
4570
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Storage is
|
|
4571
|
+
# managed by the DB cluster.
|
|
4630
4572
|
#
|
|
4631
|
-
# Constraints:
|
|
4632
|
-
# must be a multiple between .5 and 50 of the storage amount for the DB
|
|
4633
|
-
# instance. For SQL Server DB instances, must be a multiple between 1
|
|
4634
|
-
# and 50 of the storage amount for the DB instance.
|
|
4573
|
+
# Constraints:
|
|
4635
4574
|
#
|
|
4636
|
-
#
|
|
4575
|
+
# * For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a
|
|
4576
|
+
# multiple between .5 and 50 of the storage amount for the DB
|
|
4577
|
+
# instance.
|
|
4637
4578
|
#
|
|
4638
|
-
#
|
|
4579
|
+
# * For RDS for SQL Server - Must be a multiple between 1 and 50 of the
|
|
4580
|
+
# storage amount for the DB instance.
|
|
4639
4581
|
#
|
|
4640
4582
|
#
|
|
4641
4583
|
#
|
|
4642
4584
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
|
|
4643
4585
|
#
|
|
4644
4586
|
# @option params [String] :option_group_name
|
|
4645
|
-
#
|
|
4646
|
-
# the specified option group.
|
|
4587
|
+
# The option group to associate the DB instance with.
|
|
4647
4588
|
#
|
|
4648
4589
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
|
4649
4590
|
# TDE, can't be removed from an option group. Also, that option group
|
|
4650
4591
|
# can't be removed from a DB instance after it is associated with a DB
|
|
4651
4592
|
# instance.
|
|
4652
4593
|
#
|
|
4653
|
-
# This setting doesn't apply to RDS Custom
|
|
4654
|
-
#
|
|
4655
|
-
# **Amazon Aurora**
|
|
4656
|
-
#
|
|
4657
|
-
# Not applicable.
|
|
4594
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4595
|
+
# instances.
|
|
4658
4596
|
#
|
|
4659
4597
|
# @option params [String] :character_set_name
|
|
4660
|
-
# For supported engines,
|
|
4661
|
-
#
|
|
4598
|
+
# For supported engines, the character set (`CharacterSet`) to associate
|
|
4599
|
+
# the DB instance with.
|
|
4662
4600
|
#
|
|
4663
|
-
# This setting doesn't apply to
|
|
4664
|
-
# change the character set, you can change it on the database itself.
|
|
4601
|
+
# This setting doesn't apply to the following DB instances:
|
|
4665
4602
|
#
|
|
4666
|
-
#
|
|
4603
|
+
# * Amazon Aurora - The character set is managed by the DB cluster. For
|
|
4604
|
+
# more information, see `CreateDBCluster`.
|
|
4667
4605
|
#
|
|
4668
|
-
#
|
|
4669
|
-
#
|
|
4606
|
+
# * RDS Custom - However, if you need to change the character set, you
|
|
4607
|
+
# can change it on the database itself.
|
|
4670
4608
|
#
|
|
4671
4609
|
# @option params [String] :nchar_character_set_name
|
|
4672
4610
|
# The name of the NCHAR character set for the Oracle DB instance.
|
|
4673
4611
|
#
|
|
4674
|
-
# This
|
|
4612
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4675
4613
|
#
|
|
4676
4614
|
# @option params [Boolean] :publicly_accessible
|
|
4677
|
-
#
|
|
4615
|
+
# Specifies whether the DB instance is publicly accessible.
|
|
4678
4616
|
#
|
|
4679
4617
|
# When the DB instance is publicly accessible, its Domain Name System
|
|
4680
4618
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
|
@@ -4712,51 +4650,46 @@ module Aws::RDS
|
|
|
4712
4650
|
# Tags to assign to the DB instance.
|
|
4713
4651
|
#
|
|
4714
4652
|
# @option params [String] :db_cluster_identifier
|
|
4715
|
-
# The identifier of the DB cluster that
|
|
4653
|
+
# The identifier of the DB cluster that this DB instance will belong to.
|
|
4716
4654
|
#
|
|
4717
|
-
# This setting doesn't apply to RDS Custom.
|
|
4655
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4718
4656
|
#
|
|
4719
4657
|
# @option params [String] :storage_type
|
|
4720
|
-
#
|
|
4721
|
-
#
|
|
4722
|
-
# Valid values: `gp2 | gp3 | io1 | standard`
|
|
4658
|
+
# The storage type to associate with the DB instance.
|
|
4723
4659
|
#
|
|
4724
4660
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
|
4725
4661
|
# `Iops` parameter.
|
|
4726
4662
|
#
|
|
4727
|
-
#
|
|
4663
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Storage is
|
|
4664
|
+
# managed by the DB cluster.
|
|
4728
4665
|
#
|
|
4729
|
-
#
|
|
4666
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
|
4730
4667
|
#
|
|
4731
|
-
#
|
|
4668
|
+
# Default: `io1`, if the `Iops` parameter is specified. Otherwise,
|
|
4669
|
+
# `gp2`.
|
|
4732
4670
|
#
|
|
4733
4671
|
# @option params [String] :tde_credential_arn
|
|
4734
4672
|
# The ARN from the key store with which to associate the instance for
|
|
4735
4673
|
# TDE encryption.
|
|
4736
4674
|
#
|
|
4737
|
-
# This setting doesn't apply to RDS Custom
|
|
4738
|
-
#
|
|
4739
|
-
# **Amazon Aurora**
|
|
4740
|
-
#
|
|
4741
|
-
# Not applicable.
|
|
4675
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4676
|
+
# instances.
|
|
4742
4677
|
#
|
|
4743
4678
|
# @option params [String] :tde_credential_password
|
|
4744
4679
|
# The password for the given ARN from the key store in order to access
|
|
4745
4680
|
# the device.
|
|
4746
4681
|
#
|
|
4747
|
-
# This setting doesn't apply to RDS Custom.
|
|
4682
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4748
4683
|
#
|
|
4749
4684
|
# @option params [Boolean] :storage_encrypted
|
|
4750
|
-
#
|
|
4751
|
-
#
|
|
4752
|
-
#
|
|
4753
|
-
# For RDS Custom instances, either set this parameter to `true` or leave
|
|
4754
|
-
# it unset. If you set this parameter to `false`, RDS reports an error.
|
|
4685
|
+
# Specifes whether the DB instance is encrypted. By default, it isn't
|
|
4686
|
+
# encrypted.
|
|
4755
4687
|
#
|
|
4756
|
-
#
|
|
4688
|
+
# For RDS Custom DB instances, either enable this setting or leave it
|
|
4689
|
+
# unset. Otherwise, Amazon RDS reports an error.
|
|
4757
4690
|
#
|
|
4758
|
-
#
|
|
4759
|
-
# cluster.
|
|
4691
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4692
|
+
# encryption for DB instances is managed by the DB cluster.
|
|
4760
4693
|
#
|
|
4761
4694
|
# @option params [String] :kms_key_id
|
|
4762
4695
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
|
@@ -4767,10 +4700,9 @@ module Aws::RDS
|
|
|
4767
4700
|
# different Amazon Web Services account, specify the key ARN or alias
|
|
4768
4701
|
# ARN.
|
|
4769
4702
|
#
|
|
4770
|
-
#
|
|
4771
|
-
#
|
|
4772
|
-
#
|
|
4773
|
-
# by the DB cluster. For more information, see `CreateDBCluster`.
|
|
4703
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The Amazon
|
|
4704
|
+
# Web Services KMS key identifier is managed by the DB cluster. For more
|
|
4705
|
+
# information, see `CreateDBCluster`.
|
|
4774
4706
|
#
|
|
4775
4707
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
|
4776
4708
|
# the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
|
|
@@ -4778,53 +4710,51 @@ module Aws::RDS
|
|
|
4778
4710
|
# Amazon Web Services account has a different default KMS key for each
|
|
4779
4711
|
# Amazon Web Services Region.
|
|
4780
4712
|
#
|
|
4781
|
-
#
|
|
4782
|
-
#
|
|
4783
|
-
#
|
|
4784
|
-
#
|
|
4785
|
-
#
|
|
4786
|
-
# the default key when this parameter is empty. You must explicitly
|
|
4787
|
-
# specify a key.
|
|
4713
|
+
# For Amazon RDS Custom, a KMS key is required for DB instances. For
|
|
4714
|
+
# most RDS engines, if you leave this parameter empty while enabling
|
|
4715
|
+
# `StorageEncrypted`, the engine uses the default KMS key. However, RDS
|
|
4716
|
+
# Custom doesn't use the default key when this parameter is empty. You
|
|
4717
|
+
# must explicitly specify a key.
|
|
4788
4718
|
#
|
|
4789
4719
|
# @option params [String] :domain
|
|
4790
4720
|
# The Active Directory directory ID to create the DB instance in.
|
|
4791
|
-
# Currently, only
|
|
4721
|
+
# Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB
|
|
4792
4722
|
# instances can be created in an Active Directory Domain.
|
|
4793
4723
|
#
|
|
4794
4724
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
|
4795
4725
|
# RDS User Guide*.
|
|
4796
4726
|
#
|
|
4797
|
-
# This setting doesn't apply to
|
|
4727
|
+
# This setting doesn't apply to the following DB instances:
|
|
4798
4728
|
#
|
|
4799
|
-
#
|
|
4729
|
+
# * Amazon Aurora (The domain is managed by the DB cluster.)
|
|
4800
4730
|
#
|
|
4801
|
-
#
|
|
4731
|
+
# * RDS Custom
|
|
4802
4732
|
#
|
|
4803
4733
|
#
|
|
4804
4734
|
#
|
|
4805
4735
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
|
4806
4736
|
#
|
|
4807
4737
|
# @option params [Boolean] :copy_tags_to_snapshot
|
|
4808
|
-
#
|
|
4809
|
-
#
|
|
4810
|
-
#
|
|
4811
|
-
# **Amazon Aurora**
|
|
4738
|
+
# Spcifies whether to copy tags from the DB instance to snapshots of the
|
|
4739
|
+
# DB instance. By default, tags are not copied.
|
|
4812
4740
|
#
|
|
4813
|
-
#
|
|
4814
|
-
#
|
|
4815
|
-
# the DB cluster setting.
|
|
4741
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Copying
|
|
4742
|
+
# tags to snapshots is managed by the DB cluster. Setting this value for
|
|
4743
|
+
# an Aurora DB instance has no effect on the DB cluster setting.
|
|
4816
4744
|
#
|
|
4817
4745
|
# @option params [Integer] :monitoring_interval
|
|
4818
4746
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
4819
4747
|
# metrics are collected for the DB instance. To disable collection of
|
|
4820
|
-
# Enhanced Monitoring metrics, specify 0
|
|
4748
|
+
# Enhanced Monitoring metrics, specify `0`.
|
|
4821
4749
|
#
|
|
4822
4750
|
# If `MonitoringRoleArn` is specified, then you must set
|
|
4823
|
-
# `MonitoringInterval` to a value other than 0
|
|
4751
|
+
# `MonitoringInterval` to a value other than `0`.
|
|
4824
4752
|
#
|
|
4825
|
-
# This setting doesn't apply to RDS Custom.
|
|
4753
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4826
4754
|
#
|
|
4827
|
-
# Valid Values: `0
|
|
4755
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
|
4756
|
+
#
|
|
4757
|
+
# Default: `0`
|
|
4828
4758
|
#
|
|
4829
4759
|
# @option params [String] :monitoring_role_arn
|
|
4830
4760
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
|
@@ -4833,40 +4763,40 @@ module Aws::RDS
|
|
|
4833
4763
|
# a monitoring role, see [Setting Up and Enabling Enhanced
|
|
4834
4764
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
|
4835
4765
|
#
|
|
4836
|
-
# If `MonitoringInterval` is set to a value other than 0
|
|
4837
|
-
# supply a `MonitoringRoleArn` value.
|
|
4766
|
+
# If `MonitoringInterval` is set to a value other than `0`, then you
|
|
4767
|
+
# must supply a `MonitoringRoleArn` value.
|
|
4838
4768
|
#
|
|
4839
|
-
# This setting doesn't apply to RDS Custom.
|
|
4769
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4840
4770
|
#
|
|
4841
4771
|
#
|
|
4842
4772
|
#
|
|
4843
4773
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
|
4844
4774
|
#
|
|
4845
4775
|
# @option params [String] :domain_iam_role_name
|
|
4846
|
-
#
|
|
4847
|
-
#
|
|
4776
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
4777
|
+
# Service.
|
|
4848
4778
|
#
|
|
4849
|
-
# This setting doesn't apply to
|
|
4779
|
+
# This setting doesn't apply to the following DB instances:
|
|
4850
4780
|
#
|
|
4851
|
-
#
|
|
4781
|
+
# * Amazon Aurora (The domain is managed by the DB cluster.)
|
|
4852
4782
|
#
|
|
4853
|
-
#
|
|
4783
|
+
# * RDS Custom
|
|
4854
4784
|
#
|
|
4855
4785
|
# @option params [Integer] :promotion_tier
|
|
4856
|
-
#
|
|
4857
|
-
#
|
|
4858
|
-
#
|
|
4859
|
-
#
|
|
4786
|
+
# The order of priority in which an Aurora Replica is promoted to the
|
|
4787
|
+
# primary instance after a failure of the existing primary instance. For
|
|
4788
|
+
# more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
|
|
4789
|
+
# in the *Amazon Aurora User Guide*.
|
|
4860
4790
|
#
|
|
4861
|
-
# This setting doesn't apply to RDS Custom.
|
|
4791
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4862
4792
|
#
|
|
4863
|
-
# Default: 1
|
|
4793
|
+
# Default: `1`
|
|
4864
4794
|
#
|
|
4865
|
-
# Valid Values: 0 - 15
|
|
4795
|
+
# Valid Values: `0 - 15`
|
|
4866
4796
|
#
|
|
4867
4797
|
#
|
|
4868
4798
|
#
|
|
4869
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
|
4799
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
|
|
4870
4800
|
#
|
|
4871
4801
|
# @option params [String] :timezone
|
|
4872
4802
|
# The time zone of the DB instance. The time zone parameter is currently
|
|
@@ -4877,30 +4807,30 @@ module Aws::RDS
|
|
|
4877
4807
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
|
4878
4808
|
#
|
|
4879
4809
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
4880
|
-
#
|
|
4881
|
-
#
|
|
4882
|
-
#
|
|
4810
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
|
4811
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
|
4812
|
+
# mapping isn't enabled.
|
|
4883
4813
|
#
|
|
4884
4814
|
# For more information, see [ IAM Database Authentication for MySQL and
|
|
4885
4815
|
# PostgreSQL][1] in the *Amazon RDS User Guide*.
|
|
4886
4816
|
#
|
|
4887
|
-
# This setting doesn't apply to
|
|
4817
|
+
# This setting doesn't apply to the following DB instances:
|
|
4888
4818
|
#
|
|
4889
|
-
#
|
|
4819
|
+
# * Amazon Aurora (Mapping Amazon Web Services IAM accounts to database
|
|
4820
|
+
# accounts is managed by the DB cluster.)
|
|
4890
4821
|
#
|
|
4891
|
-
#
|
|
4892
|
-
# accounts is managed by the DB cluster.
|
|
4822
|
+
# * RDS Custom
|
|
4893
4823
|
#
|
|
4894
4824
|
#
|
|
4895
4825
|
#
|
|
4896
4826
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
|
4897
4827
|
#
|
|
4898
4828
|
# @option params [Boolean] :enable_performance_insights
|
|
4899
|
-
#
|
|
4900
|
-
#
|
|
4901
|
-
#
|
|
4829
|
+
# Specifies whether to enable Performance Insights for the DB instance.
|
|
4830
|
+
# For more information, see [Using Amazon Performance Insights][1] in
|
|
4831
|
+
# the *Amazon RDS User Guide*.
|
|
4902
4832
|
#
|
|
4903
|
-
# This setting doesn't apply to RDS Custom.
|
|
4833
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4904
4834
|
#
|
|
4905
4835
|
#
|
|
4906
4836
|
#
|
|
@@ -4913,72 +4843,56 @@ module Aws::RDS
|
|
|
4913
4843
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
|
4914
4844
|
# alias ARN, or alias name for the KMS key.
|
|
4915
4845
|
#
|
|
4916
|
-
# If you
|
|
4846
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
|
4917
4847
|
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
|
4918
4848
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
|
4919
4849
|
# a different default KMS key for each Amazon Web Services Region.
|
|
4920
4850
|
#
|
|
4921
|
-
# This setting doesn't apply to RDS Custom.
|
|
4851
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4922
4852
|
#
|
|
4923
4853
|
# @option params [Integer] :performance_insights_retention_period
|
|
4924
|
-
# The number of days to retain Performance Insights data.
|
|
4925
|
-
# 7 days. The following values are valid:
|
|
4854
|
+
# The number of days to retain Performance Insights data.
|
|
4926
4855
|
#
|
|
4927
|
-
#
|
|
4928
|
-
#
|
|
4929
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
|
4930
|
-
#
|
|
4931
|
-
# * 731
|
|
4932
|
-
#
|
|
4933
|
-
# For example, the following values are valid:
|
|
4856
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4934
4857
|
#
|
|
4935
|
-
#
|
|
4858
|
+
# Valid Values:
|
|
4936
4859
|
#
|
|
4937
|
-
# *
|
|
4860
|
+
# * `7`
|
|
4938
4861
|
#
|
|
4939
|
-
# *
|
|
4862
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
|
4863
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
|
4864
|
+
# months * 31)
|
|
4940
4865
|
#
|
|
4941
|
-
# * 731
|
|
4866
|
+
# * `731`
|
|
4942
4867
|
#
|
|
4943
|
-
#
|
|
4944
|
-
# value, RDS issues an error.
|
|
4868
|
+
# Default: `7` days
|
|
4945
4869
|
#
|
|
4946
|
-
#
|
|
4870
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
|
4871
|
+
# Amazon RDS returns an error.
|
|
4947
4872
|
#
|
|
4948
4873
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
|
4949
4874
|
# The list of log types that need to be enabled for exporting to
|
|
4950
|
-
# CloudWatch Logs.
|
|
4951
|
-
#
|
|
4952
|
-
# Logs][1] in the *Amazon RDS User Guide*.
|
|
4953
|
-
#
|
|
4954
|
-
# **Amazon Aurora**
|
|
4875
|
+
# CloudWatch Logs. For more information, see [ Publishing Database Logs
|
|
4876
|
+
# to Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
|
4955
4877
|
#
|
|
4956
|
-
#
|
|
4878
|
+
# This setting doesn't apply to the following DB instances:
|
|
4957
4879
|
#
|
|
4958
|
-
#
|
|
4880
|
+
# * Amazon Aurora (CloudWatch Logs exports are managed by the DB
|
|
4881
|
+
# cluster.)
|
|
4959
4882
|
#
|
|
4960
|
-
#
|
|
4883
|
+
# * RDS Custom
|
|
4961
4884
|
#
|
|
4962
|
-
#
|
|
4963
|
-
#
|
|
4964
|
-
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
|
4965
|
-
#
|
|
4966
|
-
# **Microsoft SQL Server**
|
|
4967
|
-
#
|
|
4968
|
-
# Possible values are `agent` and `error`.
|
|
4969
|
-
#
|
|
4970
|
-
# **MySQL**
|
|
4885
|
+
# The following values are valid for each DB engine:
|
|
4971
4886
|
#
|
|
4972
|
-
#
|
|
4887
|
+
# * RDS for MariaDB - `audit | error | general | slowquery`
|
|
4973
4888
|
#
|
|
4974
|
-
#
|
|
4889
|
+
# * RDS for Microsoft SQL Server - `agent | error`
|
|
4975
4890
|
#
|
|
4976
|
-
#
|
|
4977
|
-
# `oemagent`.
|
|
4891
|
+
# * RDS for MySQL - `audit | error | general | slowquery`
|
|
4978
4892
|
#
|
|
4979
|
-
#
|
|
4893
|
+
# * RDS for Oracle - `alert | audit | listener | trace | oemagent`
|
|
4980
4894
|
#
|
|
4981
|
-
#
|
|
4895
|
+
# * RDS for PostgreSQL - `postgresql | upgrade`
|
|
4982
4896
|
#
|
|
4983
4897
|
#
|
|
4984
4898
|
#
|
|
@@ -4988,24 +4902,20 @@ module Aws::RDS
|
|
|
4988
4902
|
# The number of CPU cores and the number of threads per core for the DB
|
|
4989
4903
|
# instance class of the DB instance.
|
|
4990
4904
|
#
|
|
4991
|
-
# This setting doesn't apply to RDS Custom
|
|
4992
|
-
#
|
|
4993
|
-
# **Amazon Aurora**
|
|
4994
|
-
#
|
|
4995
|
-
# Not applicable.
|
|
4905
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4906
|
+
# instances.
|
|
4996
4907
|
#
|
|
4997
4908
|
# @option params [Boolean] :deletion_protection
|
|
4998
|
-
#
|
|
4999
|
-
#
|
|
5000
|
-
#
|
|
5001
|
-
#
|
|
5002
|
-
#
|
|
5003
|
-
#
|
|
5004
|
-
#
|
|
5005
|
-
#
|
|
5006
|
-
#
|
|
5007
|
-
#
|
|
5008
|
-
# enabled for the DB cluster.
|
|
4909
|
+
# Specifies whether the DB instance has deletion protection enabled. The
|
|
4910
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
4911
|
+
# default, deletion protection isn't enabled. For more information, see
|
|
4912
|
+
# [ Deleting a DB Instance][1].
|
|
4913
|
+
#
|
|
4914
|
+
# This setting doesn't apply to Amazon Aurora DB instances. You can
|
|
4915
|
+
# enable or disable deletion protection for the DB cluster. For more
|
|
4916
|
+
# information, see `CreateDBCluster`. DB instances in a DB cluster can
|
|
4917
|
+
# be deleted even when deletion protection is enabled for the DB
|
|
4918
|
+
# cluster.
|
|
5009
4919
|
#
|
|
5010
4920
|
#
|
|
5011
4921
|
#
|
|
@@ -5019,19 +4929,19 @@ module Aws::RDS
|
|
|
5019
4929
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
|
5020
4930
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
|
5021
4931
|
#
|
|
5022
|
-
# This setting doesn't apply to
|
|
4932
|
+
# This setting doesn't apply to the following DB instances:
|
|
5023
4933
|
#
|
|
5024
|
-
#
|
|
4934
|
+
# * Amazon Aurora (Storage is managed by the DB cluster.)
|
|
5025
4935
|
#
|
|
5026
|
-
#
|
|
4936
|
+
# * RDS Custom
|
|
5027
4937
|
#
|
|
5028
4938
|
#
|
|
5029
4939
|
#
|
|
5030
4940
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
5031
4941
|
#
|
|
5032
4942
|
# @option params [Boolean] :enable_customer_owned_ip
|
|
5033
|
-
#
|
|
5034
|
-
#
|
|
4943
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
4944
|
+
# RDS on Outposts DB instance.
|
|
5035
4945
|
#
|
|
5036
4946
|
# A *CoIP* provides local or external connectivity to resources in your
|
|
5037
4947
|
# Outpost subnets through your on-premises network. For some use cases,
|
|
@@ -5052,8 +4962,11 @@ module Aws::RDS
|
|
|
5052
4962
|
#
|
|
5053
4963
|
# @option params [String] :custom_iam_instance_profile
|
|
5054
4964
|
# The instance profile associated with the underlying Amazon EC2
|
|
5055
|
-
# instance of an RDS Custom DB instance.
|
|
5056
|
-
#
|
|
4965
|
+
# instance of an RDS Custom DB instance.
|
|
4966
|
+
#
|
|
4967
|
+
# This setting is required for RDS Custom.
|
|
4968
|
+
#
|
|
4969
|
+
# Constraints:
|
|
5057
4970
|
#
|
|
5058
4971
|
# * The profile must exist in your account.
|
|
5059
4972
|
#
|
|
@@ -5066,17 +4979,20 @@ module Aws::RDS
|
|
|
5066
4979
|
# For the list of permissions required for the IAM role, see [ Configure
|
|
5067
4980
|
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
5068
4981
|
#
|
|
5069
|
-
# This setting is required for RDS Custom.
|
|
5070
|
-
#
|
|
5071
4982
|
#
|
|
5072
4983
|
#
|
|
5073
4984
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
5074
4985
|
#
|
|
5075
4986
|
# @option params [String] :backup_target
|
|
5076
|
-
#
|
|
4987
|
+
# The location for storing automated backups and manual snapshots.
|
|
5077
4988
|
#
|
|
5078
|
-
#
|
|
5079
|
-
#
|
|
4989
|
+
# Valie Values:
|
|
4990
|
+
#
|
|
4991
|
+
# * `outposts` (Amazon Web Services Outposts)
|
|
4992
|
+
#
|
|
4993
|
+
# * `region` (Amazon Web Services Region)
|
|
4994
|
+
#
|
|
4995
|
+
# Default: `region`
|
|
5080
4996
|
#
|
|
5081
4997
|
# For more information, see [Working with Amazon RDS on Amazon Web
|
|
5082
4998
|
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
|
@@ -5088,12 +5004,6 @@ module Aws::RDS
|
|
|
5088
5004
|
# @option params [String] :network_type
|
|
5089
5005
|
# The network type of the DB instance.
|
|
5090
5006
|
#
|
|
5091
|
-
# Valid values:
|
|
5092
|
-
#
|
|
5093
|
-
# * `IPV4`
|
|
5094
|
-
#
|
|
5095
|
-
# * `DUAL`
|
|
5096
|
-
#
|
|
5097
5007
|
# The network type is determined by the `DBSubnetGroup` specified for
|
|
5098
5008
|
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
5099
5009
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
@@ -5101,20 +5011,23 @@ module Aws::RDS
|
|
|
5101
5011
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
5102
5012
|
# the *Amazon RDS User Guide.*
|
|
5103
5013
|
#
|
|
5014
|
+
# Valid Values: `IPV4 | DUAL`
|
|
5015
|
+
#
|
|
5104
5016
|
#
|
|
5105
5017
|
#
|
|
5106
5018
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
5107
5019
|
#
|
|
5108
5020
|
# @option params [Integer] :storage_throughput
|
|
5109
|
-
#
|
|
5021
|
+
# The storage throughput value for the DB instance.
|
|
5110
5022
|
#
|
|
5111
5023
|
# This setting applies only to the `gp3` storage type.
|
|
5112
5024
|
#
|
|
5113
|
-
# This setting doesn't apply to
|
|
5025
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
5026
|
+
# instances.
|
|
5114
5027
|
#
|
|
5115
5028
|
# @option params [Boolean] :manage_master_user_password
|
|
5116
|
-
#
|
|
5117
|
-
#
|
|
5029
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
5030
|
+
# Services Secrets Manager.
|
|
5118
5031
|
#
|
|
5119
5032
|
# For more information, see [Password management with Amazon Web
|
|
5120
5033
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
|
@@ -5154,10 +5067,10 @@ module Aws::RDS
|
|
|
5154
5067
|
# Amazon Web Services Region.
|
|
5155
5068
|
#
|
|
5156
5069
|
# @option params [String] :ca_certificate_identifier
|
|
5157
|
-
#
|
|
5158
|
-
#
|
|
5070
|
+
# The CA certificate identifier to use for the DB instance's server
|
|
5071
|
+
# certificate.
|
|
5159
5072
|
#
|
|
5160
|
-
# This setting doesn't apply to RDS Custom.
|
|
5073
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
5161
5074
|
#
|
|
5162
5075
|
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
5163
5076
|
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
@@ -10799,8 +10712,8 @@ module Aws::RDS
|
|
|
10799
10712
|
req.send_request(options)
|
|
10800
10713
|
end
|
|
10801
10714
|
|
|
10802
|
-
#
|
|
10803
|
-
#
|
|
10715
|
+
# Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.
|
|
10716
|
+
# This API supports pagination.
|
|
10804
10717
|
#
|
|
10805
10718
|
# For more information on Amazon Aurora DB clusters, see [ What is
|
|
10806
10719
|
# Amazon Aurora?][1] in the *Amazon Aurora User Guide*.
|
|
@@ -10819,19 +10732,19 @@ module Aws::RDS
|
|
|
10819
10732
|
# @option params [String] :db_cluster_identifier
|
|
10820
10733
|
# The user-supplied DB cluster identifier or the Amazon Resource Name
|
|
10821
10734
|
# (ARN) of the DB cluster. If this parameter is specified, information
|
|
10822
|
-
#
|
|
10735
|
+
# for only the specific DB cluster is returned. This parameter isn't
|
|
10823
10736
|
# case-sensitive.
|
|
10824
10737
|
#
|
|
10825
10738
|
# Constraints:
|
|
10826
10739
|
#
|
|
10827
|
-
# * If supplied, must match an existing
|
|
10740
|
+
# * If supplied, must match an existing DB cluster identifier.
|
|
10828
10741
|
#
|
|
10829
10742
|
# ^
|
|
10830
10743
|
#
|
|
10831
10744
|
# @option params [Array<Types::Filter>] :filters
|
|
10832
10745
|
# A filter that specifies one or more DB clusters to describe.
|
|
10833
10746
|
#
|
|
10834
|
-
# Supported
|
|
10747
|
+
# Supported Filters:
|
|
10835
10748
|
#
|
|
10836
10749
|
# * `clone-group-id` - Accepts clone group identifiers. The results list
|
|
10837
10750
|
# only includes information about the DB clusters associated with
|
|
@@ -10869,9 +10782,8 @@ module Aws::RDS
|
|
|
10869
10782
|
# specified by `MaxRecords`.
|
|
10870
10783
|
#
|
|
10871
10784
|
# @option params [Boolean] :include_shared
|
|
10872
|
-
#
|
|
10873
|
-
#
|
|
10874
|
-
# accounts.
|
|
10785
|
+
# Specifies whether the output includes information about clusters
|
|
10786
|
+
# shared from other Amazon Web Services accounts.
|
|
10875
10787
|
#
|
|
10876
10788
|
# @return [Types::DBClusterMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10877
10789
|
#
|
|
@@ -11564,8 +11476,7 @@ module Aws::RDS
|
|
|
11564
11476
|
req.send_request(options)
|
|
11565
11477
|
end
|
|
11566
11478
|
|
|
11567
|
-
#
|
|
11568
|
-
# pagination.
|
|
11479
|
+
# Describes provisioned RDS instances. This API supports pagination.
|
|
11569
11480
|
#
|
|
11570
11481
|
# <note markdown="1"> This operation can also return information for Amazon Neptune DB
|
|
11571
11482
|
# instances and Amazon DocumentDB instances.
|
|
@@ -11580,14 +11491,14 @@ module Aws::RDS
|
|
|
11580
11491
|
#
|
|
11581
11492
|
# Constraints:
|
|
11582
11493
|
#
|
|
11583
|
-
# * If supplied, must match the identifier of an existing
|
|
11494
|
+
# * If supplied, must match the identifier of an existing DB instance.
|
|
11584
11495
|
#
|
|
11585
11496
|
# ^
|
|
11586
11497
|
#
|
|
11587
11498
|
# @option params [Array<Types::Filter>] :filters
|
|
11588
11499
|
# A filter that specifies one or more DB instances to describe.
|
|
11589
11500
|
#
|
|
11590
|
-
# Supported
|
|
11501
|
+
# Supported Filters:
|
|
11591
11502
|
#
|
|
11592
11503
|
# * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
|
|
11593
11504
|
# Amazon Resource Names (ARNs). The results list only includes
|
|
@@ -11599,7 +11510,7 @@ module Aws::RDS
|
|
|
11599
11510
|
# information about the DB instances identified by these ARNs.
|
|
11600
11511
|
#
|
|
11601
11512
|
# * `dbi-resource-id` - Accepts DB instance resource identifiers. The
|
|
11602
|
-
# results list
|
|
11513
|
+
# results list only includes information about the DB instances
|
|
11603
11514
|
# identified by these DB instance resource identifiers.
|
|
11604
11515
|
#
|
|
11605
11516
|
# * `domain` - Accepts Active Directory directory IDs. The results list
|
|
@@ -16220,7 +16131,7 @@ module Aws::RDS
|
|
|
16220
16131
|
req.send_request(options)
|
|
16221
16132
|
end
|
|
16222
16133
|
|
|
16223
|
-
#
|
|
16134
|
+
# Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB
|
|
16224
16135
|
# cluster. You can change one or more settings by specifying these
|
|
16225
16136
|
# parameters and the new values in the request.
|
|
16226
16137
|
#
|
|
@@ -16239,33 +16150,36 @@ module Aws::RDS
|
|
|
16239
16150
|
# The DB cluster identifier for the cluster being modified. This
|
|
16240
16151
|
# parameter isn't case-sensitive.
|
|
16241
16152
|
#
|
|
16242
|
-
#
|
|
16243
|
-
# DB cluster.
|
|
16153
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16244
16154
|
#
|
|
16245
|
-
#
|
|
16155
|
+
# Constraints:
|
|
16156
|
+
#
|
|
16157
|
+
# * Must match the identifier of an existing DB cluster.
|
|
16158
|
+
#
|
|
16159
|
+
# ^
|
|
16246
16160
|
#
|
|
16247
16161
|
# @option params [String] :new_db_cluster_identifier
|
|
16248
16162
|
# The new DB cluster identifier for the DB cluster when renaming a DB
|
|
16249
16163
|
# cluster. This value is stored as a lowercase string.
|
|
16250
16164
|
#
|
|
16165
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16166
|
+
#
|
|
16251
16167
|
# Constraints:
|
|
16252
16168
|
#
|
|
16253
|
-
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
|
16169
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
16254
16170
|
#
|
|
16255
|
-
# * The first character must be a letter
|
|
16171
|
+
# * The first character must be a letter.
|
|
16256
16172
|
#
|
|
16257
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
|
16173
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
|
16258
16174
|
#
|
|
16259
16175
|
# Example: `my-cluster2`
|
|
16260
16176
|
#
|
|
16261
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16262
|
-
#
|
|
16263
16177
|
# @option params [Boolean] :apply_immediately
|
|
16264
|
-
#
|
|
16265
|
-
#
|
|
16266
|
-
#
|
|
16267
|
-
#
|
|
16268
|
-
#
|
|
16178
|
+
# Specifies whether the modifications in this request and any pending
|
|
16179
|
+
# modifications are asynchronously applied as soon as possible,
|
|
16180
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
|
16181
|
+
# cluster. If this parameter is disabled, changes to the DB cluster are
|
|
16182
|
+
# applied during the next maintenance window.
|
|
16269
16183
|
#
|
|
16270
16184
|
# Most modifications can be applied immediately or during the next
|
|
16271
16185
|
# scheduled maintenance window. Some modifications, such as turning on
|
|
@@ -16274,56 +16188,57 @@ module Aws::RDS
|
|
|
16274
16188
|
#
|
|
16275
16189
|
# By default, this parameter is disabled.
|
|
16276
16190
|
#
|
|
16277
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16191
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16278
16192
|
#
|
|
16279
16193
|
# @option params [Integer] :backup_retention_period
|
|
16280
16194
|
# The number of days for which automated backups are retained. Specify a
|
|
16281
|
-
# minimum value of 1
|
|
16195
|
+
# minimum value of `1`.
|
|
16282
16196
|
#
|
|
16283
|
-
#
|
|
16197
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16198
|
+
#
|
|
16199
|
+
# Default: `1`
|
|
16284
16200
|
#
|
|
16285
16201
|
# Constraints:
|
|
16286
16202
|
#
|
|
16287
|
-
# * Must be a value from 1 to 35
|
|
16203
|
+
# * Must be a value from 1 to 35.
|
|
16288
16204
|
#
|
|
16289
16205
|
# ^
|
|
16290
16206
|
#
|
|
16291
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16292
|
-
#
|
|
16293
16207
|
# @option params [String] :db_cluster_parameter_group_name
|
|
16294
16208
|
# The name of the DB cluster parameter group to use for the DB cluster.
|
|
16295
16209
|
#
|
|
16296
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16210
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16297
16211
|
#
|
|
16298
16212
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
16299
|
-
# A list of VPC security groups
|
|
16213
|
+
# A list of EC2 VPC security groups to associate with this DB cluster.
|
|
16300
16214
|
#
|
|
16301
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16215
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16302
16216
|
#
|
|
16303
16217
|
# @option params [Integer] :port
|
|
16304
16218
|
# The port number on which the DB cluster accepts connections.
|
|
16305
16219
|
#
|
|
16306
|
-
#
|
|
16220
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16307
16221
|
#
|
|
16308
|
-
#
|
|
16222
|
+
# Valid Values: `1150-65535`
|
|
16309
16223
|
#
|
|
16310
|
-
#
|
|
16224
|
+
# Default: The same port as the original DB cluster.
|
|
16311
16225
|
#
|
|
16312
16226
|
# @option params [String] :master_user_password
|
|
16313
|
-
# The new password for the master database user.
|
|
16314
|
-
#
|
|
16227
|
+
# The new password for the master database user.
|
|
16228
|
+
#
|
|
16229
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16315
16230
|
#
|
|
16316
16231
|
# Constraints:
|
|
16317
16232
|
#
|
|
16318
16233
|
# * Must contain from 8 to 41 characters.
|
|
16319
16234
|
#
|
|
16320
|
-
# * Can
|
|
16235
|
+
# * Can contain any printable ASCII character except "/", """, or
|
|
16236
|
+
# "@".
|
|
16321
16237
|
#
|
|
16322
|
-
#
|
|
16238
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
|
16323
16239
|
#
|
|
16324
16240
|
# @option params [String] :option_group_name
|
|
16325
|
-
#
|
|
16326
|
-
# the specified option group.
|
|
16241
|
+
# The option group to associate the DB cluster with.
|
|
16327
16242
|
#
|
|
16328
16243
|
# DB clusters are associated with a default option group that can't be
|
|
16329
16244
|
# modified.
|
|
@@ -16338,6 +16253,8 @@ module Aws::RDS
|
|
|
16338
16253
|
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
|
16339
16254
|
# Guide*.
|
|
16340
16255
|
#
|
|
16256
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16257
|
+
#
|
|
16341
16258
|
# Constraints:
|
|
16342
16259
|
#
|
|
16343
16260
|
# * Must be in the format `hh24:mi-hh24:mi`.
|
|
@@ -16348,8 +16265,6 @@ module Aws::RDS
|
|
|
16348
16265
|
#
|
|
16349
16266
|
# * Must be at least 30 minutes.
|
|
16350
16267
|
#
|
|
16351
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16352
|
-
#
|
|
16353
16268
|
#
|
|
16354
16269
|
#
|
|
16355
16270
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
|
@@ -16358,7 +16273,7 @@ module Aws::RDS
|
|
|
16358
16273
|
# The weekly time range during which system maintenance can occur, in
|
|
16359
16274
|
# Universal Coordinated Time (UTC).
|
|
16360
16275
|
#
|
|
16361
|
-
#
|
|
16276
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16362
16277
|
#
|
|
16363
16278
|
# The default is a 30-minute window selected at random from an 8-hour
|
|
16364
16279
|
# block of time for each Amazon Web Services Region, occurring on a
|
|
@@ -16366,25 +16281,29 @@ module Aws::RDS
|
|
|
16366
16281
|
# Adjusting the Preferred DB Cluster Maintenance Window][1] in the
|
|
16367
16282
|
# *Amazon Aurora User Guide*.
|
|
16368
16283
|
#
|
|
16369
|
-
#
|
|
16284
|
+
# Constraints:
|
|
16370
16285
|
#
|
|
16371
|
-
#
|
|
16286
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
|
16372
16287
|
#
|
|
16373
|
-
#
|
|
16288
|
+
# * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
|
|
16289
|
+
#
|
|
16290
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
16291
|
+
#
|
|
16292
|
+
# * Must be at least 30 minutes.
|
|
16374
16293
|
#
|
|
16375
16294
|
#
|
|
16376
16295
|
#
|
|
16377
16296
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
|
16378
16297
|
#
|
|
16379
16298
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
16380
|
-
#
|
|
16381
|
-
#
|
|
16382
|
-
#
|
|
16299
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
|
16300
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
|
16301
|
+
# mapping isn't enabled.
|
|
16383
16302
|
#
|
|
16384
16303
|
# For more information, see [ IAM Database Authentication][1] in the
|
|
16385
16304
|
# *Amazon Aurora User Guide*.
|
|
16386
16305
|
#
|
|
16387
|
-
# Valid for: Aurora DB clusters only
|
|
16306
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16388
16307
|
#
|
|
16389
16308
|
#
|
|
16390
16309
|
#
|
|
@@ -16392,9 +16311,11 @@ module Aws::RDS
|
|
|
16392
16311
|
#
|
|
16393
16312
|
# @option params [Integer] :backtrack_window
|
|
16394
16313
|
# The target backtrack window, in seconds. To disable backtracking, set
|
|
16395
|
-
# this value to 0
|
|
16314
|
+
# this value to `0`.
|
|
16396
16315
|
#
|
|
16397
|
-
#
|
|
16316
|
+
# Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
16317
|
+
#
|
|
16318
|
+
# Default: `0`
|
|
16398
16319
|
#
|
|
16399
16320
|
# Constraints:
|
|
16400
16321
|
#
|
|
@@ -16403,28 +16324,21 @@ module Aws::RDS
|
|
|
16403
16324
|
#
|
|
16404
16325
|
# ^
|
|
16405
16326
|
#
|
|
16406
|
-
# Valid for: Aurora MySQL DB clusters only
|
|
16407
|
-
#
|
|
16408
16327
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
|
16409
16328
|
# The configuration setting for the log types to be enabled for export
|
|
16410
|
-
# to CloudWatch Logs for a specific DB cluster.
|
|
16411
|
-
# depend on the DB engine being used.
|
|
16412
|
-
#
|
|
16413
|
-
# **RDS for MySQL**
|
|
16414
|
-
#
|
|
16415
|
-
# Possible values are `error`, `general`, and `slowquery`.
|
|
16329
|
+
# to CloudWatch Logs for a specific DB cluster.
|
|
16416
16330
|
#
|
|
16417
|
-
#
|
|
16331
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16418
16332
|
#
|
|
16419
|
-
#
|
|
16333
|
+
# The following values are valid for each DB engine:
|
|
16420
16334
|
#
|
|
16421
|
-
#
|
|
16335
|
+
# * Aurora MySQL - `audit | error | general | slowquery`
|
|
16422
16336
|
#
|
|
16423
|
-
#
|
|
16337
|
+
# * Aurora PostgreSQL - `postgresql`
|
|
16424
16338
|
#
|
|
16425
|
-
#
|
|
16339
|
+
# * RDS for MySQL - `error | general | slowquery`
|
|
16426
16340
|
#
|
|
16427
|
-
#
|
|
16341
|
+
# * RDS for PostgreSQL - `postgresql | upgrade`
|
|
16428
16342
|
#
|
|
16429
16343
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
|
16430
16344
|
# see [ Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
|
@@ -16434,8 +16348,6 @@ module Aws::RDS
|
|
|
16434
16348
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
|
16435
16349
|
# the *Amazon Aurora User Guide*.
|
|
16436
16350
|
#
|
|
16437
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16438
|
-
#
|
|
16439
16351
|
#
|
|
16440
16352
|
#
|
|
16441
16353
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
|
@@ -16475,16 +16387,20 @@ module Aws::RDS
|
|
|
16475
16387
|
# `aws rds describe-db-engine-versions --engine postgres --query
|
|
16476
16388
|
# "DBEngineVersions[].EngineVersion"`
|
|
16477
16389
|
#
|
|
16478
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16390
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16479
16391
|
#
|
|
16480
16392
|
# @option params [Boolean] :allow_major_version_upgrade
|
|
16481
|
-
#
|
|
16393
|
+
# Specifies whether major version upgrades are allowed.
|
|
16482
16394
|
#
|
|
16483
|
-
#
|
|
16484
|
-
# value for the `EngineVersion` parameter that is a different major
|
|
16485
|
-
# version than the DB cluster's current version.
|
|
16395
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16486
16396
|
#
|
|
16487
|
-
#
|
|
16397
|
+
# Constraints:
|
|
16398
|
+
#
|
|
16399
|
+
# * You must allow major version upgrades when specifying a value for
|
|
16400
|
+
# the `EngineVersion` parameter that is a different major version than
|
|
16401
|
+
# the DB cluster's current version.
|
|
16402
|
+
#
|
|
16403
|
+
# ^
|
|
16488
16404
|
#
|
|
16489
16405
|
# @option params [String] :db_instance_parameter_group_name
|
|
16490
16406
|
# The name of the DB parameter group to apply to all instances of the DB
|
|
@@ -16497,6 +16413,8 @@ module Aws::RDS
|
|
|
16497
16413
|
#
|
|
16498
16414
|
# </note>
|
|
16499
16415
|
#
|
|
16416
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16417
|
+
#
|
|
16500
16418
|
# Default: The existing name setting
|
|
16501
16419
|
#
|
|
16502
16420
|
# Constraints:
|
|
@@ -16508,8 +16426,6 @@ module Aws::RDS
|
|
|
16508
16426
|
# with the `AllowMajorVersionUpgrade` parameter for a major version
|
|
16509
16427
|
# upgrade only.
|
|
16510
16428
|
#
|
|
16511
|
-
# Valid for: Aurora DB clusters only
|
|
16512
|
-
#
|
|
16513
16429
|
# @option params [String] :domain
|
|
16514
16430
|
# The Active Directory directory ID to move the DB cluster to. Specify
|
|
16515
16431
|
# `none` to remove the cluster from its current domain. The domain must
|
|
@@ -16518,35 +16434,34 @@ module Aws::RDS
|
|
|
16518
16434
|
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
|
16519
16435
|
# Aurora User Guide*.
|
|
16520
16436
|
#
|
|
16521
|
-
# Valid for: Aurora DB clusters only
|
|
16437
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16522
16438
|
#
|
|
16523
16439
|
#
|
|
16524
16440
|
#
|
|
16525
16441
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
16526
16442
|
#
|
|
16527
16443
|
# @option params [String] :domain_iam_role_name
|
|
16528
|
-
#
|
|
16529
|
-
#
|
|
16444
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
16445
|
+
# Service.
|
|
16530
16446
|
#
|
|
16531
|
-
# Valid for: Aurora DB clusters only
|
|
16447
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16532
16448
|
#
|
|
16533
16449
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
|
16534
16450
|
# The scaling properties of the DB cluster. You can only modify scaling
|
|
16535
16451
|
# properties for DB clusters in `serverless` DB engine mode.
|
|
16536
16452
|
#
|
|
16537
|
-
# Valid for: Aurora DB clusters only
|
|
16453
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16538
16454
|
#
|
|
16539
16455
|
# @option params [Boolean] :deletion_protection
|
|
16540
|
-
#
|
|
16541
|
-
#
|
|
16542
|
-
#
|
|
16456
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
16457
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
16458
|
+
# default, deletion protection isn't enabled.
|
|
16543
16459
|
#
|
|
16544
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16460
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16545
16461
|
#
|
|
16546
16462
|
# @option params [Boolean] :enable_http_endpoint
|
|
16547
|
-
#
|
|
16548
|
-
#
|
|
16549
|
-
# disabled.
|
|
16463
|
+
# Specifies whether to enable the HTTP endpoint for an Aurora Serverless
|
|
16464
|
+
# v1 DB cluster. By default, the HTTP endpoint is disabled.
|
|
16550
16465
|
#
|
|
16551
16466
|
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
16552
16467
|
# API for running SQL queries on the Aurora Serverless v1 DB cluster.
|
|
@@ -16556,45 +16471,44 @@ module Aws::RDS
|
|
|
16556
16471
|
# For more information, see [Using the Data API for Aurora Serverless
|
|
16557
16472
|
# v1][1] in the *Amazon Aurora User Guide*.
|
|
16558
16473
|
#
|
|
16559
|
-
# Valid for: Aurora DB clusters only
|
|
16474
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16560
16475
|
#
|
|
16561
16476
|
#
|
|
16562
16477
|
#
|
|
16563
16478
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
16564
16479
|
#
|
|
16565
16480
|
# @option params [Boolean] :copy_tags_to_snapshot
|
|
16566
|
-
#
|
|
16567
|
-
#
|
|
16481
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
16482
|
+
# the DB cluster. The default is not to copy them.
|
|
16568
16483
|
#
|
|
16569
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16484
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16570
16485
|
#
|
|
16571
16486
|
# @option params [Boolean] :enable_global_write_forwarding
|
|
16572
|
-
#
|
|
16573
|
-
#
|
|
16574
|
-
#
|
|
16575
|
-
#
|
|
16576
|
-
# database.
|
|
16487
|
+
# Specifies whether to enable this DB cluster to forward write
|
|
16488
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
|
16489
|
+
# database). By default, write operations are not allowed on Aurora DB
|
|
16490
|
+
# clusters that are secondary clusters in an Aurora global database.
|
|
16577
16491
|
#
|
|
16578
16492
|
# You can set this value only on Aurora DB clusters that are members of
|
|
16579
16493
|
# an Aurora global database. With this parameter enabled, a secondary
|
|
16580
|
-
# cluster can forward writes to the current primary cluster and the
|
|
16494
|
+
# cluster can forward writes to the current primary cluster, and the
|
|
16581
16495
|
# resulting changes are replicated back to this cluster. For the primary
|
|
16582
16496
|
# DB cluster of an Aurora global database, this value is used
|
|
16583
|
-
# immediately if the primary is demoted by
|
|
16497
|
+
# immediately if the primary is demoted by a global cluster API
|
|
16584
16498
|
# operation, but it does nothing until then.
|
|
16585
16499
|
#
|
|
16586
|
-
# Valid for: Aurora DB clusters only
|
|
16500
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16587
16501
|
#
|
|
16588
16502
|
# @option params [String] :db_cluster_instance_class
|
|
16589
16503
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
|
16590
|
-
# cluster, for example db.m6gd.xlarge
|
|
16504
|
+
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
|
16591
16505
|
# available in all Amazon Web Services Regions, or for all database
|
|
16592
16506
|
# engines.
|
|
16593
16507
|
#
|
|
16594
16508
|
# For the full list of DB instance classes and availability for your
|
|
16595
16509
|
# engine, see [ DB Instance Class][1] in the *Amazon RDS User Guide*.
|
|
16596
16510
|
#
|
|
16597
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16511
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16598
16512
|
#
|
|
16599
16513
|
#
|
|
16600
16514
|
#
|
|
@@ -16604,20 +16518,37 @@ module Aws::RDS
|
|
|
16604
16518
|
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
|
16605
16519
|
# instance in the Multi-AZ DB cluster.
|
|
16606
16520
|
#
|
|
16607
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16521
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16608
16522
|
#
|
|
16609
16523
|
# @option params [String] :storage_type
|
|
16610
|
-
#
|
|
16524
|
+
# The storage type to associate with the DB cluster.
|
|
16525
|
+
#
|
|
16526
|
+
# For information on storage types for Aurora DB clusters, see [Storage
|
|
16527
|
+
# configurations for Amazon Aurora DB clusters][1]. For information on
|
|
16528
|
+
# storage types for Multi-AZ DB clusters, see [Settings for creating
|
|
16529
|
+
# Multi-AZ DB clusters][2].
|
|
16611
16530
|
#
|
|
16612
16531
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
|
16613
16532
|
# parameter is required.
|
|
16614
16533
|
#
|
|
16615
|
-
# Valid
|
|
16616
|
-
#
|
|
16534
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16535
|
+
#
|
|
16536
|
+
# Valid Values:
|
|
16537
|
+
#
|
|
16538
|
+
# * Aurora DB clusters - `aurora | aurora-iopt1`
|
|
16539
|
+
#
|
|
16540
|
+
# * Multi-AZ DB clusters - `io1`
|
|
16541
|
+
#
|
|
16542
|
+
# Default:
|
|
16543
|
+
#
|
|
16544
|
+
# * Aurora DB clusters - `aurora`
|
|
16545
|
+
#
|
|
16546
|
+
# * Multi-AZ DB clusters - `io1`
|
|
16547
|
+
#
|
|
16617
16548
|
#
|
|
16618
|
-
# Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
|
|
16619
16549
|
#
|
|
16620
|
-
#
|
|
16550
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type
|
|
16551
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings
|
|
16621
16552
|
#
|
|
16622
16553
|
# @option params [Integer] :iops
|
|
16623
16554
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
|
@@ -16627,33 +16558,39 @@ module Aws::RDS
|
|
|
16627
16558
|
# For information about valid IOPS values, see [Amazon RDS Provisioned
|
|
16628
16559
|
# IOPS storage][1] in the *Amazon RDS User Guide*.
|
|
16629
16560
|
#
|
|
16630
|
-
#
|
|
16631
|
-
# amount for the DB cluster.
|
|
16561
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16632
16562
|
#
|
|
16633
|
-
#
|
|
16563
|
+
# Constraints:
|
|
16564
|
+
#
|
|
16565
|
+
# * Must be a multiple between .5 and 50 of the storage amount for the
|
|
16566
|
+
# DB cluster.
|
|
16567
|
+
#
|
|
16568
|
+
# ^
|
|
16634
16569
|
#
|
|
16635
16570
|
#
|
|
16636
16571
|
#
|
|
16637
16572
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
|
16638
16573
|
#
|
|
16639
16574
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
16640
|
-
#
|
|
16641
|
-
#
|
|
16642
|
-
#
|
|
16575
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
|
16576
|
+
# the DB cluster during the maintenance window. By default, minor engine
|
|
16577
|
+
# upgrades are applied automatically.
|
|
16643
16578
|
#
|
|
16644
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16579
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16645
16580
|
#
|
|
16646
16581
|
# @option params [Integer] :monitoring_interval
|
|
16647
16582
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
16648
16583
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
16649
|
-
# Enhanced Monitoring metrics, specify 0
|
|
16584
|
+
# Enhanced Monitoring metrics, specify `0`.
|
|
16650
16585
|
#
|
|
16651
16586
|
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
|
16652
|
-
# a value other than 0
|
|
16587
|
+
# a value other than `0`.
|
|
16653
16588
|
#
|
|
16654
|
-
# Valid
|
|
16589
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16655
16590
|
#
|
|
16656
|
-
# Valid
|
|
16591
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
|
16592
|
+
#
|
|
16593
|
+
# Default: `0`
|
|
16657
16594
|
#
|
|
16658
16595
|
# @option params [String] :monitoring_role_arn
|
|
16659
16596
|
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
|
@@ -16662,23 +16599,22 @@ module Aws::RDS
|
|
|
16662
16599
|
# creating a monitoring role, see [To create an IAM role for Amazon RDS
|
|
16663
16600
|
# Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
|
16664
16601
|
#
|
|
16665
|
-
# If `MonitoringInterval` is set to a value other than 0
|
|
16602
|
+
# If `MonitoringInterval` is set to a value other than `0`, supply a
|
|
16666
16603
|
# `MonitoringRoleArn` value.
|
|
16667
16604
|
#
|
|
16668
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16605
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16669
16606
|
#
|
|
16670
16607
|
#
|
|
16671
16608
|
#
|
|
16672
16609
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
|
16673
16610
|
#
|
|
16674
16611
|
# @option params [Boolean] :enable_performance_insights
|
|
16675
|
-
#
|
|
16676
|
-
# DB cluster.
|
|
16612
|
+
# Specifies whether to turn on Performance Insights for the DB cluster.
|
|
16677
16613
|
#
|
|
16678
16614
|
# For more information, see [ Using Amazon Performance Insights][1] in
|
|
16679
16615
|
# the *Amazon RDS User Guide*.
|
|
16680
16616
|
#
|
|
16681
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16617
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16682
16618
|
#
|
|
16683
16619
|
#
|
|
16684
16620
|
#
|
|
@@ -16696,32 +16632,27 @@ module Aws::RDS
|
|
|
16696
16632
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
|
16697
16633
|
# a different default KMS key for each Amazon Web Services Region.
|
|
16698
16634
|
#
|
|
16699
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16635
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16700
16636
|
#
|
|
16701
16637
|
# @option params [Integer] :performance_insights_retention_period
|
|
16702
|
-
# The number of days to retain Performance Insights data.
|
|
16703
|
-
# 7 days. The following values are valid:
|
|
16704
|
-
#
|
|
16705
|
-
# * 7
|
|
16638
|
+
# The number of days to retain Performance Insights data.
|
|
16706
16639
|
#
|
|
16707
|
-
#
|
|
16708
|
-
#
|
|
16709
|
-
# * 731
|
|
16710
|
-
#
|
|
16711
|
-
# For example, the following values are valid:
|
|
16640
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16712
16641
|
#
|
|
16713
|
-
#
|
|
16642
|
+
# Valid Values:
|
|
16714
16643
|
#
|
|
16715
|
-
# *
|
|
16644
|
+
# * `7`
|
|
16716
16645
|
#
|
|
16717
|
-
# *
|
|
16646
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
|
16647
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
|
16648
|
+
# months * 31)
|
|
16718
16649
|
#
|
|
16719
|
-
# * 731
|
|
16650
|
+
# * `731`
|
|
16720
16651
|
#
|
|
16721
|
-
#
|
|
16722
|
-
# value, RDS issues an error.
|
|
16652
|
+
# Default: `7` days
|
|
16723
16653
|
#
|
|
16724
|
-
#
|
|
16654
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
|
16655
|
+
# Amazon RDS issues an error.
|
|
16725
16656
|
#
|
|
16726
16657
|
# @option params [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
16727
16658
|
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
@@ -16737,12 +16668,6 @@ module Aws::RDS
|
|
|
16737
16668
|
# @option params [String] :network_type
|
|
16738
16669
|
# The network type of the DB cluster.
|
|
16739
16670
|
#
|
|
16740
|
-
# Valid values:
|
|
16741
|
-
#
|
|
16742
|
-
# * `IPV4`
|
|
16743
|
-
#
|
|
16744
|
-
# * `DUAL`
|
|
16745
|
-
#
|
|
16746
16671
|
# The network type is determined by the `DBSubnetGroup` specified for
|
|
16747
16672
|
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
16748
16673
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
@@ -16750,15 +16675,17 @@ module Aws::RDS
|
|
|
16750
16675
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
16751
16676
|
# the *Amazon Aurora User Guide.*
|
|
16752
16677
|
#
|
|
16753
|
-
# Valid for: Aurora DB clusters only
|
|
16678
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16679
|
+
#
|
|
16680
|
+
# Valid Values: `IPV4 | DUAL`
|
|
16754
16681
|
#
|
|
16755
16682
|
#
|
|
16756
16683
|
#
|
|
16757
16684
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
16758
16685
|
#
|
|
16759
16686
|
# @option params [Boolean] :manage_master_user_password
|
|
16760
|
-
#
|
|
16761
|
-
#
|
|
16687
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
16688
|
+
# Services Secrets Manager.
|
|
16762
16689
|
#
|
|
16763
16690
|
# If the DB cluster doesn't manage the master user password with Amazon
|
|
16764
16691
|
# Web Services Secrets Manager, you can turn on this management. In this
|
|
@@ -16776,7 +16703,7 @@ module Aws::RDS
|
|
|
16776
16703
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
|
16777
16704
|
# the *Amazon Aurora User Guide.*
|
|
16778
16705
|
#
|
|
16779
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16706
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16780
16707
|
#
|
|
16781
16708
|
#
|
|
16782
16709
|
#
|
|
@@ -16784,8 +16711,8 @@ module Aws::RDS
|
|
|
16784
16711
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
|
16785
16712
|
#
|
|
16786
16713
|
# @option params [Boolean] :rotate_master_user_password
|
|
16787
|
-
#
|
|
16788
|
-
#
|
|
16714
|
+
# Specifies whether to rotate the secret managed by Amazon Web Services
|
|
16715
|
+
# Secrets Manager for the master user password.
|
|
16789
16716
|
#
|
|
16790
16717
|
# This setting is valid only if the master user password is managed by
|
|
16791
16718
|
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
|
@@ -16796,6 +16723,8 @@ module Aws::RDS
|
|
|
16796
16723
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
|
16797
16724
|
# the *Amazon Aurora User Guide.*
|
|
16798
16725
|
#
|
|
16726
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16727
|
+
#
|
|
16799
16728
|
# Constraints:
|
|
16800
16729
|
#
|
|
16801
16730
|
# * You must apply the change immediately when rotating the master user
|
|
@@ -16803,8 +16732,6 @@ module Aws::RDS
|
|
|
16803
16732
|
#
|
|
16804
16733
|
# ^
|
|
16805
16734
|
#
|
|
16806
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16807
|
-
#
|
|
16808
16735
|
#
|
|
16809
16736
|
#
|
|
16810
16737
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
@@ -16844,7 +16771,7 @@ module Aws::RDS
|
|
|
16844
16771
|
# Amazon Web Services account has a different default KMS key for each
|
|
16845
16772
|
# Amazon Web Services Region.
|
|
16846
16773
|
#
|
|
16847
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16774
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16848
16775
|
#
|
|
16849
16776
|
# @option params [String] :engine_mode
|
|
16850
16777
|
# The DB engine mode of the DB cluster, either `provisioned` or
|
|
@@ -16857,21 +16784,25 @@ module Aws::RDS
|
|
|
16857
16784
|
#
|
|
16858
16785
|
# For more information, see [ CreateDBCluster][1].
|
|
16859
16786
|
#
|
|
16860
|
-
# Valid for: Aurora DB clusters only
|
|
16787
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16861
16788
|
#
|
|
16862
16789
|
#
|
|
16863
16790
|
#
|
|
16864
16791
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
|
|
16865
16792
|
#
|
|
16866
16793
|
# @option params [Boolean] :allow_engine_mode_change
|
|
16867
|
-
#
|
|
16868
|
-
#
|
|
16794
|
+
# Specifies whether engine mode changes from `serverless` to
|
|
16795
|
+
# `provisioned` are allowed.
|
|
16796
|
+
#
|
|
16797
|
+
# Valid for Cluster Type: Aurora Serverless v1 DB clusters only
|
|
16798
|
+
#
|
|
16799
|
+
# Constraints:
|
|
16869
16800
|
#
|
|
16870
|
-
#
|
|
16871
|
-
#
|
|
16872
|
-
#
|
|
16801
|
+
# * You must allow engine mode changes when specifying a different value
|
|
16802
|
+
# for the `EngineMode` parameter from the DB cluster's current engine
|
|
16803
|
+
# mode.
|
|
16873
16804
|
#
|
|
16874
|
-
#
|
|
16805
|
+
# ^
|
|
16875
16806
|
#
|
|
16876
16807
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
16877
16808
|
#
|
|
@@ -17489,12 +17420,12 @@ module Aws::RDS
|
|
|
17489
17420
|
# before you call `ModifyDBInstance`.
|
|
17490
17421
|
#
|
|
17491
17422
|
# @option params [required, String] :db_instance_identifier
|
|
17492
|
-
# The DB instance
|
|
17493
|
-
# string.
|
|
17423
|
+
# The identifier of DB instance to modify. This value is stored as a
|
|
17424
|
+
# lowercase string.
|
|
17494
17425
|
#
|
|
17495
17426
|
# Constraints:
|
|
17496
17427
|
#
|
|
17497
|
-
# * Must match the identifier of an existing
|
|
17428
|
+
# * Must match the identifier of an existing DB instance.
|
|
17498
17429
|
#
|
|
17499
17430
|
# ^
|
|
17500
17431
|
#
|
|
@@ -17502,17 +17433,18 @@ module Aws::RDS
|
|
|
17502
17433
|
# The new amount of storage in gibibytes (GiB) to allocate for the DB
|
|
17503
17434
|
# instance.
|
|
17504
17435
|
#
|
|
17505
|
-
# For MariaDB, MySQL, Oracle, and
|
|
17506
|
-
# at least 10% greater than the
|
|
17507
|
-
#
|
|
17508
|
-
# are 10% greater than the
|
|
17436
|
+
# For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
|
|
17437
|
+
# PostgreSQL, the value supplied must be at least 10% greater than the
|
|
17438
|
+
# current value. Values that are not at least 10% greater than the
|
|
17439
|
+
# existing value are rounded up so that they are 10% greater than the
|
|
17440
|
+
# current value.
|
|
17509
17441
|
#
|
|
17510
17442
|
# For the valid values for allocated storage for each engine, see
|
|
17511
17443
|
# `CreateDBInstance`.
|
|
17512
17444
|
#
|
|
17513
17445
|
# @option params [String] :db_instance_class
|
|
17514
17446
|
# The new compute and memory capacity of the DB instance, for example
|
|
17515
|
-
# db.m4.large
|
|
17447
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
|
17516
17448
|
# Web Services Regions, or for all database engines. For the full list
|
|
17517
17449
|
# of DB instance classes, and availability for your engine, see [DB
|
|
17518
17450
|
# Instance Class][1] in the *Amazon RDS User Guide* or [Aurora DB
|
|
@@ -17544,10 +17476,13 @@ module Aws::RDS
|
|
|
17544
17476
|
# change is applied during the next maintenance window, unless you
|
|
17545
17477
|
# enable `ApplyImmediately`.
|
|
17546
17478
|
#
|
|
17547
|
-
# This parameter doesn't apply to RDS Custom.
|
|
17479
|
+
# This parameter doesn't apply to RDS Custom DB instances.
|
|
17548
17480
|
#
|
|
17549
|
-
# Constraints:
|
|
17550
|
-
#
|
|
17481
|
+
# Constraints:
|
|
17482
|
+
#
|
|
17483
|
+
# * If supplied, must match existing DB subnet group.
|
|
17484
|
+
#
|
|
17485
|
+
# ^
|
|
17551
17486
|
#
|
|
17552
17487
|
# Example: `mydbsubnetgroup`
|
|
17553
17488
|
#
|
|
@@ -17560,37 +17495,37 @@ module Aws::RDS
|
|
|
17560
17495
|
# Changing this setting doesn't result in an outage and the change is
|
|
17561
17496
|
# asynchronously applied as soon as possible.
|
|
17562
17497
|
#
|
|
17563
|
-
# This setting doesn't apply to RDS Custom.
|
|
17498
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17564
17499
|
#
|
|
17565
17500
|
# Constraints:
|
|
17566
17501
|
#
|
|
17567
|
-
# * If supplied, must match existing
|
|
17502
|
+
# * If supplied, must match existing DB security groups.
|
|
17568
17503
|
#
|
|
17569
17504
|
# ^
|
|
17570
17505
|
#
|
|
17571
17506
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
17572
|
-
# A list of Amazon EC2 VPC security groups to
|
|
17507
|
+
# A list of Amazon EC2 VPC security groups to associate with this DB
|
|
17573
17508
|
# instance. This change is asynchronously applied as soon as possible.
|
|
17574
17509
|
#
|
|
17575
|
-
# This setting doesn't apply to
|
|
17510
|
+
# This setting doesn't apply to the following DB instances:
|
|
17576
17511
|
#
|
|
17577
|
-
#
|
|
17512
|
+
# * Amazon Aurora (The associated list of EC2 VPC security groups is
|
|
17513
|
+
# managed by the DB cluster. For more information, see
|
|
17514
|
+
# `ModifyDBCluster`.)
|
|
17578
17515
|
#
|
|
17579
|
-
#
|
|
17580
|
-
# managed by the DB cluster. For more information, see
|
|
17581
|
-
# `ModifyDBCluster`.
|
|
17516
|
+
# * RDS Custom
|
|
17582
17517
|
#
|
|
17583
17518
|
# Constraints:
|
|
17584
17519
|
#
|
|
17585
|
-
# * If supplied, must match existing
|
|
17520
|
+
# * If supplied, must match existing VPC security group IDs.
|
|
17586
17521
|
#
|
|
17587
17522
|
# ^
|
|
17588
17523
|
#
|
|
17589
17524
|
# @option params [Boolean] :apply_immediately
|
|
17590
|
-
#
|
|
17591
|
-
#
|
|
17592
|
-
#
|
|
17593
|
-
#
|
|
17525
|
+
# Specifies whether the modifications in this request and any pending
|
|
17526
|
+
# modifications are asynchronously applied as soon as possible,
|
|
17527
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
|
17528
|
+
# instance. By default, this parameter is disabled.
|
|
17594
17529
|
#
|
|
17595
17530
|
# If this parameter is disabled, changes to the DB instance are applied
|
|
17596
17531
|
# during the next maintenance window. Some parameter changes can cause
|
|
@@ -17605,8 +17540,7 @@ module Aws::RDS
|
|
|
17605
17540
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html
|
|
17606
17541
|
#
|
|
17607
17542
|
# @option params [String] :master_user_password
|
|
17608
|
-
# The new password for the master user.
|
|
17609
|
-
# printable ASCII character except "/", """, or "@".
|
|
17543
|
+
# The new password for the master user.
|
|
17610
17544
|
#
|
|
17611
17545
|
# Changing this parameter doesn't result in an outage and the change is
|
|
17612
17546
|
# asynchronously applied as soon as possible. Between the time of the
|
|
@@ -17614,44 +17548,41 @@ module Aws::RDS
|
|
|
17614
17548
|
# element exists in the `PendingModifiedValues` element of the operation
|
|
17615
17549
|
# response.
|
|
17616
17550
|
#
|
|
17617
|
-
#
|
|
17618
|
-
#
|
|
17619
|
-
#
|
|
17620
|
-
#
|
|
17621
|
-
# Not applicable. The password for the master user is managed by the DB
|
|
17622
|
-
# cluster. For more information, see `ModifyDBCluster`.
|
|
17551
|
+
# <note markdown="1"> Amazon RDS API operations never return the password, so this action
|
|
17552
|
+
# provides a way to regain access to a primary instance user if the
|
|
17553
|
+
# password is lost. This includes restoring privileges that might have
|
|
17554
|
+
# been accidentally revoked.
|
|
17623
17555
|
#
|
|
17624
|
-
#
|
|
17556
|
+
# </note>
|
|
17625
17557
|
#
|
|
17626
|
-
#
|
|
17627
|
-
# turned on.
|
|
17558
|
+
# This setting doesn't apply to the following DB instances:
|
|
17628
17559
|
#
|
|
17629
|
-
#
|
|
17560
|
+
# * Amazon Aurora (The password for the master user is managed by the DB
|
|
17561
|
+
# cluster. For more information, see `ModifyDBCluster`.)
|
|
17630
17562
|
#
|
|
17631
|
-
#
|
|
17563
|
+
# * RDS Custom
|
|
17632
17564
|
#
|
|
17633
|
-
#
|
|
17565
|
+
# Default: Uses existing setting
|
|
17634
17566
|
#
|
|
17635
|
-
# Constraints:
|
|
17567
|
+
# Constraints:
|
|
17636
17568
|
#
|
|
17637
|
-
#
|
|
17569
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
|
17638
17570
|
#
|
|
17639
|
-
#
|
|
17571
|
+
# * Can include any printable ASCII character except "/", """, or
|
|
17572
|
+
# "@".
|
|
17640
17573
|
#
|
|
17641
|
-
#
|
|
17574
|
+
# Length Constraints:
|
|
17642
17575
|
#
|
|
17643
|
-
#
|
|
17576
|
+
# * RDS for MariaDB - Must contain from 8 to 41 characters.
|
|
17644
17577
|
#
|
|
17645
|
-
#
|
|
17578
|
+
# * RDS for Microsoft SQL Server - Must contain from 8 to 128
|
|
17579
|
+
# characters.
|
|
17646
17580
|
#
|
|
17647
|
-
#
|
|
17581
|
+
# * RDS for MySQL - Must contain from 8 to 41 characters.
|
|
17648
17582
|
#
|
|
17649
|
-
#
|
|
17650
|
-
# provides a way to regain access to a primary instance user if the
|
|
17651
|
-
# password is lost. This includes restoring privileges that might have
|
|
17652
|
-
# been accidentally revoked.
|
|
17583
|
+
# * RDS for Oracle - Must contain from 8 to 30 characters.
|
|
17653
17584
|
#
|
|
17654
|
-
#
|
|
17585
|
+
# * RDS for PostgreSQL - Must contain from 8 to 128 characters.
|
|
17655
17586
|
#
|
|
17656
17587
|
# @option params [String] :db_parameter_group_name
|
|
17657
17588
|
# The name of the DB parameter group to apply to the DB instance.
|
|
@@ -17665,12 +17596,15 @@ module Aws::RDS
|
|
|
17665
17596
|
# associated DB parameter group, these changes are applied immediately
|
|
17666
17597
|
# without a reboot.
|
|
17667
17598
|
#
|
|
17668
|
-
# This setting doesn't apply to RDS Custom.
|
|
17599
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17669
17600
|
#
|
|
17670
17601
|
# Default: Uses existing setting
|
|
17671
17602
|
#
|
|
17672
|
-
# Constraints:
|
|
17673
|
-
#
|
|
17603
|
+
# Constraints:
|
|
17604
|
+
#
|
|
17605
|
+
# * Must be in the same DB parameter group family as the DB instance.
|
|
17606
|
+
#
|
|
17607
|
+
# ^
|
|
17674
17608
|
#
|
|
17675
17609
|
# @option params [Integer] :backup_retention_period
|
|
17676
17610
|
# The number of days to retain automated backups. Setting this parameter
|
|
@@ -17688,24 +17622,19 @@ module Aws::RDS
|
|
|
17688
17622
|
# change the parameter from one non-zero value to another non-zero
|
|
17689
17623
|
# value, the change is asynchronously applied as soon as possible.
|
|
17690
17624
|
#
|
|
17691
|
-
#
|
|
17692
|
-
#
|
|
17693
|
-
#
|
|
17694
|
-
# by the DB cluster. For more information, see `ModifyDBCluster`.
|
|
17625
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
17626
|
+
# retention period for automated backups is managed by the DB cluster.
|
|
17627
|
+
# For more information, see `ModifyDBCluster`.
|
|
17695
17628
|
#
|
|
17696
17629
|
# Default: Uses existing setting
|
|
17697
17630
|
#
|
|
17698
17631
|
# Constraints:
|
|
17699
17632
|
#
|
|
17700
|
-
# *
|
|
17701
|
-
# instance is a source to read replicas. It can't be set to 0 for an
|
|
17702
|
-
# RDS Custom for Oracle DB instance.
|
|
17633
|
+
# * Must be a value from 0 to 35.
|
|
17703
17634
|
#
|
|
17704
|
-
# *
|
|
17705
|
-
# running MySQL 5.6 or later.
|
|
17635
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas.
|
|
17706
17636
|
#
|
|
17707
|
-
# *
|
|
17708
|
-
# is running PostgreSQL 9.3.5.
|
|
17637
|
+
# * Can't be set to 0 for an RDS Custom for Oracle DB instance.
|
|
17709
17638
|
#
|
|
17710
17639
|
# @option params [String] :preferred_backup_window
|
|
17711
17640
|
# The daily time range during which automated backups are created if
|
|
@@ -17714,61 +17643,65 @@ module Aws::RDS
|
|
|
17714
17643
|
# result in an outage and the change is asynchronously applied as soon
|
|
17715
17644
|
# as possible. The default is a 30-minute window selected at random from
|
|
17716
17645
|
# an 8-hour block of time for each Amazon Web Services Region. For more
|
|
17717
|
-
# information, see [Backup window][1] in the *Amazon RDS User Guide
|
|
17718
|
-
#
|
|
17719
|
-
# **Amazon Aurora**
|
|
17646
|
+
# information, see [Backup window][1] in the *Amazon RDS User Guide*.
|
|
17720
17647
|
#
|
|
17721
|
-
#
|
|
17722
|
-
#
|
|
17723
|
-
# `ModifyDBCluster`.
|
|
17648
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The daily
|
|
17649
|
+
# time range for creating automated backups is managed by the DB
|
|
17650
|
+
# cluster. For more information, see `ModifyDBCluster`.
|
|
17724
17651
|
#
|
|
17725
17652
|
# Constraints:
|
|
17726
17653
|
#
|
|
17727
|
-
# * Must be in the format hh24:mi-hh24:mi
|
|
17654
|
+
# * Must be in the format `hh24:mi-hh24:mi`.
|
|
17728
17655
|
#
|
|
17729
|
-
# * Must be in Universal Time
|
|
17656
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
17730
17657
|
#
|
|
17731
|
-
# * Must not conflict with the preferred maintenance window
|
|
17658
|
+
# * Must not conflict with the preferred maintenance window.
|
|
17732
17659
|
#
|
|
17733
|
-
# * Must be at least 30 minutes
|
|
17660
|
+
# * Must be at least 30 minutes.
|
|
17734
17661
|
#
|
|
17735
17662
|
#
|
|
17736
17663
|
#
|
|
17737
17664
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
|
|
17738
17665
|
#
|
|
17739
17666
|
# @option params [String] :preferred_maintenance_window
|
|
17740
|
-
# The weekly time range
|
|
17741
|
-
#
|
|
17742
|
-
#
|
|
17743
|
-
#
|
|
17744
|
-
#
|
|
17745
|
-
#
|
|
17746
|
-
#
|
|
17747
|
-
#
|
|
17748
|
-
#
|
|
17667
|
+
# The weekly time range during which system maintenance can occur, which
|
|
17668
|
+
# might result in an outage. Changing this parameter doesn't result in
|
|
17669
|
+
# an outage, except in the following situation, and the change is
|
|
17670
|
+
# asynchronously applied as soon as possible. If there are pending
|
|
17671
|
+
# actions that cause a reboot, and the maintenance window is changed to
|
|
17672
|
+
# include the current time, then changing this parameter causes a reboot
|
|
17673
|
+
# of the DB instance. If you change this window to the current time,
|
|
17674
|
+
# there must be at least 30 minutes between the current time and end of
|
|
17675
|
+
# the window to ensure pending changes are applied.
|
|
17749
17676
|
#
|
|
17750
17677
|
# For more information, see [Amazon RDS Maintenance Window][1] in the
|
|
17751
17678
|
# *Amazon RDS User Guide.*
|
|
17752
17679
|
#
|
|
17753
17680
|
# Default: Uses existing setting
|
|
17754
17681
|
#
|
|
17755
|
-
#
|
|
17682
|
+
# Constraints:
|
|
17683
|
+
#
|
|
17684
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
|
17685
|
+
#
|
|
17686
|
+
# * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
|
|
17687
|
+
#
|
|
17688
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
17756
17689
|
#
|
|
17757
|
-
#
|
|
17690
|
+
# * Must not conflict with the preferred backup window.
|
|
17758
17691
|
#
|
|
17759
|
-
#
|
|
17692
|
+
# * Must be at least 30 minutes.
|
|
17760
17693
|
#
|
|
17761
17694
|
#
|
|
17762
17695
|
#
|
|
17763
17696
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
|
|
17764
17697
|
#
|
|
17765
17698
|
# @option params [Boolean] :multi_az
|
|
17766
|
-
#
|
|
17767
|
-
#
|
|
17768
|
-
#
|
|
17769
|
-
#
|
|
17699
|
+
# Specifies whether the DB instance is a Multi-AZ deployment. Changing
|
|
17700
|
+
# this parameter doesn't result in an outage. The change is applied
|
|
17701
|
+
# during the next maintenance window unless the `ApplyImmediately`
|
|
17702
|
+
# parameter is enabled for this request.
|
|
17770
17703
|
#
|
|
17771
|
-
# This setting doesn't apply to RDS Custom.
|
|
17704
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17772
17705
|
#
|
|
17773
17706
|
# @option params [String] :engine_version
|
|
17774
17707
|
# The version number of the database engine to upgrade to. Changing this
|
|
@@ -17781,33 +17714,37 @@ module Aws::RDS
|
|
|
17781
17714
|
# family for the new engine version must be specified. The new DB
|
|
17782
17715
|
# parameter group can be the default for that DB parameter group family.
|
|
17783
17716
|
#
|
|
17784
|
-
# If you specify only a major version, Amazon RDS
|
|
17717
|
+
# If you specify only a major version, Amazon RDS updates the DB
|
|
17785
17718
|
# instance to the default minor version if the current minor version is
|
|
17786
17719
|
# lower. For information about valid engine versions, see
|
|
17787
17720
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
|
17788
17721
|
#
|
|
17789
17722
|
# If the instance that you're modifying is acting as a read replica,
|
|
17790
|
-
# the engine version that you specify must be the same or
|
|
17791
|
-
# version that the source DB instance or cluster is running.
|
|
17723
|
+
# the engine version that you specify must be the same or higher than
|
|
17724
|
+
# the version that the source DB instance or cluster is running.
|
|
17792
17725
|
#
|
|
17793
17726
|
# In RDS Custom for Oracle, this parameter is supported for read
|
|
17794
17727
|
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
|
17795
17728
|
#
|
|
17796
17729
|
# @option params [Boolean] :allow_major_version_upgrade
|
|
17797
|
-
#
|
|
17798
|
-
#
|
|
17730
|
+
# Specifies whether major version upgrades are allowed. Changing this
|
|
17731
|
+
# parameter doesn't result in an outage and the change is
|
|
17799
17732
|
# asynchronously applied as soon as possible.
|
|
17800
17733
|
#
|
|
17801
|
-
# This setting doesn't apply to RDS Custom.
|
|
17734
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17802
17735
|
#
|
|
17803
|
-
# Constraints:
|
|
17804
|
-
#
|
|
17805
|
-
# version
|
|
17736
|
+
# Constraints:
|
|
17737
|
+
#
|
|
17738
|
+
# * Major version upgrades must be allowed when specifying a value for
|
|
17739
|
+
# the `EngineVersion` parameter that's a different major version than
|
|
17740
|
+
# the DB instance's current version.
|
|
17741
|
+
#
|
|
17742
|
+
# ^
|
|
17806
17743
|
#
|
|
17807
17744
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
17808
|
-
#
|
|
17809
|
-
#
|
|
17810
|
-
#
|
|
17745
|
+
# Specifies whether minor version upgrades are applied automatically to
|
|
17746
|
+
# the DB instance during the maintenance window. An outage occurs when
|
|
17747
|
+
# all the following conditions are met:
|
|
17811
17748
|
#
|
|
17812
17749
|
# * The automatic upgrade is enabled for the maintenance window.
|
|
17813
17750
|
#
|
|
@@ -17815,19 +17752,29 @@ module Aws::RDS
|
|
|
17815
17752
|
#
|
|
17816
17753
|
# * RDS has enabled automatic patching for the engine version.
|
|
17817
17754
|
#
|
|
17818
|
-
# If any of the preceding conditions isn't met, RDS applies the
|
|
17819
|
-
# as soon as possible and doesn't cause an outage.
|
|
17755
|
+
# If any of the preceding conditions isn't met, Amazon RDS applies the
|
|
17756
|
+
# change as soon as possible and doesn't cause an outage.
|
|
17820
17757
|
#
|
|
17821
|
-
# For an RDS Custom DB instance,
|
|
17822
|
-
#
|
|
17758
|
+
# For an RDS Custom DB instance, don't enable this setting. Otherwise,
|
|
17759
|
+
# the operation returns an error.
|
|
17823
17760
|
#
|
|
17824
17761
|
# @option params [String] :license_model
|
|
17825
17762
|
# The license model for the DB instance.
|
|
17826
17763
|
#
|
|
17827
|
-
# This setting doesn't apply to RDS Custom
|
|
17764
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
17765
|
+
# instances.
|
|
17828
17766
|
#
|
|
17829
|
-
# Valid
|
|
17830
|
-
#
|
|
17767
|
+
# Valid Values:
|
|
17768
|
+
#
|
|
17769
|
+
# * RDS for MariaDB - `general-public-license`
|
|
17770
|
+
#
|
|
17771
|
+
# * RDS for Microsoft SQL Server - `license-included`
|
|
17772
|
+
#
|
|
17773
|
+
# * RDS for MySQL - `general-public-license`
|
|
17774
|
+
#
|
|
17775
|
+
# * RDS for Oracle - `bring-your-own-license | license-included`
|
|
17776
|
+
#
|
|
17777
|
+
# * RDS for PostgreSQL - `postgresql-license`
|
|
17831
17778
|
#
|
|
17832
17779
|
# @option params [Integer] :iops
|
|
17833
17780
|
# The new Provisioned IOPS (I/O operations per second) value for the RDS
|
|
@@ -17855,16 +17802,20 @@ module Aws::RDS
|
|
|
17855
17802
|
# rebooting the instance, deleting the instance, creating a read replica
|
|
17856
17803
|
# for the instance, and creating a DB snapshot of the instance.
|
|
17857
17804
|
#
|
|
17858
|
-
# Constraints:
|
|
17859
|
-
#
|
|
17860
|
-
#
|
|
17861
|
-
#
|
|
17805
|
+
# Constraints:
|
|
17806
|
+
#
|
|
17807
|
+
# * For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
|
|
17808
|
+
# PostgreSQL - The value supplied must be at least 10% greater than
|
|
17809
|
+
# the current value. Values that are not at least 10% greater than the
|
|
17810
|
+
# existing value are rounded up so that they are 10% greater than the
|
|
17811
|
+
# current value.
|
|
17812
|
+
#
|
|
17813
|
+
# ^
|
|
17862
17814
|
#
|
|
17863
17815
|
# Default: Uses existing setting
|
|
17864
17816
|
#
|
|
17865
17817
|
# @option params [String] :option_group_name
|
|
17866
|
-
#
|
|
17867
|
-
# specified option group.
|
|
17818
|
+
# The option group to associate the DB instance with.
|
|
17868
17819
|
#
|
|
17869
17820
|
# Changing this parameter doesn't result in an outage, with one
|
|
17870
17821
|
# exception. If the parameter change results in an option group that
|
|
@@ -17880,16 +17831,16 @@ module Aws::RDS
|
|
|
17880
17831
|
# can't be removed from a DB instance after it is associated with a DB
|
|
17881
17832
|
# instance.
|
|
17882
17833
|
#
|
|
17883
|
-
# This setting doesn't apply to RDS Custom.
|
|
17834
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17884
17835
|
#
|
|
17885
17836
|
# @option params [String] :new_db_instance_identifier
|
|
17886
|
-
# The new
|
|
17887
|
-
#
|
|
17888
|
-
#
|
|
17889
|
-
#
|
|
17890
|
-
#
|
|
17837
|
+
# The new identifier for the DB instance when renaming a DB instance.
|
|
17838
|
+
# When you change the DB instance identifier, an instance reboot occurs
|
|
17839
|
+
# immediately if you enable `ApplyImmediately`, or will occur during the
|
|
17840
|
+
# next maintenance window if you disable `ApplyImmediately`. This value
|
|
17841
|
+
# is stored as a lowercase string.
|
|
17891
17842
|
#
|
|
17892
|
-
# This setting doesn't apply to RDS Custom.
|
|
17843
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17893
17844
|
#
|
|
17894
17845
|
# Constraints:
|
|
17895
17846
|
#
|
|
@@ -17902,7 +17853,7 @@ module Aws::RDS
|
|
|
17902
17853
|
# Example: `mydbinstance`
|
|
17903
17854
|
#
|
|
17904
17855
|
# @option params [String] :storage_type
|
|
17905
|
-
#
|
|
17856
|
+
# The storage type to associate with the DB instance.
|
|
17906
17857
|
#
|
|
17907
17858
|
# If you specify Provisioned IOPS (`io1`), you must also include a value
|
|
17908
17859
|
# for the `Iops` parameter.
|
|
@@ -17922,27 +17873,28 @@ module Aws::RDS
|
|
|
17922
17873
|
# rebooting the instance, deleting the instance, creating a read replica
|
|
17923
17874
|
# for the instance, and creating a DB snapshot of the instance.
|
|
17924
17875
|
#
|
|
17925
|
-
# Valid
|
|
17876
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
|
17926
17877
|
#
|
|
17927
|
-
# Default: `io1
|
|
17878
|
+
# Default: `io1`, if the `Iops` parameter is specified. Otherwise,
|
|
17879
|
+
# `gp2`.
|
|
17928
17880
|
#
|
|
17929
17881
|
# @option params [String] :tde_credential_arn
|
|
17930
17882
|
# The ARN from the key store with which to associate the instance for
|
|
17931
17883
|
# TDE encryption.
|
|
17932
17884
|
#
|
|
17933
|
-
# This setting doesn't apply to RDS Custom.
|
|
17885
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17934
17886
|
#
|
|
17935
17887
|
# @option params [String] :tde_credential_password
|
|
17936
17888
|
# The password for the given ARN from the key store in order to access
|
|
17937
17889
|
# the device.
|
|
17938
17890
|
#
|
|
17939
|
-
# This setting doesn't apply to RDS Custom.
|
|
17891
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17940
17892
|
#
|
|
17941
17893
|
# @option params [String] :ca_certificate_identifier
|
|
17942
|
-
#
|
|
17943
|
-
#
|
|
17894
|
+
# The CA certificate identifier to use for the DB instance6's server
|
|
17895
|
+
# certificate.
|
|
17944
17896
|
#
|
|
17945
|
-
# This setting doesn't apply to RDS Custom.
|
|
17897
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17946
17898
|
#
|
|
17947
17899
|
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
17948
17900
|
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
@@ -17964,33 +17916,34 @@ module Aws::RDS
|
|
|
17964
17916
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
|
17965
17917
|
# RDS User Guide*.
|
|
17966
17918
|
#
|
|
17967
|
-
# This setting doesn't apply to RDS Custom.
|
|
17919
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17968
17920
|
#
|
|
17969
17921
|
#
|
|
17970
17922
|
#
|
|
17971
17923
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
|
17972
17924
|
#
|
|
17973
17925
|
# @option params [Boolean] :copy_tags_to_snapshot
|
|
17974
|
-
#
|
|
17975
|
-
#
|
|
17926
|
+
# Specifies whether to copy all tags from the DB instance to snapshots
|
|
17927
|
+
# of the DB instance. By default, tags aren't copied.
|
|
17976
17928
|
#
|
|
17977
|
-
#
|
|
17978
|
-
#
|
|
17979
|
-
#
|
|
17980
|
-
#
|
|
17981
|
-
# the DB cluster setting. For more information, see `ModifyDBCluster`.
|
|
17929
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Copying
|
|
17930
|
+
# tags to snapshots is managed by the DB cluster. Setting this value for
|
|
17931
|
+
# an Aurora DB instance has no effect on the DB cluster setting. For
|
|
17932
|
+
# more information, see `ModifyDBCluster`.
|
|
17982
17933
|
#
|
|
17983
17934
|
# @option params [Integer] :monitoring_interval
|
|
17984
17935
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
17985
|
-
# metrics are collected for the DB instance. To disable
|
|
17986
|
-
# Enhanced Monitoring metrics, specify 0
|
|
17936
|
+
# metrics are collected for the DB instance. To disable collection of
|
|
17937
|
+
# Enhanced Monitoring metrics, specify `0`.
|
|
17987
17938
|
#
|
|
17988
17939
|
# If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
|
|
17989
|
-
# value other than 0
|
|
17940
|
+
# value other than `0`.
|
|
17990
17941
|
#
|
|
17991
|
-
# This setting doesn't apply to RDS Custom.
|
|
17942
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17992
17943
|
#
|
|
17993
|
-
# Valid Values: `0
|
|
17944
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
|
17945
|
+
#
|
|
17946
|
+
# Default: `0`
|
|
17994
17947
|
#
|
|
17995
17948
|
# @option params [Integer] :db_port_number
|
|
17996
17949
|
# The port number on which the database accepts connections.
|
|
@@ -18002,49 +17955,33 @@ module Aws::RDS
|
|
|
18002
17955
|
# If you change the `DBPortNumber` value, your database restarts
|
|
18003
17956
|
# regardless of the value of the `ApplyImmediately` parameter.
|
|
18004
17957
|
#
|
|
18005
|
-
# This setting doesn't apply to RDS Custom.
|
|
18006
|
-
#
|
|
18007
|
-
# **MySQL**
|
|
18008
|
-
#
|
|
18009
|
-
# Default: `3306`
|
|
18010
|
-
#
|
|
18011
|
-
# Valid values: `1150-65535`
|
|
18012
|
-
#
|
|
18013
|
-
# **MariaDB**
|
|
18014
|
-
#
|
|
18015
|
-
# Default: `3306`
|
|
18016
|
-
#
|
|
18017
|
-
# Valid values: `1150-65535`
|
|
17958
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18018
17959
|
#
|
|
18019
|
-
#
|
|
18020
|
-
#
|
|
18021
|
-
# Default: `5432`
|
|
18022
|
-
#
|
|
18023
|
-
# Valid values: `1150-65535`
|
|
17960
|
+
# Valid Values: `1150-65535`
|
|
18024
17961
|
#
|
|
18025
|
-
#
|
|
17962
|
+
# Default:
|
|
18026
17963
|
#
|
|
18027
|
-
#
|
|
17964
|
+
# * Amazon Aurora - `3306`
|
|
18028
17965
|
#
|
|
18029
|
-
#
|
|
17966
|
+
# * RDS for MariaDB - `3306`
|
|
18030
17967
|
#
|
|
18031
|
-
#
|
|
17968
|
+
# * RDS for Microsoft SQL Server - `1433`
|
|
18032
17969
|
#
|
|
18033
|
-
#
|
|
17970
|
+
# * RDS for MySQL - `3306`
|
|
18034
17971
|
#
|
|
18035
|
-
#
|
|
17972
|
+
# * RDS for Oracle - `1521`
|
|
18036
17973
|
#
|
|
18037
|
-
#
|
|
18038
|
-
# `3389`, `47001`, and `49152-49156`.
|
|
17974
|
+
# * RDS for PostgreSQL - `5432`
|
|
18039
17975
|
#
|
|
18040
|
-
#
|
|
17976
|
+
# Constraints:
|
|
18041
17977
|
#
|
|
18042
|
-
#
|
|
17978
|
+
# * For RDS for Microsoft SQL Server, the value can't be `1234`,
|
|
17979
|
+
# `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
|
|
18043
17980
|
#
|
|
18044
|
-
#
|
|
17981
|
+
# ^
|
|
18045
17982
|
#
|
|
18046
17983
|
# @option params [Boolean] :publicly_accessible
|
|
18047
|
-
#
|
|
17984
|
+
# Specifies whether the DB instance is publicly accessible.
|
|
18048
17985
|
#
|
|
18049
17986
|
# When the DB cluster is publicly accessible, its Domain Name System
|
|
18050
17987
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
|
@@ -18071,10 +18008,10 @@ module Aws::RDS
|
|
|
18071
18008
|
# a monitoring role, see [To create an IAM role for Amazon RDS Enhanced
|
|
18072
18009
|
# Monitoring][1] in the *Amazon RDS User Guide.*
|
|
18073
18010
|
#
|
|
18074
|
-
# If `MonitoringInterval` is set to a value other than 0
|
|
18011
|
+
# If `MonitoringInterval` is set to a value other than `0`, supply a
|
|
18075
18012
|
# `MonitoringRoleArn` value.
|
|
18076
18013
|
#
|
|
18077
|
-
# This setting doesn't apply to RDS Custom.
|
|
18014
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18078
18015
|
#
|
|
18079
18016
|
#
|
|
18080
18017
|
#
|
|
@@ -18084,28 +18021,28 @@ module Aws::RDS
|
|
|
18084
18021
|
# The name of the IAM role to use when making API calls to the Directory
|
|
18085
18022
|
# Service.
|
|
18086
18023
|
#
|
|
18087
|
-
# This setting doesn't apply to RDS Custom.
|
|
18024
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18088
18025
|
#
|
|
18089
18026
|
# @option params [Integer] :promotion_tier
|
|
18090
|
-
#
|
|
18091
|
-
#
|
|
18092
|
-
#
|
|
18093
|
-
#
|
|
18027
|
+
# The order of priority in which an Aurora Replica is promoted to the
|
|
18028
|
+
# primary instance after a failure of the existing primary instance. For
|
|
18029
|
+
# more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
|
|
18030
|
+
# in the *Amazon Aurora User Guide*.
|
|
18094
18031
|
#
|
|
18095
|
-
# This setting doesn't apply to RDS Custom.
|
|
18032
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18096
18033
|
#
|
|
18097
|
-
# Default: 1
|
|
18034
|
+
# Default: `1`
|
|
18098
18035
|
#
|
|
18099
|
-
# Valid Values: 0 - 15
|
|
18036
|
+
# Valid Values: `0 - 15`
|
|
18100
18037
|
#
|
|
18101
18038
|
#
|
|
18102
18039
|
#
|
|
18103
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
|
18040
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
|
|
18104
18041
|
#
|
|
18105
18042
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
18106
|
-
#
|
|
18107
|
-
#
|
|
18108
|
-
#
|
|
18043
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
|
18044
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
|
18045
|
+
# mapping isn't enabled.
|
|
18109
18046
|
#
|
|
18110
18047
|
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
|
18111
18048
|
# Services IAM accounts to database accounts is managed by the DB
|
|
@@ -18115,20 +18052,19 @@ module Aws::RDS
|
|
|
18115
18052
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
|
18116
18053
|
# RDS User Guide.*
|
|
18117
18054
|
#
|
|
18118
|
-
# This setting doesn't apply to RDS Custom.
|
|
18055
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18119
18056
|
#
|
|
18120
18057
|
#
|
|
18121
18058
|
#
|
|
18122
18059
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
|
18123
18060
|
#
|
|
18124
18061
|
# @option params [Boolean] :enable_performance_insights
|
|
18125
|
-
#
|
|
18126
|
-
# DB instance.
|
|
18062
|
+
# Specifies whether to enable Performance Insights for the DB instance.
|
|
18127
18063
|
#
|
|
18128
18064
|
# For more information, see [Using Amazon Performance Insights][1] in
|
|
18129
18065
|
# the *Amazon RDS User Guide*.
|
|
18130
18066
|
#
|
|
18131
|
-
# This setting doesn't apply to RDS Custom.
|
|
18067
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18132
18068
|
#
|
|
18133
18069
|
#
|
|
18134
18070
|
#
|
|
@@ -18141,65 +18077,60 @@ module Aws::RDS
|
|
|
18141
18077
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
|
18142
18078
|
# alias ARN, or alias name for the KMS key.
|
|
18143
18079
|
#
|
|
18144
|
-
# If you
|
|
18080
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
|
18145
18081
|
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
|
18146
18082
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
|
18147
18083
|
# a different default KMS key for each Amazon Web Services Region.
|
|
18148
18084
|
#
|
|
18149
|
-
# This setting doesn't apply to RDS Custom.
|
|
18085
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18150
18086
|
#
|
|
18151
18087
|
# @option params [Integer] :performance_insights_retention_period
|
|
18152
|
-
# The number of days to retain Performance Insights data.
|
|
18153
|
-
# 7 days. The following values are valid:
|
|
18088
|
+
# The number of days to retain Performance Insights data.
|
|
18154
18089
|
#
|
|
18155
|
-
#
|
|
18156
|
-
#
|
|
18157
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
|
18158
|
-
#
|
|
18159
|
-
# * 731
|
|
18160
|
-
#
|
|
18161
|
-
# For example, the following values are valid:
|
|
18090
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18162
18091
|
#
|
|
18163
|
-
#
|
|
18092
|
+
# Valid Values:
|
|
18164
18093
|
#
|
|
18165
|
-
# *
|
|
18094
|
+
# * `7`
|
|
18166
18095
|
#
|
|
18167
|
-
# *
|
|
18096
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
|
18097
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
|
18098
|
+
# months * 31)
|
|
18168
18099
|
#
|
|
18169
|
-
# * 731
|
|
18100
|
+
# * `731`
|
|
18170
18101
|
#
|
|
18171
|
-
#
|
|
18172
|
-
# value, RDS issues an error.
|
|
18102
|
+
# Default: `7` days
|
|
18173
18103
|
#
|
|
18174
|
-
#
|
|
18104
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
|
18105
|
+
# Amazon RDS returns an error.
|
|
18175
18106
|
#
|
|
18176
18107
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
|
18177
|
-
# The
|
|
18178
|
-
#
|
|
18108
|
+
# The log types to be enabled for export to CloudWatch Logs for a
|
|
18109
|
+
# specific DB instance.
|
|
18179
18110
|
#
|
|
18180
18111
|
# A change to the `CloudwatchLogsExportConfiguration` parameter is
|
|
18181
18112
|
# always applied to the DB instance immediately. Therefore, the
|
|
18182
18113
|
# `ApplyImmediately` parameter has no effect.
|
|
18183
18114
|
#
|
|
18184
|
-
# This setting doesn't apply to RDS Custom.
|
|
18115
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18185
18116
|
#
|
|
18186
18117
|
# @option params [Array<Types::ProcessorFeature>] :processor_features
|
|
18187
18118
|
# The number of CPU cores and the number of threads per core for the DB
|
|
18188
18119
|
# instance class of the DB instance.
|
|
18189
18120
|
#
|
|
18190
|
-
# This setting doesn't apply to RDS Custom.
|
|
18121
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18191
18122
|
#
|
|
18192
18123
|
# @option params [Boolean] :use_default_processor_features
|
|
18193
|
-
#
|
|
18194
|
-
#
|
|
18124
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
|
18125
|
+
# default processor features.
|
|
18195
18126
|
#
|
|
18196
|
-
# This setting doesn't apply to RDS Custom.
|
|
18127
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18197
18128
|
#
|
|
18198
18129
|
# @option params [Boolean] :deletion_protection
|
|
18199
|
-
#
|
|
18200
|
-
#
|
|
18201
|
-
#
|
|
18202
|
-
#
|
|
18130
|
+
# Specifies whether the DB instance has deletion protection enabled. The
|
|
18131
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
18132
|
+
# default, deletion protection isn't enabled. For more information, see
|
|
18133
|
+
# [ Deleting a DB Instance][1].
|
|
18203
18134
|
#
|
|
18204
18135
|
#
|
|
18205
18136
|
#
|
|
@@ -18213,15 +18144,15 @@ module Aws::RDS
|
|
|
18213
18144
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
|
18214
18145
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
|
18215
18146
|
#
|
|
18216
|
-
# This setting doesn't apply to RDS Custom.
|
|
18147
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18217
18148
|
#
|
|
18218
18149
|
#
|
|
18219
18150
|
#
|
|
18220
18151
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
18221
18152
|
#
|
|
18222
18153
|
# @option params [Boolean] :certificate_rotation_restart
|
|
18223
|
-
#
|
|
18224
|
-
#
|
|
18154
|
+
# Specifies whether the DB instance is restarted when you rotate your
|
|
18155
|
+
# SSL/TLS certificate.
|
|
18225
18156
|
#
|
|
18226
18157
|
# By default, the DB instance is restarted when you rotate your SSL/TLS
|
|
18227
18158
|
# certificate. The certificate is not updated until the DB instance is
|
|
@@ -18242,7 +18173,7 @@ module Aws::RDS
|
|
|
18242
18173
|
# Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
|
|
18243
18174
|
# the *Amazon Aurora User Guide*.
|
|
18244
18175
|
#
|
|
18245
|
-
# This setting doesn't apply to RDS Custom.
|
|
18176
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18246
18177
|
#
|
|
18247
18178
|
#
|
|
18248
18179
|
#
|
|
@@ -18265,15 +18196,15 @@ module Aws::RDS
|
|
|
18265
18196
|
# more information, see [Working with Oracle Read Replicas for Amazon
|
|
18266
18197
|
# RDS][1] in the *Amazon RDS User Guide*.
|
|
18267
18198
|
#
|
|
18268
|
-
# This setting doesn't apply to RDS Custom.
|
|
18199
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18269
18200
|
#
|
|
18270
18201
|
#
|
|
18271
18202
|
#
|
|
18272
18203
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
|
18273
18204
|
#
|
|
18274
18205
|
# @option params [Boolean] :enable_customer_owned_ip
|
|
18275
|
-
#
|
|
18276
|
-
#
|
|
18206
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
18207
|
+
# RDS on Outposts DB instance.
|
|
18277
18208
|
#
|
|
18278
18209
|
# A *CoIP* provides local or external connectivity to resources in your
|
|
18279
18210
|
# Outpost subnets through your on-premises network. For some use cases,
|
|
@@ -18296,27 +18227,28 @@ module Aws::RDS
|
|
|
18296
18227
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
18297
18228
|
# Services Backup.
|
|
18298
18229
|
#
|
|
18299
|
-
# This setting doesn't apply to RDS Custom.
|
|
18230
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18300
18231
|
#
|
|
18301
18232
|
# @option params [String] :automation_mode
|
|
18302
|
-
# The automation mode of the RDS Custom DB instance
|
|
18303
|
-
#
|
|
18304
|
-
#
|
|
18305
|
-
#
|
|
18233
|
+
# The automation mode of the RDS Custom DB instance. If `full`, the DB
|
|
18234
|
+
# instance automates monitoring and instance recovery. If `all paused`,
|
|
18235
|
+
# the instance pauses automation for the duration set by
|
|
18236
|
+
# `ResumeFullAutomationModeMinutes`.
|
|
18306
18237
|
#
|
|
18307
18238
|
# @option params [Integer] :resume_full_automation_mode_minutes
|
|
18308
18239
|
# The number of minutes to pause the automation. When the time period
|
|
18309
|
-
# ends, RDS Custom resumes full automation.
|
|
18310
|
-
# (default). The maximum value is `1,440`.
|
|
18240
|
+
# ends, RDS Custom resumes full automation.
|
|
18311
18241
|
#
|
|
18312
|
-
#
|
|
18313
|
-
# The network type of the DB instance.
|
|
18242
|
+
# Default: `60`
|
|
18314
18243
|
#
|
|
18315
|
-
#
|
|
18244
|
+
# Constraints:
|
|
18316
18245
|
#
|
|
18317
|
-
# *
|
|
18246
|
+
# * Must be at least 60.
|
|
18318
18247
|
#
|
|
18319
|
-
# *
|
|
18248
|
+
# * Must be no more than 1,440.
|
|
18249
|
+
#
|
|
18250
|
+
# @option params [String] :network_type
|
|
18251
|
+
# The network type of the DB instance.
|
|
18320
18252
|
#
|
|
18321
18253
|
# The network type is determined by the `DBSubnetGroup` specified for
|
|
18322
18254
|
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
@@ -18325,20 +18257,23 @@ module Aws::RDS
|
|
|
18325
18257
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
18326
18258
|
# the *Amazon RDS User Guide.*
|
|
18327
18259
|
#
|
|
18260
|
+
# Valid Values: `IPV4 | DUAL`
|
|
18261
|
+
#
|
|
18328
18262
|
#
|
|
18329
18263
|
#
|
|
18330
18264
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
18331
18265
|
#
|
|
18332
18266
|
# @option params [Integer] :storage_throughput
|
|
18333
|
-
#
|
|
18267
|
+
# The storage throughput value for the DB instance.
|
|
18334
18268
|
#
|
|
18335
18269
|
# This setting applies only to the `gp3` storage type.
|
|
18336
18270
|
#
|
|
18337
|
-
# This setting doesn't apply to
|
|
18271
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
18272
|
+
# instances.
|
|
18338
18273
|
#
|
|
18339
18274
|
# @option params [Boolean] :manage_master_user_password
|
|
18340
|
-
#
|
|
18341
|
-
#
|
|
18275
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
18276
|
+
# Services Secrets Manager.
|
|
18342
18277
|
#
|
|
18343
18278
|
# If the DB instance doesn't manage the master user password with
|
|
18344
18279
|
# Amazon Web Services Secrets Manager, you can turn on this management.
|
|
@@ -18347,9 +18282,9 @@ module Aws::RDS
|
|
|
18347
18282
|
# If the DB instance already manages the master user password with
|
|
18348
18283
|
# Amazon Web Services Secrets Manager, and you specify that the master
|
|
18349
18284
|
# user password is not managed with Amazon Web Services Secrets Manager,
|
|
18350
|
-
# then you must specify `MasterUserPassword`. In this case, RDS
|
|
18351
|
-
# the secret and uses the new password for the master user
|
|
18352
|
-
# `MasterUserPassword`.
|
|
18285
|
+
# then you must specify `MasterUserPassword`. In this case, Amazon RDS
|
|
18286
|
+
# deletes the secret and uses the new password for the master user
|
|
18287
|
+
# specified by `MasterUserPassword`.
|
|
18353
18288
|
#
|
|
18354
18289
|
# For more information, see [Password management with Amazon Web
|
|
18355
18290
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
|
@@ -18366,8 +18301,8 @@ module Aws::RDS
|
|
|
18366
18301
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
18367
18302
|
#
|
|
18368
18303
|
# @option params [Boolean] :rotate_master_user_password
|
|
18369
|
-
#
|
|
18370
|
-
#
|
|
18304
|
+
# Specifies whether to rotate the secret managed by Amazon Web Services
|
|
18305
|
+
# Secrets Manager for the master user password.
|
|
18371
18306
|
#
|
|
18372
18307
|
# This setting is valid only if the master user password is managed by
|
|
18373
18308
|
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
|
@@ -19097,6 +19032,12 @@ module Aws::RDS
|
|
|
19097
19032
|
#
|
|
19098
19033
|
# **Oracle**
|
|
19099
19034
|
#
|
|
19035
|
+
# * `19.0.0.0.ru-2022-01.rur-2022-01.r1` (supported for 12.2.0.1 DB
|
|
19036
|
+
# snapshots)
|
|
19037
|
+
#
|
|
19038
|
+
# * `19.0.0.0.ru-2022-07.rur-2022-07.r1` (supported for 12.1.0.2 DB
|
|
19039
|
+
# snapshots)
|
|
19040
|
+
#
|
|
19100
19041
|
# * `12.1.0.2.v8` (supported for 12.1.0.1 DB snapshots)
|
|
19101
19042
|
#
|
|
19102
19043
|
# * `11.2.0.4.v12` (supported for 11.2.0.2 DB snapshots)
|
|
@@ -27469,7 +27410,7 @@ module Aws::RDS
|
|
|
27469
27410
|
params: params,
|
|
27470
27411
|
config: config)
|
|
27471
27412
|
context[:gem_name] = 'aws-sdk-rds'
|
|
27472
|
-
context[:gem_version] = '1.
|
|
27413
|
+
context[:gem_version] = '1.182.0'
|
|
27473
27414
|
Seahorse::Client::Request.new(handlers, context)
|
|
27474
27415
|
end
|
|
27475
27416
|
|