aws-sdk-rds 1.181.0 → 1.183.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1403 -1104
- data/lib/aws-sdk-rds/client_api.rb +24 -0
- data/lib/aws-sdk-rds/db_cluster.rb +425 -444
- data/lib/aws-sdk-rds/db_instance.rb +951 -847
- data/lib/aws-sdk-rds/db_snapshot.rb +47 -0
- data/lib/aws-sdk-rds/resource.rb +645 -688
- data/lib/aws-sdk-rds/types.rb +1555 -1354
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +4 -4
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
|
-
#
|
|
2557
|
+
# For information about a specific engine, see the following topics:
|
|
2563
2558
|
#
|
|
2564
|
-
#
|
|
2565
|
-
#
|
|
2559
|
+
# * Aurora MySQL - see [Database engine updates for Amazon Aurora
|
|
2560
|
+
# MySQL][1] in the *Amazon Aurora User Guide*.
|
|
2566
2561
|
#
|
|
2567
|
-
#
|
|
2562
|
+
# * Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and
|
|
2563
|
+
# engine versions][2] in the *Amazon Aurora User Guide*.
|
|
2568
2564
|
#
|
|
2569
|
-
#
|
|
2570
|
-
#
|
|
2565
|
+
# * RDS for MySQL - see [Amazon RDS for MySQL][3] in the *Amazon RDS
|
|
2566
|
+
# User Guide*.
|
|
2571
2567
|
#
|
|
2572
|
-
#
|
|
2573
|
-
#
|
|
2574
|
-
# For information, see [Amazon RDS for MySQL][3] in the *Amazon RDS User
|
|
2575
|
-
# Guide*.
|
|
2576
|
-
#
|
|
2577
|
-
# **PostgreSQL**
|
|
2578
|
-
#
|
|
2579
|
-
# For information, see [Amazon RDS for PostgreSQL][4] in the *Amazon RDS
|
|
2580
|
-
# User Guide*.
|
|
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
|
-
#
|
|
2810
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2823
2811
|
#
|
|
2824
|
-
#
|
|
2812
|
+
# The following values are valid for each DB engine:
|
|
2825
2813
|
#
|
|
2826
|
-
#
|
|
2814
|
+
# * Aurora MySQL - `audit | error | general | slowquery`
|
|
2827
2815
|
#
|
|
2828
|
-
#
|
|
2816
|
+
# * Aurora PostgreSQL - `postgresql`
|
|
2829
2817
|
#
|
|
2830
|
-
#
|
|
2818
|
+
# * RDS for MySQL - `error | general | slowquery`
|
|
2831
2819
|
#
|
|
2832
|
-
#
|
|
2833
|
-
#
|
|
2834
|
-
# **Aurora PostgreSQL**
|
|
2835
|
-
#
|
|
2836
|
-
# Possible value is `postgresql`.
|
|
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`
|
|
2996
2980
|
#
|
|
2997
|
-
#
|
|
2998
|
-
#
|
|
2999
|
-
#
|
|
3000
|
-
#
|
|
2981
|
+
# * Multi-AZ DB clusters - `io1`
|
|
2982
|
+
#
|
|
2983
|
+
# Default:
|
|
2984
|
+
#
|
|
2985
|
+
# * Aurora DB clusters - `aurora`
|
|
2986
|
+
#
|
|
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
|
|
@@ -3516,6 +3499,10 @@ module Aws::RDS
|
|
|
3516
3499
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
3517
3500
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
3518
3501
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
3502
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
3503
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
3504
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
3505
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
3519
3506
|
# resp.db_cluster.tag_list #=> Array
|
|
3520
3507
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
3521
3508
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -4006,123 +3993,112 @@ module Aws::RDS
|
|
|
4006
3993
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html
|
|
4007
3994
|
#
|
|
4008
3995
|
# @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.
|
|
4021
|
-
#
|
|
4022
|
-
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4023
|
-
# underscores, or digits (0-9).
|
|
4024
|
-
#
|
|
4025
|
-
# * Can't be a word reserved by the specified database engine
|
|
3996
|
+
# The meaning of this parameter differs depending on the database
|
|
3997
|
+
# engine.
|
|
4026
3998
|
#
|
|
4027
|
-
#
|
|
3999
|
+
# Amazon Aurora MySQL
|
|
4000
|
+
# Amazon Aurora PostgreSQL
|
|
4001
|
+
# Amazon RDS Custom for Oracle
|
|
4002
|
+
# Amazon RDS Custom for SQL Server
|
|
4003
|
+
# RDS for MariaDB
|
|
4004
|
+
# RDS for MySQL
|
|
4005
|
+
# RDS for Oracle
|
|
4006
|
+
# RDS for PostgreSQL
|
|
4007
|
+
# RDS for SQL Server
|
|
4028
4008
|
#
|
|
4029
|
-
# The name of the database to create when the DB instance
|
|
4030
|
-
#
|
|
4031
|
-
#
|
|
4009
|
+
# : The name of the database to create when the primary DB instance of
|
|
4010
|
+
# the Aurora MySQL DB cluster is created. If you don't specify a
|
|
4011
|
+
# value, Amazon RDS doesn't create a database in the DB cluster.
|
|
4032
4012
|
#
|
|
4033
|
-
#
|
|
4013
|
+
# Constraints:
|
|
4034
4014
|
#
|
|
4035
|
-
#
|
|
4015
|
+
# * Must contain 1 to 64 alphanumeric characters.
|
|
4036
4016
|
#
|
|
4037
|
-
#
|
|
4038
|
-
# underscores, or digits (0-9).
|
|
4017
|
+
# * Can't be a word reserved by the database engine.
|
|
4039
4018
|
#
|
|
4040
|
-
#
|
|
4019
|
+
# : The name of the database to create when the primary DB instance of
|
|
4020
|
+
# the Aurora PostgreSQL DB cluster is created.
|
|
4041
4021
|
#
|
|
4042
|
-
#
|
|
4022
|
+
# Default: `postgres`
|
|
4043
4023
|
#
|
|
4044
|
-
#
|
|
4045
|
-
# this parameter isn't specified, a database named `postgres` is
|
|
4046
|
-
# created in the DB instance.
|
|
4024
|
+
# Constraints:
|
|
4047
4025
|
#
|
|
4048
|
-
#
|
|
4026
|
+
# * Must contain 1 to 63 alphanumeric characters.
|
|
4049
4027
|
#
|
|
4050
|
-
#
|
|
4028
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4029
|
+
# underscores, or digits (0 to 9).
|
|
4051
4030
|
#
|
|
4052
|
-
#
|
|
4053
|
-
# underscores, or digits (0-9).
|
|
4031
|
+
# * Can't be a word reserved by the database engine.
|
|
4054
4032
|
#
|
|
4055
|
-
#
|
|
4033
|
+
# : The Oracle System ID (SID) of the created RDS Custom DB instance.
|
|
4056
4034
|
#
|
|
4057
|
-
#
|
|
4035
|
+
# Default: `ORCL`
|
|
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
|
+
# Constraints:
|
|
4062
4038
|
#
|
|
4063
|
-
#
|
|
4039
|
+
# * Must contain 1 to 8 alphanumeric characters.
|
|
4064
4040
|
#
|
|
4065
|
-
#
|
|
4041
|
+
# * Must contain a letter.
|
|
4066
4042
|
#
|
|
4067
|
-
#
|
|
4043
|
+
# * Can't be a word reserved by the database engine.
|
|
4068
4044
|
#
|
|
4069
|
-
#
|
|
4045
|
+
# : Not applicable. Must be null.
|
|
4070
4046
|
#
|
|
4071
|
-
#
|
|
4047
|
+
# : The name of the database to create when the DB instance is created.
|
|
4048
|
+
# If you don't specify a value, Amazon RDS doesn't create a database
|
|
4049
|
+
# in the DB instance.
|
|
4072
4050
|
#
|
|
4073
|
-
#
|
|
4074
|
-
# you don't specify a value, the default value is `ORCL`.
|
|
4051
|
+
# Constraints:
|
|
4075
4052
|
#
|
|
4076
|
-
#
|
|
4053
|
+
# * Must contain 1 to 64 letters or numbers.
|
|
4077
4054
|
#
|
|
4078
|
-
#
|
|
4055
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4056
|
+
# underscores, or digits (0-9).
|
|
4079
4057
|
#
|
|
4080
|
-
#
|
|
4058
|
+
# * Can't be a word reserved by the database engine.
|
|
4081
4059
|
#
|
|
4082
|
-
#
|
|
4060
|
+
# : The name of the database to create when the DB instance is created.
|
|
4061
|
+
# If you don't specify a value, Amazon RDS doesn't create a database
|
|
4062
|
+
# in the DB instance.
|
|
4083
4063
|
#
|
|
4084
|
-
#
|
|
4064
|
+
# Constraints:
|
|
4085
4065
|
#
|
|
4086
|
-
#
|
|
4066
|
+
# * Must contain 1 to 64 letters or numbers.
|
|
4087
4067
|
#
|
|
4088
|
-
#
|
|
4068
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4069
|
+
# underscores, or digits (0-9).
|
|
4089
4070
|
#
|
|
4090
|
-
#
|
|
4071
|
+
# * Can't be a word reserved by the database engine.
|
|
4091
4072
|
#
|
|
4092
|
-
#
|
|
4073
|
+
# : The Oracle System ID (SID) of the created DB instance.
|
|
4093
4074
|
#
|
|
4094
|
-
#
|
|
4075
|
+
# Default: `ORCL`
|
|
4095
4076
|
#
|
|
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.
|
|
4077
|
+
# Constraints:
|
|
4100
4078
|
#
|
|
4101
|
-
#
|
|
4079
|
+
# * Can't be longer than 8 characters.
|
|
4102
4080
|
#
|
|
4103
|
-
#
|
|
4081
|
+
# * Can't be a word reserved by the database engine, such as the
|
|
4082
|
+
# string `NULL`.
|
|
4104
4083
|
#
|
|
4105
|
-
#
|
|
4084
|
+
# : The name of the database to create when the DB instance is created.
|
|
4106
4085
|
#
|
|
4107
|
-
#
|
|
4086
|
+
# Default: `postgres`
|
|
4108
4087
|
#
|
|
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.
|
|
4088
|
+
# Constraints:
|
|
4113
4089
|
#
|
|
4114
|
-
#
|
|
4090
|
+
# * Must contain 1 to 63 letters, numbers, or underscores.
|
|
4115
4091
|
#
|
|
4116
|
-
#
|
|
4092
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
|
4093
|
+
# underscores, or digits (0-9).
|
|
4117
4094
|
#
|
|
4118
|
-
#
|
|
4119
|
-
# underscores, or digits (0 to 9).
|
|
4095
|
+
# * Can't be a word reserved by the database engine.
|
|
4120
4096
|
#
|
|
4121
|
-
#
|
|
4097
|
+
# : Not applicable. Must be null.
|
|
4122
4098
|
#
|
|
4123
4099
|
# @option params [required, String] :db_instance_identifier
|
|
4124
|
-
# The DB instance
|
|
4125
|
-
# string.
|
|
4100
|
+
# The identifier for this DB instance. This parameter is stored as a
|
|
4101
|
+
# lowercase string.
|
|
4126
4102
|
#
|
|
4127
4103
|
# Constraints:
|
|
4128
4104
|
#
|
|
@@ -4138,107 +4114,100 @@ module Aws::RDS
|
|
|
4138
4114
|
# The amount of storage in gibibytes (GiB) to allocate for the DB
|
|
4139
4115
|
# instance.
|
|
4140
4116
|
#
|
|
4141
|
-
#
|
|
4142
|
-
#
|
|
4143
|
-
#
|
|
4117
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Aurora
|
|
4118
|
+
# cluster volumes automatically grow as the amount of data in your
|
|
4119
|
+
# database increases, though you are only charged for the space that you
|
|
4120
|
+
# use in an Aurora cluster volume.
|
|
4144
4121
|
#
|
|
4145
|
-
#
|
|
4146
|
-
#
|
|
4147
|
-
# for
|
|
4122
|
+
# Amazon RDS Custom
|
|
4123
|
+
# RDS for MariaDB
|
|
4124
|
+
# RDS for MySQL
|
|
4125
|
+
# RDS for Oracle
|
|
4126
|
+
# RDS for PostgreSQL
|
|
4127
|
+
# RDS for SQL Server
|
|
4148
4128
|
#
|
|
4149
|
-
#
|
|
4129
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4130
|
+
# following:
|
|
4150
4131
|
#
|
|
4151
|
-
#
|
|
4152
|
-
#
|
|
4132
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4133
|
+
# 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for
|
|
4134
|
+
# SQL Server.
|
|
4153
4135
|
#
|
|
4154
|
-
#
|
|
4155
|
-
#
|
|
4156
|
-
#
|
|
4136
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to
|
|
4137
|
+
# 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
|
|
4138
|
+
# Server.
|
|
4157
4139
|
#
|
|
4158
|
-
#
|
|
4159
|
-
#
|
|
4140
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4141
|
+
# following:
|
|
4160
4142
|
#
|
|
4161
|
-
#
|
|
4143
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4144
|
+
# 20 to 65536.
|
|
4162
4145
|
#
|
|
4163
|
-
#
|
|
4164
|
-
#
|
|
4146
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4147
|
+
# 65536.
|
|
4165
4148
|
#
|
|
4166
|
-
#
|
|
4167
|
-
# to 65536.
|
|
4149
|
+
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
4168
4150
|
#
|
|
4169
|
-
#
|
|
4170
|
-
#
|
|
4151
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4152
|
+
# following:
|
|
4171
4153
|
#
|
|
4172
|
-
#
|
|
4154
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4155
|
+
# 20 to 65536.
|
|
4173
4156
|
#
|
|
4174
|
-
#
|
|
4157
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4158
|
+
# 65536.
|
|
4175
4159
|
#
|
|
4176
|
-
#
|
|
4177
|
-
# following:
|
|
4160
|
+
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
4178
4161
|
#
|
|
4179
|
-
#
|
|
4180
|
-
#
|
|
4162
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4163
|
+
# following:
|
|
4181
4164
|
#
|
|
4182
|
-
#
|
|
4183
|
-
#
|
|
4165
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4166
|
+
# 20 to 65536.
|
|
4184
4167
|
#
|
|
4185
|
-
#
|
|
4168
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4169
|
+
# 65536.
|
|
4186
4170
|
#
|
|
4187
|
-
#
|
|
4171
|
+
# * Magnetic storage (standard): Must be an integer from 10 to 3072.
|
|
4188
4172
|
#
|
|
4189
|
-
# Constraints to the amount of storage for each storage type are the
|
|
4190
|
-
#
|
|
4173
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4174
|
+
# following:
|
|
4191
4175
|
#
|
|
4192
|
-
#
|
|
4193
|
-
#
|
|
4176
|
+
# * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
|
|
4177
|
+
# 20 to 65536.
|
|
4194
4178
|
#
|
|
4195
|
-
#
|
|
4196
|
-
#
|
|
4179
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
|
4180
|
+
# 65536.
|
|
4197
4181
|
#
|
|
4198
|
-
#
|
|
4182
|
+
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
4199
4183
|
#
|
|
4200
|
-
#
|
|
4184
|
+
# : Constraints to the amount of storage for each storage type are the
|
|
4185
|
+
# following:
|
|
4201
4186
|
#
|
|
4202
|
-
#
|
|
4203
|
-
# following:
|
|
4187
|
+
# * General Purpose (SSD) storage (gp2, gp3):
|
|
4204
4188
|
#
|
|
4205
|
-
#
|
|
4206
|
-
#
|
|
4189
|
+
# * Enterprise and Standard editions: Must be an integer from 20 to
|
|
4190
|
+
# 16384.
|
|
4207
4191
|
#
|
|
4208
|
-
#
|
|
4209
|
-
# 65536.
|
|
4192
|
+
# * Web and Express editions: Must be an integer from 20 to 16384.
|
|
4210
4193
|
#
|
|
4211
|
-
#
|
|
4194
|
+
# * Provisioned IOPS storage (io1):
|
|
4212
4195
|
#
|
|
4213
|
-
#
|
|
4196
|
+
# * Enterprise and Standard editions: Must be an integer from 100 to
|
|
4197
|
+
# 16384.
|
|
4214
4198
|
#
|
|
4215
|
-
#
|
|
4216
|
-
# following:
|
|
4199
|
+
# * Web and Express editions: Must be an integer from 100 to 16384.
|
|
4217
4200
|
#
|
|
4218
|
-
#
|
|
4201
|
+
# * Magnetic storage (standard):
|
|
4219
4202
|
#
|
|
4220
|
-
#
|
|
4221
|
-
#
|
|
4203
|
+
# * Enterprise and Standard editions: Must be an integer from 20 to
|
|
4204
|
+
# 1024.
|
|
4222
4205
|
#
|
|
4223
|
-
#
|
|
4224
|
-
#
|
|
4225
|
-
# * Provisioned IOPS storage (io1):
|
|
4226
|
-
#
|
|
4227
|
-
# * Enterprise and Standard editions: Must be an integer from 100 to
|
|
4228
|
-
# 16384.
|
|
4229
|
-
#
|
|
4230
|
-
# * Web and Express editions: Must be an integer from 100 to 16384.
|
|
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.
|
|
4206
|
+
# * Web and Express editions: Must be an integer from 20 to 1024.
|
|
4238
4207
|
#
|
|
4239
4208
|
# @option params [required, String] :db_instance_class
|
|
4240
4209
|
# The compute and memory capacity of the DB instance, for example
|
|
4241
|
-
# db.m5.large
|
|
4210
|
+
# `db.m5.large`. Not all DB instance classes are available in all Amazon
|
|
4242
4211
|
# Web Services Regions, or for all database engines. For the full list
|
|
4243
4212
|
# of DB instance classes, and availability for your engine, see [DB
|
|
4244
4213
|
# instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
|
|
@@ -4250,9 +4219,9 @@ module Aws::RDS
|
|
|
4250
4219
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
|
|
4251
4220
|
#
|
|
4252
4221
|
# @option params [required, String] :engine
|
|
4253
|
-
# The
|
|
4222
|
+
# The database engine to use for this DB instance.
|
|
4254
4223
|
#
|
|
4255
|
-
# Not every database engine is available
|
|
4224
|
+
# Not every database engine is available in every Amazon Web Services
|
|
4256
4225
|
# Region.
|
|
4257
4226
|
#
|
|
4258
4227
|
# Valid Values:
|
|
@@ -4261,15 +4230,15 @@ module Aws::RDS
|
|
|
4261
4230
|
#
|
|
4262
4231
|
# * `aurora-postgresql` (for Aurora PostgreSQL DB instances)
|
|
4263
4232
|
#
|
|
4264
|
-
# * `custom-oracle-ee (for RDS Custom for Oracle DB instances)
|
|
4233
|
+
# * `custom-oracle-ee` (for RDS Custom for Oracle DB instances)
|
|
4265
4234
|
#
|
|
4266
|
-
# * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
|
|
4235
|
+
# * `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)
|
|
4267
4236
|
#
|
|
4268
|
-
# * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
|
|
4237
|
+
# * `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)
|
|
4269
4238
|
#
|
|
4270
|
-
# * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
|
|
4239
|
+
# * `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)
|
|
4271
4240
|
#
|
|
4272
|
-
# * `custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
|
|
4241
|
+
# * `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)
|
|
4273
4242
|
#
|
|
4274
4243
|
# * `mariadb`
|
|
4275
4244
|
#
|
|
@@ -4296,17 +4265,13 @@ module Aws::RDS
|
|
|
4296
4265
|
# @option params [String] :master_username
|
|
4297
4266
|
# The name for the master user.
|
|
4298
4267
|
#
|
|
4299
|
-
#
|
|
4268
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The name
|
|
4269
|
+
# for the master user is managed by the DB cluster.
|
|
4300
4270
|
#
|
|
4301
|
-
#
|
|
4302
|
-
# cluster.
|
|
4303
|
-
#
|
|
4304
|
-
# **Amazon RDS**
|
|
4271
|
+
# This setting is required for RDS DB instances.
|
|
4305
4272
|
#
|
|
4306
4273
|
# Constraints:
|
|
4307
4274
|
#
|
|
4308
|
-
# * Required.
|
|
4309
|
-
#
|
|
4310
4275
|
# * Must be 1 to 16 letters, numbers, or underscores.
|
|
4311
4276
|
#
|
|
4312
4277
|
# * First character must be a letter.
|
|
@@ -4314,36 +4279,30 @@ module Aws::RDS
|
|
|
4314
4279
|
# * Can't be a reserved word for the chosen database engine.
|
|
4315
4280
|
#
|
|
4316
4281
|
# @option params [String] :master_user_password
|
|
4317
|
-
# The password for the master user.
|
|
4318
|
-
# printable ASCII character except "/", """, or "@".
|
|
4319
|
-
#
|
|
4320
|
-
# **Amazon Aurora**
|
|
4282
|
+
# The password for the master user.
|
|
4321
4283
|
#
|
|
4322
|
-
#
|
|
4323
|
-
# cluster.
|
|
4284
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4285
|
+
# password for the master user is managed by the DB cluster.
|
|
4324
4286
|
#
|
|
4325
|
-
# Constraints:
|
|
4326
|
-
# turned on.
|
|
4327
|
-
#
|
|
4328
|
-
# **MariaDB**
|
|
4329
|
-
#
|
|
4330
|
-
# Constraints: Must contain from 8 to 41 characters.
|
|
4287
|
+
# Constraints:
|
|
4331
4288
|
#
|
|
4332
|
-
#
|
|
4289
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
|
4333
4290
|
#
|
|
4334
|
-
#
|
|
4291
|
+
# * Can include any printable ASCII character except "/", """, or
|
|
4292
|
+
# "@".
|
|
4335
4293
|
#
|
|
4336
|
-
#
|
|
4294
|
+
# Length Constraints:
|
|
4337
4295
|
#
|
|
4338
|
-
#
|
|
4296
|
+
# * RDS for MariaDB - Must contain from 8 to 41 characters.
|
|
4339
4297
|
#
|
|
4340
|
-
#
|
|
4298
|
+
# * RDS for Microsoft SQL Server - Must contain from 8 to 128
|
|
4299
|
+
# characters.
|
|
4341
4300
|
#
|
|
4342
|
-
#
|
|
4301
|
+
# * RDS for MySQL - Must contain from 8 to 41 characters.
|
|
4343
4302
|
#
|
|
4344
|
-
#
|
|
4303
|
+
# * RDS for Oracle - Must contain from 8 to 30 characters.
|
|
4345
4304
|
#
|
|
4346
|
-
#
|
|
4305
|
+
# * RDS for PostgreSQL - Must contain from 8 to 128 characters.
|
|
4347
4306
|
#
|
|
4348
4307
|
# @option params [Array<String>] :db_security_groups
|
|
4349
4308
|
# A list of DB security groups to associate with this DB instance.
|
|
@@ -4356,10 +4315,9 @@ module Aws::RDS
|
|
|
4356
4315
|
# A list of Amazon EC2 VPC security groups to associate with this DB
|
|
4357
4316
|
# instance.
|
|
4358
4317
|
#
|
|
4359
|
-
#
|
|
4360
|
-
#
|
|
4361
|
-
#
|
|
4362
|
-
# managed by the DB cluster.
|
|
4318
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4319
|
+
# associated list of EC2 VPC security groups is managed by the DB
|
|
4320
|
+
# cluster.
|
|
4363
4321
|
#
|
|
4364
4322
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
|
4365
4323
|
# VPC.
|
|
@@ -4369,22 +4327,23 @@ module Aws::RDS
|
|
|
4369
4327
|
# information on Amazon Web Services Regions and Availability Zones, see
|
|
4370
4328
|
# [Regions and Availability Zones][1].
|
|
4371
4329
|
#
|
|
4372
|
-
#
|
|
4373
|
-
#
|
|
4374
|
-
#
|
|
4375
|
-
# Availability
|
|
4376
|
-
# automatically chooses an appropriate Availability Zone if you don't
|
|
4377
|
-
# specify one.
|
|
4330
|
+
# For Amazon Aurora, each Aurora DB cluster hosts copies of its storage
|
|
4331
|
+
# in three separate Availability Zones. Specify one of these
|
|
4332
|
+
# Availability Zones. Aurora automatically chooses an appropriate
|
|
4333
|
+
# Availability Zone if you don't specify one.
|
|
4378
4334
|
#
|
|
4379
4335
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
|
4380
4336
|
# Amazon Web Services Region.
|
|
4381
4337
|
#
|
|
4382
|
-
#
|
|
4338
|
+
# Constraints:
|
|
4383
4339
|
#
|
|
4384
|
-
#
|
|
4385
|
-
#
|
|
4386
|
-
#
|
|
4387
|
-
#
|
|
4340
|
+
# * The `AvailabilityZone` parameter can't be specified if the DB
|
|
4341
|
+
# instance is a Multi-AZ deployment.
|
|
4342
|
+
#
|
|
4343
|
+
# * The specified Availability Zone must be in the same Amazon Web
|
|
4344
|
+
# Services Region as the current endpoint.
|
|
4345
|
+
#
|
|
4346
|
+
# Example: `us-east-1d`
|
|
4388
4347
|
#
|
|
4389
4348
|
#
|
|
4390
4349
|
#
|
|
@@ -4393,25 +4352,34 @@ module Aws::RDS
|
|
|
4393
4352
|
# @option params [String] :db_subnet_group_name
|
|
4394
4353
|
# A DB subnet group to associate with this DB instance.
|
|
4395
4354
|
#
|
|
4396
|
-
# Constraints:
|
|
4397
|
-
#
|
|
4355
|
+
# Constraints:
|
|
4356
|
+
#
|
|
4357
|
+
# * Must match the name of an existing DB subnet group.
|
|
4358
|
+
#
|
|
4359
|
+
# * Must not be `default`.
|
|
4398
4360
|
#
|
|
4399
4361
|
# Example: `mydbsubnetgroup`
|
|
4400
4362
|
#
|
|
4401
4363
|
# @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`
|
|
4364
|
+
# The time range each week during which system maintenance can occur.
|
|
4365
|
+
# For more information, see [Amazon RDS Maintenance Window][1] in the
|
|
4366
|
+
# *Amazon RDS User Guide.*
|
|
4407
4367
|
#
|
|
4408
4368
|
# The default is a 30-minute window selected at random from an 8-hour
|
|
4409
4369
|
# block of time for each Amazon Web Services Region, occurring on a
|
|
4410
4370
|
# random day of the week.
|
|
4411
4371
|
#
|
|
4412
|
-
#
|
|
4372
|
+
# Constraints:
|
|
4413
4373
|
#
|
|
4414
|
-
#
|
|
4374
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
|
4375
|
+
#
|
|
4376
|
+
# * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
|
|
4377
|
+
#
|
|
4378
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
4379
|
+
#
|
|
4380
|
+
# * Must not conflict with the preferred backup window.
|
|
4381
|
+
#
|
|
4382
|
+
# * Must be at least 30 minutes.
|
|
4415
4383
|
#
|
|
4416
4384
|
#
|
|
4417
4385
|
#
|
|
@@ -4419,38 +4387,36 @@ module Aws::RDS
|
|
|
4419
4387
|
#
|
|
4420
4388
|
# @option params [String] :db_parameter_group_name
|
|
4421
4389
|
# The name of the DB parameter group to associate with this DB instance.
|
|
4422
|
-
# If you
|
|
4423
|
-
# the specified DB engine and version
|
|
4390
|
+
# If you don't specify a value, then Amazon RDS uses the default DB
|
|
4391
|
+
# parameter group for the specified DB engine and version.
|
|
4424
4392
|
#
|
|
4425
|
-
# This setting doesn't apply to RDS Custom.
|
|
4393
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4426
4394
|
#
|
|
4427
4395
|
# Constraints:
|
|
4428
4396
|
#
|
|
4429
|
-
# *
|
|
4397
|
+
# * Must be 1 to 255 letters, numbers, or hyphens.
|
|
4430
4398
|
#
|
|
4431
4399
|
# * The first character must be a letter.
|
|
4432
4400
|
#
|
|
4433
|
-
# *
|
|
4401
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
|
4434
4402
|
#
|
|
4435
4403
|
# @option params [Integer] :backup_retention_period
|
|
4436
4404
|
# The number of days for which automated backups are retained. Setting
|
|
4437
4405
|
# this parameter to a positive number enables backups. Setting this
|
|
4438
|
-
# parameter to 0 disables automated backups.
|
|
4439
|
-
#
|
|
4440
|
-
# **Amazon Aurora**
|
|
4406
|
+
# parameter to `0` disables automated backups.
|
|
4441
4407
|
#
|
|
4442
|
-
#
|
|
4443
|
-
# by the DB cluster.
|
|
4408
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4409
|
+
# retention period for automated backups is managed by the DB cluster.
|
|
4444
4410
|
#
|
|
4445
|
-
# Default: 1
|
|
4411
|
+
# Default: `1`
|
|
4446
4412
|
#
|
|
4447
4413
|
# Constraints:
|
|
4448
4414
|
#
|
|
4449
|
-
# * Must be a value from 0 to 35
|
|
4415
|
+
# * Must be a value from 0 to 35.
|
|
4450
4416
|
#
|
|
4451
|
-
# * Can't be set to 0 if the DB instance is a source to read replicas
|
|
4417
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas.
|
|
4452
4418
|
#
|
|
4453
|
-
# * Can't be set to 0 for an RDS Custom for Oracle DB instance
|
|
4419
|
+
# * Can't be set to 0 for an RDS Custom for Oracle DB instance.
|
|
4454
4420
|
#
|
|
4455
4421
|
# @option params [String] :preferred_backup_window
|
|
4456
4422
|
# The daily time range during which automated backups are created if
|
|
@@ -4459,10 +4425,9 @@ module Aws::RDS
|
|
|
4459
4425
|
# an 8-hour block of time for each Amazon Web Services Region. For more
|
|
4460
4426
|
# information, see [Backup window][1] in the *Amazon RDS User Guide*.
|
|
4461
4427
|
#
|
|
4462
|
-
#
|
|
4463
|
-
#
|
|
4464
|
-
#
|
|
4465
|
-
# managed by the DB cluster.
|
|
4428
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The daily
|
|
4429
|
+
# time range for creating automated backups is managed by the DB
|
|
4430
|
+
# cluster.
|
|
4466
4431
|
#
|
|
4467
4432
|
# Constraints:
|
|
4468
4433
|
#
|
|
@@ -4481,66 +4446,49 @@ module Aws::RDS
|
|
|
4481
4446
|
# @option params [Integer] :port
|
|
4482
4447
|
# The port number on which the database accepts connections.
|
|
4483
4448
|
#
|
|
4484
|
-
#
|
|
4485
|
-
#
|
|
4486
|
-
# Default: `3306`
|
|
4487
|
-
#
|
|
4488
|
-
# Valid values: `1150-65535`
|
|
4489
|
-
#
|
|
4490
|
-
# Type: Integer
|
|
4449
|
+
# This setting doesn't apply to Aurora DB instances. The port number is
|
|
4450
|
+
# managed by the cluster.
|
|
4491
4451
|
#
|
|
4492
|
-
#
|
|
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`
|
|
4505
|
-
#
|
|
4506
|
-
# Type: Integer
|
|
4507
|
-
#
|
|
4508
|
-
# **Oracle**
|
|
4452
|
+
# Valid Values: `1150-65535`
|
|
4509
4453
|
#
|
|
4510
|
-
# Default:
|
|
4454
|
+
# Default:
|
|
4511
4455
|
#
|
|
4512
|
-
#
|
|
4456
|
+
# * RDS for MariaDB - `3306`
|
|
4513
4457
|
#
|
|
4514
|
-
#
|
|
4458
|
+
# * RDS for Microsoft SQL Server - `1433`
|
|
4515
4459
|
#
|
|
4516
|
-
#
|
|
4460
|
+
# * RDS for MySQL - `3306`
|
|
4517
4461
|
#
|
|
4518
|
-
#
|
|
4519
|
-
# `3389`, `47001`, and `49152-49156`.
|
|
4462
|
+
# * RDS for Oracle - `1521`
|
|
4520
4463
|
#
|
|
4521
|
-
#
|
|
4464
|
+
# * RDS for PostgreSQL - `5432`
|
|
4522
4465
|
#
|
|
4523
|
-
#
|
|
4466
|
+
# Constraints:
|
|
4524
4467
|
#
|
|
4525
|
-
#
|
|
4468
|
+
# * For RDS for Microsoft SQL Server, the value can't be `1234`,
|
|
4469
|
+
# `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
|
|
4526
4470
|
#
|
|
4527
|
-
#
|
|
4471
|
+
# ^
|
|
4528
4472
|
#
|
|
4529
4473
|
# @option params [Boolean] :multi_az
|
|
4530
|
-
#
|
|
4531
|
-
#
|
|
4532
|
-
#
|
|
4474
|
+
# Specifies whether the DB instance is a Multi-AZ deployment. You can't
|
|
4475
|
+
# set the `AvailabilityZone` parameter if the DB instance is a Multi-AZ
|
|
4476
|
+
# deployment.
|
|
4533
4477
|
#
|
|
4534
|
-
# This setting doesn't apply to
|
|
4478
|
+
# This setting doesn't apply to the following DB instances:
|
|
4535
4479
|
#
|
|
4536
|
-
#
|
|
4480
|
+
# * Amazon Aurora (DB instance Availability Zones (AZs) are managed by
|
|
4481
|
+
# the DB cluster.)
|
|
4537
4482
|
#
|
|
4538
|
-
#
|
|
4539
|
-
# the DB cluster.
|
|
4483
|
+
# * RDS Custom
|
|
4540
4484
|
#
|
|
4541
4485
|
# @option params [String] :engine_version
|
|
4542
4486
|
# The version number of the database engine to use.
|
|
4543
4487
|
#
|
|
4488
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The version
|
|
4489
|
+
# number of the database engine the DB instance uses is managed by the
|
|
4490
|
+
# DB cluster.
|
|
4491
|
+
#
|
|
4544
4492
|
# For a list of valid engine versions, use the
|
|
4545
4493
|
# `DescribeDBEngineVersions` operation.
|
|
4546
4494
|
#
|
|
@@ -4549,48 +4497,37 @@ module Aws::RDS
|
|
|
4549
4497
|
# every database engine is available for every Amazon Web Services
|
|
4550
4498
|
# Region.
|
|
4551
4499
|
#
|
|
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**
|
|
4500
|
+
# Amazon RDS Custom for Oracle
|
|
4501
|
+
# Amazon RDS Custom for SQL Server
|
|
4502
|
+
# RDS for MariaDB
|
|
4503
|
+
# RDS for Microsoft SQL Server
|
|
4504
|
+
# RDS for MySQL
|
|
4505
|
+
# RDS for Oracle
|
|
4506
|
+
# RDS for PostgreSQL
|
|
4507
|
+
#
|
|
4508
|
+
# : A custom engine version (CEV) that you have previously created. This
|
|
4509
|
+
# setting is required for RDS Custom for Oracle. The CEV name has the
|
|
4510
|
+
# following format: 19.*customized\_string*. A valid CEV name is
|
|
4511
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom for
|
|
4512
|
+
# Oracle DB instance][1] in the *Amazon RDS User Guide*.
|
|
4513
|
+
#
|
|
4514
|
+
# : See [RDS Custom for SQL Server general requirements][2] in the
|
|
4515
|
+
# *Amazon RDS User Guide*.
|
|
4581
4516
|
#
|
|
4582
|
-
# For information, see [
|
|
4583
|
-
#
|
|
4517
|
+
# : For information, see [MariaDB on Amazon RDS versions][3] in the
|
|
4518
|
+
# *Amazon RDS User Guide*.
|
|
4584
4519
|
#
|
|
4585
|
-
#
|
|
4520
|
+
# : For information, see [Microsoft SQL Server versions on Amazon
|
|
4521
|
+
# RDS][4] in the *Amazon RDS User Guide*.
|
|
4586
4522
|
#
|
|
4587
|
-
# For information, see [
|
|
4588
|
-
#
|
|
4523
|
+
# : For information, see [MySQL on Amazon RDS versions][5] in the
|
|
4524
|
+
# *Amazon RDS User Guide*.
|
|
4589
4525
|
#
|
|
4590
|
-
#
|
|
4526
|
+
# : For information, see [Oracle Database Engine release notes][6] in
|
|
4527
|
+
# the *Amazon RDS User Guide*.
|
|
4591
4528
|
#
|
|
4592
|
-
# For information, see [Amazon RDS for PostgreSQL versions and
|
|
4593
|
-
#
|
|
4529
|
+
# : For information, see [Amazon RDS for PostgreSQL versions and
|
|
4530
|
+
# extensions][7] in the *Amazon RDS User Guide*.
|
|
4594
4531
|
#
|
|
4595
4532
|
#
|
|
4596
4533
|
#
|
|
@@ -4603,78 +4540,83 @@ module Aws::RDS
|
|
|
4603
4540
|
# [7]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
|
4604
4541
|
#
|
|
4605
4542
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
4606
|
-
#
|
|
4607
|
-
#
|
|
4608
|
-
#
|
|
4543
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
|
4544
|
+
# the DB instance during the maintenance window. By default, minor
|
|
4545
|
+
# engine upgrades are applied automatically.
|
|
4609
4546
|
#
|
|
4610
4547
|
# If you create an RDS Custom DB instance, you must set
|
|
4611
4548
|
# `AutoMinorVersionUpgrade` to `false`.
|
|
4612
4549
|
#
|
|
4613
4550
|
# @option params [String] :license_model
|
|
4614
|
-
#
|
|
4551
|
+
# The license model information for this DB instance.
|
|
4615
4552
|
#
|
|
4616
|
-
#
|
|
4617
|
-
#
|
|
4553
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4554
|
+
# instances.
|
|
4618
4555
|
#
|
|
4619
|
-
#
|
|
4556
|
+
# Valid Values:
|
|
4557
|
+
#
|
|
4558
|
+
# * RDS for MariaDB - `general-public-license`
|
|
4559
|
+
#
|
|
4560
|
+
# * RDS for Microsoft SQL Server - `license-included`
|
|
4620
4561
|
#
|
|
4621
|
-
#
|
|
4562
|
+
# * RDS for MySQL - `general-public-license`
|
|
4622
4563
|
#
|
|
4623
|
-
#
|
|
4564
|
+
# * RDS for Oracle - `bring-your-own-license | license-included`
|
|
4565
|
+
#
|
|
4566
|
+
# * RDS for PostgreSQL - `postgresql-license`
|
|
4624
4567
|
#
|
|
4625
4568
|
# @option params [Integer] :iops
|
|
4626
4569
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
|
4627
|
-
#
|
|
4628
|
-
#
|
|
4629
|
-
#
|
|
4570
|
+
# initially allocate for the DB instance. For information about valid
|
|
4571
|
+
# IOPS values, see [Amazon RDS DB instance storage][1] in the *Amazon
|
|
4572
|
+
# RDS User Guide*.
|
|
4630
4573
|
#
|
|
4631
|
-
#
|
|
4632
|
-
#
|
|
4633
|
-
#
|
|
4634
|
-
#
|
|
4574
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Storage is
|
|
4575
|
+
# managed by the DB cluster.
|
|
4576
|
+
#
|
|
4577
|
+
# Constraints:
|
|
4635
4578
|
#
|
|
4636
|
-
#
|
|
4579
|
+
# * For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a
|
|
4580
|
+
# multiple between .5 and 50 of the storage amount for the DB
|
|
4581
|
+
# instance.
|
|
4637
4582
|
#
|
|
4638
|
-
#
|
|
4583
|
+
# * For RDS for SQL Server - Must be a multiple between 1 and 50 of the
|
|
4584
|
+
# storage amount for the DB instance.
|
|
4639
4585
|
#
|
|
4640
4586
|
#
|
|
4641
4587
|
#
|
|
4642
4588
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
|
|
4643
4589
|
#
|
|
4644
4590
|
# @option params [String] :option_group_name
|
|
4645
|
-
#
|
|
4646
|
-
# the specified option group.
|
|
4591
|
+
# The option group to associate the DB instance with.
|
|
4647
4592
|
#
|
|
4648
4593
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
|
4649
4594
|
# TDE, can't be removed from an option group. Also, that option group
|
|
4650
4595
|
# can't be removed from a DB instance after it is associated with a DB
|
|
4651
4596
|
# instance.
|
|
4652
4597
|
#
|
|
4653
|
-
# This setting doesn't apply to RDS Custom
|
|
4654
|
-
#
|
|
4655
|
-
# **Amazon Aurora**
|
|
4656
|
-
#
|
|
4657
|
-
# Not applicable.
|
|
4598
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4599
|
+
# instances.
|
|
4658
4600
|
#
|
|
4659
4601
|
# @option params [String] :character_set_name
|
|
4660
|
-
# For supported engines,
|
|
4661
|
-
#
|
|
4602
|
+
# For supported engines, the character set (`CharacterSet`) to associate
|
|
4603
|
+
# the DB instance with.
|
|
4662
4604
|
#
|
|
4663
|
-
# This setting doesn't apply to
|
|
4664
|
-
# change the character set, you can change it on the database itself.
|
|
4605
|
+
# This setting doesn't apply to the following DB instances:
|
|
4665
4606
|
#
|
|
4666
|
-
#
|
|
4607
|
+
# * Amazon Aurora - The character set is managed by the DB cluster. For
|
|
4608
|
+
# more information, see `CreateDBCluster`.
|
|
4667
4609
|
#
|
|
4668
|
-
#
|
|
4669
|
-
#
|
|
4610
|
+
# * RDS Custom - However, if you need to change the character set, you
|
|
4611
|
+
# can change it on the database itself.
|
|
4670
4612
|
#
|
|
4671
4613
|
# @option params [String] :nchar_character_set_name
|
|
4672
4614
|
# The name of the NCHAR character set for the Oracle DB instance.
|
|
4673
4615
|
#
|
|
4674
|
-
# This
|
|
4616
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4675
4617
|
#
|
|
4676
4618
|
# @option params [Boolean] :publicly_accessible
|
|
4677
|
-
#
|
|
4619
|
+
# Specifies whether the DB instance is publicly accessible.
|
|
4678
4620
|
#
|
|
4679
4621
|
# When the DB instance is publicly accessible, its Domain Name System
|
|
4680
4622
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
|
@@ -4712,51 +4654,46 @@ module Aws::RDS
|
|
|
4712
4654
|
# Tags to assign to the DB instance.
|
|
4713
4655
|
#
|
|
4714
4656
|
# @option params [String] :db_cluster_identifier
|
|
4715
|
-
# The identifier of the DB cluster that
|
|
4657
|
+
# The identifier of the DB cluster that this DB instance will belong to.
|
|
4716
4658
|
#
|
|
4717
|
-
# This setting doesn't apply to RDS Custom.
|
|
4659
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4718
4660
|
#
|
|
4719
4661
|
# @option params [String] :storage_type
|
|
4720
|
-
#
|
|
4721
|
-
#
|
|
4722
|
-
# Valid values: `gp2 | gp3 | io1 | standard`
|
|
4662
|
+
# The storage type to associate with the DB instance.
|
|
4723
4663
|
#
|
|
4724
4664
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
|
4725
4665
|
# `Iops` parameter.
|
|
4726
4666
|
#
|
|
4727
|
-
#
|
|
4667
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Storage is
|
|
4668
|
+
# managed by the DB cluster.
|
|
4728
4669
|
#
|
|
4729
|
-
#
|
|
4670
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
|
4730
4671
|
#
|
|
4731
|
-
#
|
|
4672
|
+
# Default: `io1`, if the `Iops` parameter is specified. Otherwise,
|
|
4673
|
+
# `gp2`.
|
|
4732
4674
|
#
|
|
4733
4675
|
# @option params [String] :tde_credential_arn
|
|
4734
4676
|
# The ARN from the key store with which to associate the instance for
|
|
4735
4677
|
# TDE encryption.
|
|
4736
4678
|
#
|
|
4737
|
-
# This setting doesn't apply to RDS Custom
|
|
4738
|
-
#
|
|
4739
|
-
# **Amazon Aurora**
|
|
4740
|
-
#
|
|
4741
|
-
# Not applicable.
|
|
4679
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4680
|
+
# instances.
|
|
4742
4681
|
#
|
|
4743
4682
|
# @option params [String] :tde_credential_password
|
|
4744
4683
|
# The password for the given ARN from the key store in order to access
|
|
4745
4684
|
# the device.
|
|
4746
4685
|
#
|
|
4747
|
-
# This setting doesn't apply to RDS Custom.
|
|
4686
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4748
4687
|
#
|
|
4749
4688
|
# @option params [Boolean] :storage_encrypted
|
|
4750
|
-
#
|
|
4751
|
-
#
|
|
4689
|
+
# Specifes whether the DB instance is encrypted. By default, it isn't
|
|
4690
|
+
# encrypted.
|
|
4752
4691
|
#
|
|
4753
|
-
# For RDS Custom instances, either
|
|
4754
|
-
#
|
|
4692
|
+
# For RDS Custom DB instances, either enable this setting or leave it
|
|
4693
|
+
# unset. Otherwise, Amazon RDS reports an error.
|
|
4755
4694
|
#
|
|
4756
|
-
#
|
|
4757
|
-
#
|
|
4758
|
-
# Not applicable. The encryption for DB instances is managed by the DB
|
|
4759
|
-
# cluster.
|
|
4695
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
4696
|
+
# encryption for DB instances is managed by the DB cluster.
|
|
4760
4697
|
#
|
|
4761
4698
|
# @option params [String] :kms_key_id
|
|
4762
4699
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
|
@@ -4767,10 +4704,9 @@ module Aws::RDS
|
|
|
4767
4704
|
# different Amazon Web Services account, specify the key ARN or alias
|
|
4768
4705
|
# ARN.
|
|
4769
4706
|
#
|
|
4770
|
-
#
|
|
4771
|
-
#
|
|
4772
|
-
#
|
|
4773
|
-
# by the DB cluster. For more information, see `CreateDBCluster`.
|
|
4707
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The Amazon
|
|
4708
|
+
# Web Services KMS key identifier is managed by the DB cluster. For more
|
|
4709
|
+
# information, see `CreateDBCluster`.
|
|
4774
4710
|
#
|
|
4775
4711
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
|
4776
4712
|
# the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
|
|
@@ -4778,53 +4714,96 @@ module Aws::RDS
|
|
|
4778
4714
|
# Amazon Web Services account has a different default KMS key for each
|
|
4779
4715
|
# Amazon Web Services Region.
|
|
4780
4716
|
#
|
|
4781
|
-
#
|
|
4782
|
-
#
|
|
4783
|
-
#
|
|
4784
|
-
#
|
|
4785
|
-
#
|
|
4786
|
-
# the default key when this parameter is empty. You must explicitly
|
|
4787
|
-
# specify a key.
|
|
4717
|
+
# For Amazon RDS Custom, a KMS key is required for DB instances. For
|
|
4718
|
+
# most RDS engines, if you leave this parameter empty while enabling
|
|
4719
|
+
# `StorageEncrypted`, the engine uses the default KMS key. However, RDS
|
|
4720
|
+
# Custom doesn't use the default key when this parameter is empty. You
|
|
4721
|
+
# must explicitly specify a key.
|
|
4788
4722
|
#
|
|
4789
4723
|
# @option params [String] :domain
|
|
4790
4724
|
# The Active Directory directory ID to create the DB instance in.
|
|
4791
|
-
# Currently, only
|
|
4725
|
+
# Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB
|
|
4792
4726
|
# instances can be created in an Active Directory Domain.
|
|
4793
4727
|
#
|
|
4794
4728
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
|
4795
4729
|
# RDS User Guide*.
|
|
4796
4730
|
#
|
|
4797
|
-
# This setting doesn't apply to
|
|
4731
|
+
# This setting doesn't apply to the following DB instances:
|
|
4798
4732
|
#
|
|
4799
|
-
#
|
|
4733
|
+
# * Amazon Aurora (The domain is managed by the DB cluster.)
|
|
4800
4734
|
#
|
|
4801
|
-
#
|
|
4735
|
+
# * RDS Custom
|
|
4802
4736
|
#
|
|
4803
4737
|
#
|
|
4804
4738
|
#
|
|
4805
4739
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
|
4806
4740
|
#
|
|
4807
|
-
# @option params [
|
|
4808
|
-
#
|
|
4809
|
-
#
|
|
4741
|
+
# @option params [String] :domain_fqdn
|
|
4742
|
+
# Specifies the fully qualified domain name of an Active Directory
|
|
4743
|
+
# domain.
|
|
4744
|
+
#
|
|
4745
|
+
# Constraints:
|
|
4810
4746
|
#
|
|
4811
|
-
#
|
|
4747
|
+
# * Cannot be greater than 64 characters.
|
|
4812
4748
|
#
|
|
4813
|
-
#
|
|
4814
|
-
#
|
|
4815
|
-
#
|
|
4749
|
+
# ^
|
|
4750
|
+
#
|
|
4751
|
+
# Example: `mymanagedADtest.mymanagedAD.mydomain`
|
|
4752
|
+
#
|
|
4753
|
+
# @option params [String] :domain_ou
|
|
4754
|
+
# The Active Directory organizational unit for your DB instance to join.
|
|
4755
|
+
#
|
|
4756
|
+
# Constraints:
|
|
4757
|
+
#
|
|
4758
|
+
# * Must be in the distinguished name format.
|
|
4759
|
+
#
|
|
4760
|
+
# * Cannot be greater than 64 characters.
|
|
4761
|
+
#
|
|
4762
|
+
# Example:
|
|
4763
|
+
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
|
4764
|
+
#
|
|
4765
|
+
# @option params [String] :domain_auth_secret_arn
|
|
4766
|
+
# The ARN for the Secrets Manager secret that contains the credentials
|
|
4767
|
+
# for the user performing the domain join.
|
|
4768
|
+
#
|
|
4769
|
+
# Example:
|
|
4770
|
+
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
|
4771
|
+
#
|
|
4772
|
+
# @option params [Array<String>] :domain_dns_ips
|
|
4773
|
+
# The IPv4 DNS IP addresses of your primary and secondary Active
|
|
4774
|
+
# Directory domain controllers.
|
|
4775
|
+
#
|
|
4776
|
+
# Constraints:
|
|
4777
|
+
#
|
|
4778
|
+
# * Two IP addresses must be provided. If there isn't a secondary
|
|
4779
|
+
# domain controller, use the IP address of the primary domain
|
|
4780
|
+
# controller for both entries in the list.
|
|
4781
|
+
#
|
|
4782
|
+
# ^
|
|
4783
|
+
#
|
|
4784
|
+
# Example: `123.124.125.126,234.235.236.237`
|
|
4785
|
+
#
|
|
4786
|
+
# @option params [Boolean] :copy_tags_to_snapshot
|
|
4787
|
+
# Spcifies whether to copy tags from the DB instance to snapshots of the
|
|
4788
|
+
# DB instance. By default, tags are not copied.
|
|
4789
|
+
#
|
|
4790
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Copying
|
|
4791
|
+
# tags to snapshots is managed by the DB cluster. Setting this value for
|
|
4792
|
+
# an Aurora DB instance has no effect on the DB cluster setting.
|
|
4816
4793
|
#
|
|
4817
4794
|
# @option params [Integer] :monitoring_interval
|
|
4818
4795
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
4819
4796
|
# metrics are collected for the DB instance. To disable collection of
|
|
4820
|
-
# Enhanced Monitoring metrics, specify 0
|
|
4797
|
+
# Enhanced Monitoring metrics, specify `0`.
|
|
4821
4798
|
#
|
|
4822
4799
|
# If `MonitoringRoleArn` is specified, then you must set
|
|
4823
|
-
# `MonitoringInterval` to a value other than 0
|
|
4800
|
+
# `MonitoringInterval` to a value other than `0`.
|
|
4824
4801
|
#
|
|
4825
|
-
# This setting doesn't apply to RDS Custom.
|
|
4802
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4826
4803
|
#
|
|
4827
|
-
# Valid Values: `0
|
|
4804
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
|
4805
|
+
#
|
|
4806
|
+
# Default: `0`
|
|
4828
4807
|
#
|
|
4829
4808
|
# @option params [String] :monitoring_role_arn
|
|
4830
4809
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
|
@@ -4833,40 +4812,40 @@ module Aws::RDS
|
|
|
4833
4812
|
# a monitoring role, see [Setting Up and Enabling Enhanced
|
|
4834
4813
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
|
4835
4814
|
#
|
|
4836
|
-
# If `MonitoringInterval` is set to a value other than 0
|
|
4837
|
-
# supply a `MonitoringRoleArn` value.
|
|
4815
|
+
# If `MonitoringInterval` is set to a value other than `0`, then you
|
|
4816
|
+
# must supply a `MonitoringRoleArn` value.
|
|
4838
4817
|
#
|
|
4839
|
-
# This setting doesn't apply to RDS Custom.
|
|
4818
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4840
4819
|
#
|
|
4841
4820
|
#
|
|
4842
4821
|
#
|
|
4843
4822
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
|
4844
4823
|
#
|
|
4845
4824
|
# @option params [String] :domain_iam_role_name
|
|
4846
|
-
#
|
|
4847
|
-
#
|
|
4825
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
4826
|
+
# Service.
|
|
4848
4827
|
#
|
|
4849
|
-
# This setting doesn't apply to
|
|
4828
|
+
# This setting doesn't apply to the following DB instances:
|
|
4850
4829
|
#
|
|
4851
|
-
#
|
|
4830
|
+
# * Amazon Aurora (The domain is managed by the DB cluster.)
|
|
4852
4831
|
#
|
|
4853
|
-
#
|
|
4832
|
+
# * RDS Custom
|
|
4854
4833
|
#
|
|
4855
4834
|
# @option params [Integer] :promotion_tier
|
|
4856
|
-
#
|
|
4857
|
-
#
|
|
4858
|
-
#
|
|
4859
|
-
#
|
|
4835
|
+
# The order of priority in which an Aurora Replica is promoted to the
|
|
4836
|
+
# primary instance after a failure of the existing primary instance. For
|
|
4837
|
+
# more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
|
|
4838
|
+
# in the *Amazon Aurora User Guide*.
|
|
4860
4839
|
#
|
|
4861
|
-
# This setting doesn't apply to RDS Custom.
|
|
4840
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4862
4841
|
#
|
|
4863
|
-
# Default: 1
|
|
4842
|
+
# Default: `1`
|
|
4864
4843
|
#
|
|
4865
|
-
# Valid Values: 0 - 15
|
|
4844
|
+
# Valid Values: `0 - 15`
|
|
4866
4845
|
#
|
|
4867
4846
|
#
|
|
4868
4847
|
#
|
|
4869
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
|
4848
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
|
|
4870
4849
|
#
|
|
4871
4850
|
# @option params [String] :timezone
|
|
4872
4851
|
# The time zone of the DB instance. The time zone parameter is currently
|
|
@@ -4877,30 +4856,30 @@ module Aws::RDS
|
|
|
4877
4856
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
|
4878
4857
|
#
|
|
4879
4858
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
4880
|
-
#
|
|
4881
|
-
#
|
|
4882
|
-
#
|
|
4859
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
|
4860
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
|
4861
|
+
# mapping isn't enabled.
|
|
4883
4862
|
#
|
|
4884
4863
|
# For more information, see [ IAM Database Authentication for MySQL and
|
|
4885
4864
|
# PostgreSQL][1] in the *Amazon RDS User Guide*.
|
|
4886
4865
|
#
|
|
4887
|
-
# This setting doesn't apply to
|
|
4866
|
+
# This setting doesn't apply to the following DB instances:
|
|
4888
4867
|
#
|
|
4889
|
-
#
|
|
4868
|
+
# * Amazon Aurora (Mapping Amazon Web Services IAM accounts to database
|
|
4869
|
+
# accounts is managed by the DB cluster.)
|
|
4890
4870
|
#
|
|
4891
|
-
#
|
|
4892
|
-
# accounts is managed by the DB cluster.
|
|
4871
|
+
# * RDS Custom
|
|
4893
4872
|
#
|
|
4894
4873
|
#
|
|
4895
4874
|
#
|
|
4896
4875
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
|
4897
4876
|
#
|
|
4898
4877
|
# @option params [Boolean] :enable_performance_insights
|
|
4899
|
-
#
|
|
4900
|
-
#
|
|
4901
|
-
#
|
|
4878
|
+
# Specifies whether to enable Performance Insights for the DB instance.
|
|
4879
|
+
# For more information, see [Using Amazon Performance Insights][1] in
|
|
4880
|
+
# the *Amazon RDS User Guide*.
|
|
4902
4881
|
#
|
|
4903
|
-
# This setting doesn't apply to RDS Custom.
|
|
4882
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4904
4883
|
#
|
|
4905
4884
|
#
|
|
4906
4885
|
#
|
|
@@ -4913,99 +4892,79 @@ module Aws::RDS
|
|
|
4913
4892
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
|
4914
4893
|
# alias ARN, or alias name for the KMS key.
|
|
4915
4894
|
#
|
|
4916
|
-
# If you
|
|
4895
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
|
4917
4896
|
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
|
4918
4897
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
|
4919
4898
|
# a different default KMS key for each Amazon Web Services Region.
|
|
4920
4899
|
#
|
|
4921
|
-
# This setting doesn't apply to RDS Custom.
|
|
4900
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4922
4901
|
#
|
|
4923
4902
|
# @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:
|
|
4926
|
-
#
|
|
4927
|
-
# * 7
|
|
4928
|
-
#
|
|
4929
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
|
4903
|
+
# The number of days to retain Performance Insights data.
|
|
4930
4904
|
#
|
|
4931
|
-
#
|
|
4905
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4932
4906
|
#
|
|
4933
|
-
#
|
|
4907
|
+
# Valid Values:
|
|
4934
4908
|
#
|
|
4935
|
-
# *
|
|
4909
|
+
# * `7`
|
|
4936
4910
|
#
|
|
4937
|
-
# *
|
|
4911
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
|
4912
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
|
4913
|
+
# months * 31)
|
|
4938
4914
|
#
|
|
4939
|
-
# *
|
|
4940
|
-
#
|
|
4941
|
-
# * 731
|
|
4915
|
+
# * `731`
|
|
4942
4916
|
#
|
|
4943
|
-
#
|
|
4944
|
-
# value, RDS issues an error.
|
|
4917
|
+
# Default: `7` days
|
|
4945
4918
|
#
|
|
4946
|
-
#
|
|
4919
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
|
4920
|
+
# Amazon RDS returns an error.
|
|
4947
4921
|
#
|
|
4948
4922
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
|
4949
4923
|
# 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**
|
|
4924
|
+
# CloudWatch Logs. For more information, see [ Publishing Database Logs
|
|
4925
|
+
# to Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
|
4955
4926
|
#
|
|
4956
|
-
#
|
|
4927
|
+
# This setting doesn't apply to the following DB instances:
|
|
4957
4928
|
#
|
|
4958
|
-
#
|
|
4929
|
+
# * Amazon Aurora (CloudWatch Logs exports are managed by the DB
|
|
4930
|
+
# cluster.)
|
|
4959
4931
|
#
|
|
4960
|
-
#
|
|
4932
|
+
# * RDS Custom
|
|
4961
4933
|
#
|
|
4962
|
-
#
|
|
4934
|
+
# The following values are valid for each DB engine:
|
|
4963
4935
|
#
|
|
4964
|
-
#
|
|
4936
|
+
# * RDS for MariaDB - `audit | error | general | slowquery`
|
|
4965
4937
|
#
|
|
4966
|
-
#
|
|
4938
|
+
# * RDS for Microsoft SQL Server - `agent | error`
|
|
4967
4939
|
#
|
|
4968
|
-
#
|
|
4940
|
+
# * RDS for MySQL - `audit | error | general | slowquery`
|
|
4969
4941
|
#
|
|
4970
|
-
#
|
|
4971
|
-
#
|
|
4972
|
-
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
|
4973
|
-
#
|
|
4974
|
-
# **Oracle**
|
|
4975
|
-
#
|
|
4976
|
-
# Possible values are `alert`, `audit`, `listener`, `trace`, and
|
|
4977
|
-
# `oemagent`.
|
|
4978
|
-
#
|
|
4979
|
-
# **PostgreSQL**
|
|
4942
|
+
# * RDS for Oracle - `alert | audit | listener | trace | oemagent`
|
|
4980
4943
|
#
|
|
4981
|
-
#
|
|
4944
|
+
# * RDS for PostgreSQL - `postgresql | upgrade`
|
|
4982
4945
|
#
|
|
4983
4946
|
#
|
|
4984
4947
|
#
|
|
4985
4948
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
|
4986
4949
|
#
|
|
4987
|
-
# @option params [Array<Types::ProcessorFeature>] :processor_features
|
|
4988
|
-
# The number of CPU cores and the number of threads per core for the DB
|
|
4989
|
-
# instance class of the DB instance.
|
|
4990
|
-
#
|
|
4991
|
-
# This setting doesn't apply to RDS Custom
|
|
4992
|
-
#
|
|
4993
|
-
# **Amazon Aurora**
|
|
4994
|
-
#
|
|
4995
|
-
# Not applicable.
|
|
4996
|
-
#
|
|
4997
|
-
# @option params [Boolean] :deletion_protection
|
|
4998
|
-
# A value that indicates whether the DB instance has deletion protection
|
|
4999
|
-
# enabled. The database can't be deleted when deletion protection is
|
|
5000
|
-
# enabled. By default, deletion protection isn't enabled. For more
|
|
5001
|
-
# information, see [ Deleting a DB Instance][1].
|
|
5002
|
-
#
|
|
5003
|
-
# **Amazon Aurora**
|
|
4950
|
+
# @option params [Array<Types::ProcessorFeature>] :processor_features
|
|
4951
|
+
# The number of CPU cores and the number of threads per core for the DB
|
|
4952
|
+
# instance class of the DB instance.
|
|
4953
|
+
#
|
|
4954
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
4955
|
+
# instances.
|
|
5004
4956
|
#
|
|
5005
|
-
#
|
|
5006
|
-
#
|
|
5007
|
-
#
|
|
5008
|
-
# enabled
|
|
4957
|
+
# @option params [Boolean] :deletion_protection
|
|
4958
|
+
# Specifies whether the DB instance has deletion protection enabled. The
|
|
4959
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
4960
|
+
# default, deletion protection isn't enabled. For more information, see
|
|
4961
|
+
# [ Deleting a DB Instance][1].
|
|
4962
|
+
#
|
|
4963
|
+
# This setting doesn't apply to Amazon Aurora DB instances. You can
|
|
4964
|
+
# enable or disable deletion protection for the DB cluster. For more
|
|
4965
|
+
# information, see `CreateDBCluster`. DB instances in a DB cluster can
|
|
4966
|
+
# be deleted even when deletion protection is enabled for the DB
|
|
4967
|
+
# cluster.
|
|
5009
4968
|
#
|
|
5010
4969
|
#
|
|
5011
4970
|
#
|
|
@@ -5019,19 +4978,19 @@ module Aws::RDS
|
|
|
5019
4978
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
|
5020
4979
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
|
5021
4980
|
#
|
|
5022
|
-
# This setting doesn't apply to
|
|
4981
|
+
# This setting doesn't apply to the following DB instances:
|
|
5023
4982
|
#
|
|
5024
|
-
#
|
|
4983
|
+
# * Amazon Aurora (Storage is managed by the DB cluster.)
|
|
5025
4984
|
#
|
|
5026
|
-
#
|
|
4985
|
+
# * RDS Custom
|
|
5027
4986
|
#
|
|
5028
4987
|
#
|
|
5029
4988
|
#
|
|
5030
4989
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
5031
4990
|
#
|
|
5032
4991
|
# @option params [Boolean] :enable_customer_owned_ip
|
|
5033
|
-
#
|
|
5034
|
-
#
|
|
4992
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
4993
|
+
# RDS on Outposts DB instance.
|
|
5035
4994
|
#
|
|
5036
4995
|
# A *CoIP* provides local or external connectivity to resources in your
|
|
5037
4996
|
# Outpost subnets through your on-premises network. For some use cases,
|
|
@@ -5052,8 +5011,11 @@ module Aws::RDS
|
|
|
5052
5011
|
#
|
|
5053
5012
|
# @option params [String] :custom_iam_instance_profile
|
|
5054
5013
|
# The instance profile associated with the underlying Amazon EC2
|
|
5055
|
-
# instance of an RDS Custom DB instance.
|
|
5056
|
-
#
|
|
5014
|
+
# instance of an RDS Custom DB instance.
|
|
5015
|
+
#
|
|
5016
|
+
# This setting is required for RDS Custom.
|
|
5017
|
+
#
|
|
5018
|
+
# Constraints:
|
|
5057
5019
|
#
|
|
5058
5020
|
# * The profile must exist in your account.
|
|
5059
5021
|
#
|
|
@@ -5066,17 +5028,20 @@ module Aws::RDS
|
|
|
5066
5028
|
# For the list of permissions required for the IAM role, see [ Configure
|
|
5067
5029
|
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
5068
5030
|
#
|
|
5069
|
-
# This setting is required for RDS Custom.
|
|
5070
|
-
#
|
|
5071
5031
|
#
|
|
5072
5032
|
#
|
|
5073
5033
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
5074
5034
|
#
|
|
5075
5035
|
# @option params [String] :backup_target
|
|
5076
|
-
#
|
|
5036
|
+
# The location for storing automated backups and manual snapshots.
|
|
5077
5037
|
#
|
|
5078
|
-
#
|
|
5079
|
-
#
|
|
5038
|
+
# Valie Values:
|
|
5039
|
+
#
|
|
5040
|
+
# * `outposts` (Amazon Web Services Outposts)
|
|
5041
|
+
#
|
|
5042
|
+
# * `region` (Amazon Web Services Region)
|
|
5043
|
+
#
|
|
5044
|
+
# Default: `region`
|
|
5080
5045
|
#
|
|
5081
5046
|
# For more information, see [Working with Amazon RDS on Amazon Web
|
|
5082
5047
|
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
|
@@ -5088,12 +5053,6 @@ module Aws::RDS
|
|
|
5088
5053
|
# @option params [String] :network_type
|
|
5089
5054
|
# The network type of the DB instance.
|
|
5090
5055
|
#
|
|
5091
|
-
# Valid values:
|
|
5092
|
-
#
|
|
5093
|
-
# * `IPV4`
|
|
5094
|
-
#
|
|
5095
|
-
# * `DUAL`
|
|
5096
|
-
#
|
|
5097
5056
|
# The network type is determined by the `DBSubnetGroup` specified for
|
|
5098
5057
|
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
5099
5058
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
@@ -5101,20 +5060,23 @@ module Aws::RDS
|
|
|
5101
5060
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
5102
5061
|
# the *Amazon RDS User Guide.*
|
|
5103
5062
|
#
|
|
5063
|
+
# Valid Values: `IPV4 | DUAL`
|
|
5064
|
+
#
|
|
5104
5065
|
#
|
|
5105
5066
|
#
|
|
5106
5067
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
5107
5068
|
#
|
|
5108
5069
|
# @option params [Integer] :storage_throughput
|
|
5109
|
-
#
|
|
5070
|
+
# The storage throughput value for the DB instance.
|
|
5110
5071
|
#
|
|
5111
5072
|
# This setting applies only to the `gp3` storage type.
|
|
5112
5073
|
#
|
|
5113
|
-
# This setting doesn't apply to
|
|
5074
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
5075
|
+
# instances.
|
|
5114
5076
|
#
|
|
5115
5077
|
# @option params [Boolean] :manage_master_user_password
|
|
5116
|
-
#
|
|
5117
|
-
#
|
|
5078
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
5079
|
+
# Services Secrets Manager.
|
|
5118
5080
|
#
|
|
5119
5081
|
# For more information, see [Password management with Amazon Web
|
|
5120
5082
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
|
@@ -5154,10 +5116,10 @@ module Aws::RDS
|
|
|
5154
5116
|
# Amazon Web Services Region.
|
|
5155
5117
|
#
|
|
5156
5118
|
# @option params [String] :ca_certificate_identifier
|
|
5157
|
-
#
|
|
5158
|
-
#
|
|
5119
|
+
# The CA certificate identifier to use for the DB instance's server
|
|
5120
|
+
# certificate.
|
|
5159
5121
|
#
|
|
5160
|
-
# This setting doesn't apply to RDS Custom.
|
|
5122
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
5161
5123
|
#
|
|
5162
5124
|
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
5163
5125
|
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
@@ -5324,6 +5286,10 @@ module Aws::RDS
|
|
|
5324
5286
|
# storage_encrypted: false,
|
|
5325
5287
|
# kms_key_id: "String",
|
|
5326
5288
|
# domain: "String",
|
|
5289
|
+
# domain_fqdn: "String",
|
|
5290
|
+
# domain_ou: "String",
|
|
5291
|
+
# domain_auth_secret_arn: "String",
|
|
5292
|
+
# domain_dns_ips: ["String"],
|
|
5327
5293
|
# copy_tags_to_snapshot: false,
|
|
5328
5294
|
# monitoring_interval: 1,
|
|
5329
5295
|
# monitoring_role_arn: "String",
|
|
@@ -5454,6 +5420,10 @@ module Aws::RDS
|
|
|
5454
5420
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
5455
5421
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
5456
5422
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
5423
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
5424
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
5425
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
5426
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
5457
5427
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
5458
5428
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
5459
5429
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -5989,6 +5959,51 @@ module Aws::RDS
|
|
|
5989
5959
|
#
|
|
5990
5960
|
# This setting doesn't apply to RDS Custom.
|
|
5991
5961
|
#
|
|
5962
|
+
# @option params [String] :domain_fqdn
|
|
5963
|
+
# Specifies the fully qualified domain name of an Active Directory
|
|
5964
|
+
# domain.
|
|
5965
|
+
#
|
|
5966
|
+
# Constraints:
|
|
5967
|
+
#
|
|
5968
|
+
# * Cannot be greater than 64 characters.
|
|
5969
|
+
#
|
|
5970
|
+
# ^
|
|
5971
|
+
#
|
|
5972
|
+
# Example: `mymanagedADtest.mymanagedAD.mydomain`
|
|
5973
|
+
#
|
|
5974
|
+
# @option params [String] :domain_ou
|
|
5975
|
+
# The Active Directory organizational unit for your DB instance to join.
|
|
5976
|
+
#
|
|
5977
|
+
# Constraints:
|
|
5978
|
+
#
|
|
5979
|
+
# * Must be in the distinguished name format.
|
|
5980
|
+
#
|
|
5981
|
+
# * Cannot be greater than 64 characters.
|
|
5982
|
+
#
|
|
5983
|
+
# Example:
|
|
5984
|
+
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
|
5985
|
+
#
|
|
5986
|
+
# @option params [String] :domain_auth_secret_arn
|
|
5987
|
+
# The ARN for the Secrets Manager secret that contains the credentials
|
|
5988
|
+
# for the user performing the domain join.
|
|
5989
|
+
#
|
|
5990
|
+
# Example:
|
|
5991
|
+
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
|
5992
|
+
#
|
|
5993
|
+
# @option params [Array<String>] :domain_dns_ips
|
|
5994
|
+
# The IPv4 DNS IP addresses of your primary and secondary Active
|
|
5995
|
+
# Directory domain controllers.
|
|
5996
|
+
#
|
|
5997
|
+
# Constraints:
|
|
5998
|
+
#
|
|
5999
|
+
# * Two IP addresses must be provided. If there isn't a secondary
|
|
6000
|
+
# domain controller, use the IP address of the primary domain
|
|
6001
|
+
# controller for both entries in the list.
|
|
6002
|
+
#
|
|
6003
|
+
# ^
|
|
6004
|
+
#
|
|
6005
|
+
# Example: `123.124.125.126,234.235.236.237`
|
|
6006
|
+
#
|
|
5992
6007
|
# @option params [String] :replica_mode
|
|
5993
6008
|
# The open mode of the replica database: mounted or read-only.
|
|
5994
6009
|
#
|
|
@@ -6197,6 +6212,10 @@ module Aws::RDS
|
|
|
6197
6212
|
# deletion_protection: false,
|
|
6198
6213
|
# domain: "String",
|
|
6199
6214
|
# domain_iam_role_name: "String",
|
|
6215
|
+
# domain_fqdn: "String",
|
|
6216
|
+
# domain_ou: "String",
|
|
6217
|
+
# domain_auth_secret_arn: "String",
|
|
6218
|
+
# domain_dns_ips: ["String"],
|
|
6200
6219
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
|
6201
6220
|
# max_allocated_storage: 1,
|
|
6202
6221
|
# custom_iam_instance_profile: "String",
|
|
@@ -6309,6 +6328,10 @@ module Aws::RDS
|
|
|
6309
6328
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
6310
6329
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
6311
6330
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
6331
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
6332
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
6333
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
6334
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
6312
6335
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
6313
6336
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
6314
6337
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -8075,6 +8098,10 @@ module Aws::RDS
|
|
|
8075
8098
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
8076
8099
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
8077
8100
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
8101
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
8102
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
8103
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
8104
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
8078
8105
|
# resp.db_cluster.tag_list #=> Array
|
|
8079
8106
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
8080
8107
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -8588,6 +8615,10 @@ module Aws::RDS
|
|
|
8588
8615
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
8589
8616
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
8590
8617
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
8618
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
8619
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
8620
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
8621
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
8591
8622
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
8592
8623
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
8593
8624
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -10799,8 +10830,8 @@ module Aws::RDS
|
|
|
10799
10830
|
req.send_request(options)
|
|
10800
10831
|
end
|
|
10801
10832
|
|
|
10802
|
-
#
|
|
10803
|
-
#
|
|
10833
|
+
# Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.
|
|
10834
|
+
# This API supports pagination.
|
|
10804
10835
|
#
|
|
10805
10836
|
# For more information on Amazon Aurora DB clusters, see [ What is
|
|
10806
10837
|
# Amazon Aurora?][1] in the *Amazon Aurora User Guide*.
|
|
@@ -10819,19 +10850,19 @@ module Aws::RDS
|
|
|
10819
10850
|
# @option params [String] :db_cluster_identifier
|
|
10820
10851
|
# The user-supplied DB cluster identifier or the Amazon Resource Name
|
|
10821
10852
|
# (ARN) of the DB cluster. If this parameter is specified, information
|
|
10822
|
-
#
|
|
10853
|
+
# for only the specific DB cluster is returned. This parameter isn't
|
|
10823
10854
|
# case-sensitive.
|
|
10824
10855
|
#
|
|
10825
10856
|
# Constraints:
|
|
10826
10857
|
#
|
|
10827
|
-
# * If supplied, must match an existing
|
|
10858
|
+
# * If supplied, must match an existing DB cluster identifier.
|
|
10828
10859
|
#
|
|
10829
10860
|
# ^
|
|
10830
10861
|
#
|
|
10831
10862
|
# @option params [Array<Types::Filter>] :filters
|
|
10832
10863
|
# A filter that specifies one or more DB clusters to describe.
|
|
10833
10864
|
#
|
|
10834
|
-
# Supported
|
|
10865
|
+
# Supported Filters:
|
|
10835
10866
|
#
|
|
10836
10867
|
# * `clone-group-id` - Accepts clone group identifiers. The results list
|
|
10837
10868
|
# only includes information about the DB clusters associated with
|
|
@@ -10869,9 +10900,8 @@ module Aws::RDS
|
|
|
10869
10900
|
# specified by `MaxRecords`.
|
|
10870
10901
|
#
|
|
10871
10902
|
# @option params [Boolean] :include_shared
|
|
10872
|
-
#
|
|
10873
|
-
#
|
|
10874
|
-
# accounts.
|
|
10903
|
+
# Specifies whether the output includes information about clusters
|
|
10904
|
+
# shared from other Amazon Web Services accounts.
|
|
10875
10905
|
#
|
|
10876
10906
|
# @return [Types::DBClusterMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10877
10907
|
#
|
|
@@ -11074,6 +11104,10 @@ module Aws::RDS
|
|
|
11074
11104
|
# resp.db_clusters[0].domain_memberships[0].status #=> String
|
|
11075
11105
|
# resp.db_clusters[0].domain_memberships[0].fqdn #=> String
|
|
11076
11106
|
# resp.db_clusters[0].domain_memberships[0].iam_role_name #=> String
|
|
11107
|
+
# resp.db_clusters[0].domain_memberships[0].ou #=> String
|
|
11108
|
+
# resp.db_clusters[0].domain_memberships[0].auth_secret_arn #=> String
|
|
11109
|
+
# resp.db_clusters[0].domain_memberships[0].dns_ips #=> Array
|
|
11110
|
+
# resp.db_clusters[0].domain_memberships[0].dns_ips[0] #=> String
|
|
11077
11111
|
# resp.db_clusters[0].tag_list #=> Array
|
|
11078
11112
|
# resp.db_clusters[0].tag_list[0].key #=> String
|
|
11079
11113
|
# resp.db_clusters[0].tag_list[0].value #=> String
|
|
@@ -11564,8 +11598,7 @@ module Aws::RDS
|
|
|
11564
11598
|
req.send_request(options)
|
|
11565
11599
|
end
|
|
11566
11600
|
|
|
11567
|
-
#
|
|
11568
|
-
# pagination.
|
|
11601
|
+
# Describes provisioned RDS instances. This API supports pagination.
|
|
11569
11602
|
#
|
|
11570
11603
|
# <note markdown="1"> This operation can also return information for Amazon Neptune DB
|
|
11571
11604
|
# instances and Amazon DocumentDB instances.
|
|
@@ -11580,14 +11613,14 @@ module Aws::RDS
|
|
|
11580
11613
|
#
|
|
11581
11614
|
# Constraints:
|
|
11582
11615
|
#
|
|
11583
|
-
# * If supplied, must match the identifier of an existing
|
|
11616
|
+
# * If supplied, must match the identifier of an existing DB instance.
|
|
11584
11617
|
#
|
|
11585
11618
|
# ^
|
|
11586
11619
|
#
|
|
11587
11620
|
# @option params [Array<Types::Filter>] :filters
|
|
11588
11621
|
# A filter that specifies one or more DB instances to describe.
|
|
11589
11622
|
#
|
|
11590
|
-
# Supported
|
|
11623
|
+
# Supported Filters:
|
|
11591
11624
|
#
|
|
11592
11625
|
# * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
|
|
11593
11626
|
# Amazon Resource Names (ARNs). The results list only includes
|
|
@@ -11599,7 +11632,7 @@ module Aws::RDS
|
|
|
11599
11632
|
# information about the DB instances identified by these ARNs.
|
|
11600
11633
|
#
|
|
11601
11634
|
# * `dbi-resource-id` - Accepts DB instance resource identifiers. The
|
|
11602
|
-
# results list
|
|
11635
|
+
# results list only includes information about the DB instances
|
|
11603
11636
|
# identified by these DB instance resource identifiers.
|
|
11604
11637
|
#
|
|
11605
11638
|
# * `domain` - Accepts Active Directory directory IDs. The results list
|
|
@@ -11776,6 +11809,10 @@ module Aws::RDS
|
|
|
11776
11809
|
# resp.db_instances[0].domain_memberships[0].status #=> String
|
|
11777
11810
|
# resp.db_instances[0].domain_memberships[0].fqdn #=> String
|
|
11778
11811
|
# resp.db_instances[0].domain_memberships[0].iam_role_name #=> String
|
|
11812
|
+
# resp.db_instances[0].domain_memberships[0].ou #=> String
|
|
11813
|
+
# resp.db_instances[0].domain_memberships[0].auth_secret_arn #=> String
|
|
11814
|
+
# resp.db_instances[0].domain_memberships[0].dns_ips #=> Array
|
|
11815
|
+
# resp.db_instances[0].domain_memberships[0].dns_ips[0] #=> String
|
|
11779
11816
|
# resp.db_instances[0].copy_tags_to_snapshot #=> Boolean
|
|
11780
11817
|
# resp.db_instances[0].monitoring_interval #=> Integer
|
|
11781
11818
|
# resp.db_instances[0].enhanced_monitoring_resource_arn #=> String
|
|
@@ -15562,6 +15599,10 @@ module Aws::RDS
|
|
|
15562
15599
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
15563
15600
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
15564
15601
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
15602
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
15603
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
15604
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
15605
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
15565
15606
|
# resp.db_cluster.tag_list #=> Array
|
|
15566
15607
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
15567
15608
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -16220,7 +16261,7 @@ module Aws::RDS
|
|
|
16220
16261
|
req.send_request(options)
|
|
16221
16262
|
end
|
|
16222
16263
|
|
|
16223
|
-
#
|
|
16264
|
+
# Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB
|
|
16224
16265
|
# cluster. You can change one or more settings by specifying these
|
|
16225
16266
|
# parameters and the new values in the request.
|
|
16226
16267
|
#
|
|
@@ -16239,33 +16280,36 @@ module Aws::RDS
|
|
|
16239
16280
|
# The DB cluster identifier for the cluster being modified. This
|
|
16240
16281
|
# parameter isn't case-sensitive.
|
|
16241
16282
|
#
|
|
16242
|
-
#
|
|
16243
|
-
# DB cluster.
|
|
16283
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16244
16284
|
#
|
|
16245
|
-
#
|
|
16285
|
+
# Constraints:
|
|
16286
|
+
#
|
|
16287
|
+
# * Must match the identifier of an existing DB cluster.
|
|
16288
|
+
#
|
|
16289
|
+
# ^
|
|
16246
16290
|
#
|
|
16247
16291
|
# @option params [String] :new_db_cluster_identifier
|
|
16248
16292
|
# The new DB cluster identifier for the DB cluster when renaming a DB
|
|
16249
16293
|
# cluster. This value is stored as a lowercase string.
|
|
16250
16294
|
#
|
|
16295
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16296
|
+
#
|
|
16251
16297
|
# Constraints:
|
|
16252
16298
|
#
|
|
16253
|
-
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
|
16299
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
16254
16300
|
#
|
|
16255
|
-
# * The first character must be a letter
|
|
16301
|
+
# * The first character must be a letter.
|
|
16256
16302
|
#
|
|
16257
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
|
16303
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
|
16258
16304
|
#
|
|
16259
16305
|
# Example: `my-cluster2`
|
|
16260
16306
|
#
|
|
16261
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16262
|
-
#
|
|
16263
16307
|
# @option params [Boolean] :apply_immediately
|
|
16264
|
-
#
|
|
16265
|
-
#
|
|
16266
|
-
#
|
|
16267
|
-
#
|
|
16268
|
-
#
|
|
16308
|
+
# Specifies whether the modifications in this request and any pending
|
|
16309
|
+
# modifications are asynchronously applied as soon as possible,
|
|
16310
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
|
16311
|
+
# cluster. If this parameter is disabled, changes to the DB cluster are
|
|
16312
|
+
# applied during the next maintenance window.
|
|
16269
16313
|
#
|
|
16270
16314
|
# Most modifications can be applied immediately or during the next
|
|
16271
16315
|
# scheduled maintenance window. Some modifications, such as turning on
|
|
@@ -16274,56 +16318,57 @@ module Aws::RDS
|
|
|
16274
16318
|
#
|
|
16275
16319
|
# By default, this parameter is disabled.
|
|
16276
16320
|
#
|
|
16277
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16321
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16278
16322
|
#
|
|
16279
16323
|
# @option params [Integer] :backup_retention_period
|
|
16280
16324
|
# The number of days for which automated backups are retained. Specify a
|
|
16281
|
-
# minimum value of 1
|
|
16325
|
+
# minimum value of `1`.
|
|
16282
16326
|
#
|
|
16283
|
-
#
|
|
16327
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16328
|
+
#
|
|
16329
|
+
# Default: `1`
|
|
16284
16330
|
#
|
|
16285
16331
|
# Constraints:
|
|
16286
16332
|
#
|
|
16287
|
-
# * Must be a value from 1 to 35
|
|
16333
|
+
# * Must be a value from 1 to 35.
|
|
16288
16334
|
#
|
|
16289
16335
|
# ^
|
|
16290
16336
|
#
|
|
16291
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16292
|
-
#
|
|
16293
16337
|
# @option params [String] :db_cluster_parameter_group_name
|
|
16294
16338
|
# The name of the DB cluster parameter group to use for the DB cluster.
|
|
16295
16339
|
#
|
|
16296
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16340
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16297
16341
|
#
|
|
16298
16342
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
16299
|
-
# A list of VPC security groups
|
|
16343
|
+
# A list of EC2 VPC security groups to associate with this DB cluster.
|
|
16300
16344
|
#
|
|
16301
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16345
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16302
16346
|
#
|
|
16303
16347
|
# @option params [Integer] :port
|
|
16304
16348
|
# The port number on which the DB cluster accepts connections.
|
|
16305
16349
|
#
|
|
16306
|
-
#
|
|
16350
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16307
16351
|
#
|
|
16308
|
-
#
|
|
16352
|
+
# Valid Values: `1150-65535`
|
|
16309
16353
|
#
|
|
16310
|
-
#
|
|
16354
|
+
# Default: The same port as the original DB cluster.
|
|
16311
16355
|
#
|
|
16312
16356
|
# @option params [String] :master_user_password
|
|
16313
|
-
# The new password for the master database user.
|
|
16314
|
-
#
|
|
16357
|
+
# The new password for the master database user.
|
|
16358
|
+
#
|
|
16359
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16315
16360
|
#
|
|
16316
16361
|
# Constraints:
|
|
16317
16362
|
#
|
|
16318
16363
|
# * Must contain from 8 to 41 characters.
|
|
16319
16364
|
#
|
|
16320
|
-
# * Can
|
|
16365
|
+
# * Can contain any printable ASCII character except "/", """, or
|
|
16366
|
+
# "@".
|
|
16321
16367
|
#
|
|
16322
|
-
#
|
|
16368
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
|
16323
16369
|
#
|
|
16324
16370
|
# @option params [String] :option_group_name
|
|
16325
|
-
#
|
|
16326
|
-
# the specified option group.
|
|
16371
|
+
# The option group to associate the DB cluster with.
|
|
16327
16372
|
#
|
|
16328
16373
|
# DB clusters are associated with a default option group that can't be
|
|
16329
16374
|
# modified.
|
|
@@ -16338,6 +16383,8 @@ module Aws::RDS
|
|
|
16338
16383
|
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
|
16339
16384
|
# Guide*.
|
|
16340
16385
|
#
|
|
16386
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16387
|
+
#
|
|
16341
16388
|
# Constraints:
|
|
16342
16389
|
#
|
|
16343
16390
|
# * Must be in the format `hh24:mi-hh24:mi`.
|
|
@@ -16348,8 +16395,6 @@ module Aws::RDS
|
|
|
16348
16395
|
#
|
|
16349
16396
|
# * Must be at least 30 minutes.
|
|
16350
16397
|
#
|
|
16351
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16352
|
-
#
|
|
16353
16398
|
#
|
|
16354
16399
|
#
|
|
16355
16400
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
|
@@ -16358,7 +16403,7 @@ module Aws::RDS
|
|
|
16358
16403
|
# The weekly time range during which system maintenance can occur, in
|
|
16359
16404
|
# Universal Coordinated Time (UTC).
|
|
16360
16405
|
#
|
|
16361
|
-
#
|
|
16406
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16362
16407
|
#
|
|
16363
16408
|
# The default is a 30-minute window selected at random from an 8-hour
|
|
16364
16409
|
# block of time for each Amazon Web Services Region, occurring on a
|
|
@@ -16366,25 +16411,29 @@ module Aws::RDS
|
|
|
16366
16411
|
# Adjusting the Preferred DB Cluster Maintenance Window][1] in the
|
|
16367
16412
|
# *Amazon Aurora User Guide*.
|
|
16368
16413
|
#
|
|
16369
|
-
#
|
|
16414
|
+
# Constraints:
|
|
16370
16415
|
#
|
|
16371
|
-
#
|
|
16416
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
|
16372
16417
|
#
|
|
16373
|
-
#
|
|
16418
|
+
# * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
|
|
16419
|
+
#
|
|
16420
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
16421
|
+
#
|
|
16422
|
+
# * Must be at least 30 minutes.
|
|
16374
16423
|
#
|
|
16375
16424
|
#
|
|
16376
16425
|
#
|
|
16377
16426
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
|
16378
16427
|
#
|
|
16379
16428
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
16380
|
-
#
|
|
16381
|
-
#
|
|
16382
|
-
#
|
|
16429
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
|
16430
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
|
16431
|
+
# mapping isn't enabled.
|
|
16383
16432
|
#
|
|
16384
16433
|
# For more information, see [ IAM Database Authentication][1] in the
|
|
16385
16434
|
# *Amazon Aurora User Guide*.
|
|
16386
16435
|
#
|
|
16387
|
-
# Valid for: Aurora DB clusters only
|
|
16436
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16388
16437
|
#
|
|
16389
16438
|
#
|
|
16390
16439
|
#
|
|
@@ -16392,9 +16441,11 @@ module Aws::RDS
|
|
|
16392
16441
|
#
|
|
16393
16442
|
# @option params [Integer] :backtrack_window
|
|
16394
16443
|
# The target backtrack window, in seconds. To disable backtracking, set
|
|
16395
|
-
# this value to 0
|
|
16444
|
+
# this value to `0`.
|
|
16396
16445
|
#
|
|
16397
|
-
#
|
|
16446
|
+
# Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
16447
|
+
#
|
|
16448
|
+
# Default: `0`
|
|
16398
16449
|
#
|
|
16399
16450
|
# Constraints:
|
|
16400
16451
|
#
|
|
@@ -16403,28 +16454,21 @@ module Aws::RDS
|
|
|
16403
16454
|
#
|
|
16404
16455
|
# ^
|
|
16405
16456
|
#
|
|
16406
|
-
# Valid for: Aurora MySQL DB clusters only
|
|
16407
|
-
#
|
|
16408
16457
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
|
16409
16458
|
# 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`.
|
|
16459
|
+
# to CloudWatch Logs for a specific DB cluster.
|
|
16416
16460
|
#
|
|
16417
|
-
#
|
|
16461
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16418
16462
|
#
|
|
16419
|
-
#
|
|
16463
|
+
# The following values are valid for each DB engine:
|
|
16420
16464
|
#
|
|
16421
|
-
#
|
|
16465
|
+
# * Aurora MySQL - `audit | error | general | slowquery`
|
|
16422
16466
|
#
|
|
16423
|
-
#
|
|
16467
|
+
# * Aurora PostgreSQL - `postgresql`
|
|
16424
16468
|
#
|
|
16425
|
-
#
|
|
16469
|
+
# * RDS for MySQL - `error | general | slowquery`
|
|
16426
16470
|
#
|
|
16427
|
-
#
|
|
16471
|
+
# * RDS for PostgreSQL - `postgresql | upgrade`
|
|
16428
16472
|
#
|
|
16429
16473
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
|
16430
16474
|
# see [ Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
|
@@ -16434,8 +16478,6 @@ module Aws::RDS
|
|
|
16434
16478
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
|
16435
16479
|
# the *Amazon Aurora User Guide*.
|
|
16436
16480
|
#
|
|
16437
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16438
|
-
#
|
|
16439
16481
|
#
|
|
16440
16482
|
#
|
|
16441
16483
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
|
@@ -16475,16 +16517,20 @@ module Aws::RDS
|
|
|
16475
16517
|
# `aws rds describe-db-engine-versions --engine postgres --query
|
|
16476
16518
|
# "DBEngineVersions[].EngineVersion"`
|
|
16477
16519
|
#
|
|
16478
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16520
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16479
16521
|
#
|
|
16480
16522
|
# @option params [Boolean] :allow_major_version_upgrade
|
|
16481
|
-
#
|
|
16523
|
+
# Specifies whether major version upgrades are allowed.
|
|
16482
16524
|
#
|
|
16483
|
-
#
|
|
16484
|
-
# value for the `EngineVersion` parameter that is a different major
|
|
16485
|
-
# version than the DB cluster's current version.
|
|
16525
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16486
16526
|
#
|
|
16487
|
-
#
|
|
16527
|
+
# Constraints:
|
|
16528
|
+
#
|
|
16529
|
+
# * You must allow major version upgrades when specifying a value for
|
|
16530
|
+
# the `EngineVersion` parameter that is a different major version than
|
|
16531
|
+
# the DB cluster's current version.
|
|
16532
|
+
#
|
|
16533
|
+
# ^
|
|
16488
16534
|
#
|
|
16489
16535
|
# @option params [String] :db_instance_parameter_group_name
|
|
16490
16536
|
# The name of the DB parameter group to apply to all instances of the DB
|
|
@@ -16497,6 +16543,8 @@ module Aws::RDS
|
|
|
16497
16543
|
#
|
|
16498
16544
|
# </note>
|
|
16499
16545
|
#
|
|
16546
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16547
|
+
#
|
|
16500
16548
|
# Default: The existing name setting
|
|
16501
16549
|
#
|
|
16502
16550
|
# Constraints:
|
|
@@ -16508,8 +16556,6 @@ module Aws::RDS
|
|
|
16508
16556
|
# with the `AllowMajorVersionUpgrade` parameter for a major version
|
|
16509
16557
|
# upgrade only.
|
|
16510
16558
|
#
|
|
16511
|
-
# Valid for: Aurora DB clusters only
|
|
16512
|
-
#
|
|
16513
16559
|
# @option params [String] :domain
|
|
16514
16560
|
# The Active Directory directory ID to move the DB cluster to. Specify
|
|
16515
16561
|
# `none` to remove the cluster from its current domain. The domain must
|
|
@@ -16518,35 +16564,34 @@ module Aws::RDS
|
|
|
16518
16564
|
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
|
16519
16565
|
# Aurora User Guide*.
|
|
16520
16566
|
#
|
|
16521
|
-
# Valid for: Aurora DB clusters only
|
|
16567
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16522
16568
|
#
|
|
16523
16569
|
#
|
|
16524
16570
|
#
|
|
16525
16571
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
16526
16572
|
#
|
|
16527
16573
|
# @option params [String] :domain_iam_role_name
|
|
16528
|
-
#
|
|
16529
|
-
#
|
|
16574
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
16575
|
+
# Service.
|
|
16530
16576
|
#
|
|
16531
|
-
# Valid for: Aurora DB clusters only
|
|
16577
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16532
16578
|
#
|
|
16533
16579
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
|
16534
16580
|
# The scaling properties of the DB cluster. You can only modify scaling
|
|
16535
16581
|
# properties for DB clusters in `serverless` DB engine mode.
|
|
16536
16582
|
#
|
|
16537
|
-
# Valid for: Aurora DB clusters only
|
|
16583
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16538
16584
|
#
|
|
16539
16585
|
# @option params [Boolean] :deletion_protection
|
|
16540
|
-
#
|
|
16541
|
-
#
|
|
16542
|
-
#
|
|
16586
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
16587
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
16588
|
+
# default, deletion protection isn't enabled.
|
|
16543
16589
|
#
|
|
16544
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16590
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16545
16591
|
#
|
|
16546
16592
|
# @option params [Boolean] :enable_http_endpoint
|
|
16547
|
-
#
|
|
16548
|
-
#
|
|
16549
|
-
# disabled.
|
|
16593
|
+
# Specifies whether to enable the HTTP endpoint for an Aurora Serverless
|
|
16594
|
+
# v1 DB cluster. By default, the HTTP endpoint is disabled.
|
|
16550
16595
|
#
|
|
16551
16596
|
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
16552
16597
|
# API for running SQL queries on the Aurora Serverless v1 DB cluster.
|
|
@@ -16556,45 +16601,44 @@ module Aws::RDS
|
|
|
16556
16601
|
# For more information, see [Using the Data API for Aurora Serverless
|
|
16557
16602
|
# v1][1] in the *Amazon Aurora User Guide*.
|
|
16558
16603
|
#
|
|
16559
|
-
# Valid for: Aurora DB clusters only
|
|
16604
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16560
16605
|
#
|
|
16561
16606
|
#
|
|
16562
16607
|
#
|
|
16563
16608
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
16564
16609
|
#
|
|
16565
16610
|
# @option params [Boolean] :copy_tags_to_snapshot
|
|
16566
|
-
#
|
|
16567
|
-
#
|
|
16611
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
16612
|
+
# the DB cluster. The default is not to copy them.
|
|
16568
16613
|
#
|
|
16569
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16614
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16570
16615
|
#
|
|
16571
16616
|
# @option params [Boolean] :enable_global_write_forwarding
|
|
16572
|
-
#
|
|
16573
|
-
#
|
|
16574
|
-
#
|
|
16575
|
-
#
|
|
16576
|
-
# database.
|
|
16617
|
+
# Specifies whether to enable this DB cluster to forward write
|
|
16618
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
|
16619
|
+
# database). By default, write operations are not allowed on Aurora DB
|
|
16620
|
+
# clusters that are secondary clusters in an Aurora global database.
|
|
16577
16621
|
#
|
|
16578
16622
|
# You can set this value only on Aurora DB clusters that are members of
|
|
16579
16623
|
# an Aurora global database. With this parameter enabled, a secondary
|
|
16580
|
-
# cluster can forward writes to the current primary cluster and the
|
|
16624
|
+
# cluster can forward writes to the current primary cluster, and the
|
|
16581
16625
|
# resulting changes are replicated back to this cluster. For the primary
|
|
16582
16626
|
# DB cluster of an Aurora global database, this value is used
|
|
16583
|
-
# immediately if the primary is demoted by
|
|
16627
|
+
# immediately if the primary is demoted by a global cluster API
|
|
16584
16628
|
# operation, but it does nothing until then.
|
|
16585
16629
|
#
|
|
16586
|
-
# Valid for: Aurora DB clusters only
|
|
16630
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16587
16631
|
#
|
|
16588
16632
|
# @option params [String] :db_cluster_instance_class
|
|
16589
16633
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
|
16590
|
-
# cluster, for example db.m6gd.xlarge
|
|
16634
|
+
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
|
16591
16635
|
# available in all Amazon Web Services Regions, or for all database
|
|
16592
16636
|
# engines.
|
|
16593
16637
|
#
|
|
16594
16638
|
# For the full list of DB instance classes and availability for your
|
|
16595
16639
|
# engine, see [ DB Instance Class][1] in the *Amazon RDS User Guide*.
|
|
16596
16640
|
#
|
|
16597
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16641
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16598
16642
|
#
|
|
16599
16643
|
#
|
|
16600
16644
|
#
|
|
@@ -16604,20 +16648,37 @@ module Aws::RDS
|
|
|
16604
16648
|
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
|
16605
16649
|
# instance in the Multi-AZ DB cluster.
|
|
16606
16650
|
#
|
|
16607
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16651
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16608
16652
|
#
|
|
16609
16653
|
# @option params [String] :storage_type
|
|
16610
|
-
#
|
|
16654
|
+
# The storage type to associate with the DB cluster.
|
|
16655
|
+
#
|
|
16656
|
+
# For information on storage types for Aurora DB clusters, see [Storage
|
|
16657
|
+
# configurations for Amazon Aurora DB clusters][1]. For information on
|
|
16658
|
+
# storage types for Multi-AZ DB clusters, see [Settings for creating
|
|
16659
|
+
# Multi-AZ DB clusters][2].
|
|
16611
16660
|
#
|
|
16612
16661
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
|
16613
16662
|
# parameter is required.
|
|
16614
16663
|
#
|
|
16615
|
-
# Valid
|
|
16616
|
-
#
|
|
16664
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16665
|
+
#
|
|
16666
|
+
# Valid Values:
|
|
16667
|
+
#
|
|
16668
|
+
# * Aurora DB clusters - `aurora | aurora-iopt1`
|
|
16669
|
+
#
|
|
16670
|
+
# * Multi-AZ DB clusters - `io1`
|
|
16671
|
+
#
|
|
16672
|
+
# Default:
|
|
16673
|
+
#
|
|
16674
|
+
# * Aurora DB clusters - `aurora`
|
|
16675
|
+
#
|
|
16676
|
+
# * Multi-AZ DB clusters - `io1`
|
|
16617
16677
|
#
|
|
16618
|
-
# Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
|
|
16619
16678
|
#
|
|
16620
|
-
#
|
|
16679
|
+
#
|
|
16680
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type
|
|
16681
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings
|
|
16621
16682
|
#
|
|
16622
16683
|
# @option params [Integer] :iops
|
|
16623
16684
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
|
@@ -16627,33 +16688,39 @@ module Aws::RDS
|
|
|
16627
16688
|
# For information about valid IOPS values, see [Amazon RDS Provisioned
|
|
16628
16689
|
# IOPS storage][1] in the *Amazon RDS User Guide*.
|
|
16629
16690
|
#
|
|
16630
|
-
#
|
|
16631
|
-
# amount for the DB cluster.
|
|
16691
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16632
16692
|
#
|
|
16633
|
-
#
|
|
16693
|
+
# Constraints:
|
|
16694
|
+
#
|
|
16695
|
+
# * Must be a multiple between .5 and 50 of the storage amount for the
|
|
16696
|
+
# DB cluster.
|
|
16697
|
+
#
|
|
16698
|
+
# ^
|
|
16634
16699
|
#
|
|
16635
16700
|
#
|
|
16636
16701
|
#
|
|
16637
16702
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
|
16638
16703
|
#
|
|
16639
16704
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
16640
|
-
#
|
|
16641
|
-
#
|
|
16642
|
-
#
|
|
16705
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
|
16706
|
+
# the DB cluster during the maintenance window. By default, minor engine
|
|
16707
|
+
# upgrades are applied automatically.
|
|
16643
16708
|
#
|
|
16644
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16709
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16645
16710
|
#
|
|
16646
16711
|
# @option params [Integer] :monitoring_interval
|
|
16647
16712
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
16648
16713
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
16649
|
-
# Enhanced Monitoring metrics, specify 0
|
|
16714
|
+
# Enhanced Monitoring metrics, specify `0`.
|
|
16650
16715
|
#
|
|
16651
16716
|
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
|
16652
|
-
# a value other than 0
|
|
16717
|
+
# a value other than `0`.
|
|
16653
16718
|
#
|
|
16654
|
-
# Valid
|
|
16719
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16655
16720
|
#
|
|
16656
|
-
# Valid
|
|
16721
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
|
16722
|
+
#
|
|
16723
|
+
# Default: `0`
|
|
16657
16724
|
#
|
|
16658
16725
|
# @option params [String] :monitoring_role_arn
|
|
16659
16726
|
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
|
@@ -16662,23 +16729,22 @@ module Aws::RDS
|
|
|
16662
16729
|
# creating a monitoring role, see [To create an IAM role for Amazon RDS
|
|
16663
16730
|
# Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
|
16664
16731
|
#
|
|
16665
|
-
# If `MonitoringInterval` is set to a value other than 0
|
|
16732
|
+
# If `MonitoringInterval` is set to a value other than `0`, supply a
|
|
16666
16733
|
# `MonitoringRoleArn` value.
|
|
16667
16734
|
#
|
|
16668
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16735
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16669
16736
|
#
|
|
16670
16737
|
#
|
|
16671
16738
|
#
|
|
16672
16739
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
|
16673
16740
|
#
|
|
16674
16741
|
# @option params [Boolean] :enable_performance_insights
|
|
16675
|
-
#
|
|
16676
|
-
# DB cluster.
|
|
16742
|
+
# Specifies whether to turn on Performance Insights for the DB cluster.
|
|
16677
16743
|
#
|
|
16678
16744
|
# For more information, see [ Using Amazon Performance Insights][1] in
|
|
16679
16745
|
# the *Amazon RDS User Guide*.
|
|
16680
16746
|
#
|
|
16681
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16747
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16682
16748
|
#
|
|
16683
16749
|
#
|
|
16684
16750
|
#
|
|
@@ -16696,32 +16762,27 @@ module Aws::RDS
|
|
|
16696
16762
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
|
16697
16763
|
# a different default KMS key for each Amazon Web Services Region.
|
|
16698
16764
|
#
|
|
16699
|
-
# Valid for: Multi-AZ DB clusters only
|
|
16765
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16700
16766
|
#
|
|
16701
16767
|
# @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
|
|
16768
|
+
# The number of days to retain Performance Insights data.
|
|
16706
16769
|
#
|
|
16707
|
-
#
|
|
16708
|
-
#
|
|
16709
|
-
# * 731
|
|
16710
|
-
#
|
|
16711
|
-
# For example, the following values are valid:
|
|
16770
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
16712
16771
|
#
|
|
16713
|
-
#
|
|
16772
|
+
# Valid Values:
|
|
16714
16773
|
#
|
|
16715
|
-
# *
|
|
16774
|
+
# * `7`
|
|
16716
16775
|
#
|
|
16717
|
-
# *
|
|
16776
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
|
16777
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
|
16778
|
+
# months * 31)
|
|
16718
16779
|
#
|
|
16719
|
-
# * 731
|
|
16780
|
+
# * `731`
|
|
16720
16781
|
#
|
|
16721
|
-
#
|
|
16722
|
-
# value, RDS issues an error.
|
|
16782
|
+
# Default: `7` days
|
|
16723
16783
|
#
|
|
16724
|
-
#
|
|
16784
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
|
16785
|
+
# Amazon RDS issues an error.
|
|
16725
16786
|
#
|
|
16726
16787
|
# @option params [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
16727
16788
|
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
@@ -16737,12 +16798,6 @@ module Aws::RDS
|
|
|
16737
16798
|
# @option params [String] :network_type
|
|
16738
16799
|
# The network type of the DB cluster.
|
|
16739
16800
|
#
|
|
16740
|
-
# Valid values:
|
|
16741
|
-
#
|
|
16742
|
-
# * `IPV4`
|
|
16743
|
-
#
|
|
16744
|
-
# * `DUAL`
|
|
16745
|
-
#
|
|
16746
16801
|
# The network type is determined by the `DBSubnetGroup` specified for
|
|
16747
16802
|
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
16748
16803
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
@@ -16750,15 +16805,17 @@ module Aws::RDS
|
|
|
16750
16805
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
16751
16806
|
# the *Amazon Aurora User Guide.*
|
|
16752
16807
|
#
|
|
16753
|
-
# Valid for: Aurora DB clusters only
|
|
16808
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16809
|
+
#
|
|
16810
|
+
# Valid Values: `IPV4 | DUAL`
|
|
16754
16811
|
#
|
|
16755
16812
|
#
|
|
16756
16813
|
#
|
|
16757
16814
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
16758
16815
|
#
|
|
16759
16816
|
# @option params [Boolean] :manage_master_user_password
|
|
16760
|
-
#
|
|
16761
|
-
#
|
|
16817
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
16818
|
+
# Services Secrets Manager.
|
|
16762
16819
|
#
|
|
16763
16820
|
# If the DB cluster doesn't manage the master user password with Amazon
|
|
16764
16821
|
# Web Services Secrets Manager, you can turn on this management. In this
|
|
@@ -16776,7 +16833,7 @@ module Aws::RDS
|
|
|
16776
16833
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
|
16777
16834
|
# the *Amazon Aurora User Guide.*
|
|
16778
16835
|
#
|
|
16779
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16836
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16780
16837
|
#
|
|
16781
16838
|
#
|
|
16782
16839
|
#
|
|
@@ -16784,8 +16841,8 @@ module Aws::RDS
|
|
|
16784
16841
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
|
16785
16842
|
#
|
|
16786
16843
|
# @option params [Boolean] :rotate_master_user_password
|
|
16787
|
-
#
|
|
16788
|
-
#
|
|
16844
|
+
# Specifies whether to rotate the secret managed by Amazon Web Services
|
|
16845
|
+
# Secrets Manager for the master user password.
|
|
16789
16846
|
#
|
|
16790
16847
|
# This setting is valid only if the master user password is managed by
|
|
16791
16848
|
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
|
@@ -16796,6 +16853,8 @@ module Aws::RDS
|
|
|
16796
16853
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
|
16797
16854
|
# the *Amazon Aurora User Guide.*
|
|
16798
16855
|
#
|
|
16856
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16857
|
+
#
|
|
16799
16858
|
# Constraints:
|
|
16800
16859
|
#
|
|
16801
16860
|
# * You must apply the change immediately when rotating the master user
|
|
@@ -16803,8 +16862,6 @@ module Aws::RDS
|
|
|
16803
16862
|
#
|
|
16804
16863
|
# ^
|
|
16805
16864
|
#
|
|
16806
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16807
|
-
#
|
|
16808
16865
|
#
|
|
16809
16866
|
#
|
|
16810
16867
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
@@ -16844,7 +16901,7 @@ module Aws::RDS
|
|
|
16844
16901
|
# Amazon Web Services account has a different default KMS key for each
|
|
16845
16902
|
# Amazon Web Services Region.
|
|
16846
16903
|
#
|
|
16847
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
16904
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
16848
16905
|
#
|
|
16849
16906
|
# @option params [String] :engine_mode
|
|
16850
16907
|
# The DB engine mode of the DB cluster, either `provisioned` or
|
|
@@ -16857,21 +16914,25 @@ module Aws::RDS
|
|
|
16857
16914
|
#
|
|
16858
16915
|
# For more information, see [ CreateDBCluster][1].
|
|
16859
16916
|
#
|
|
16860
|
-
# Valid for: Aurora DB clusters only
|
|
16917
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
16861
16918
|
#
|
|
16862
16919
|
#
|
|
16863
16920
|
#
|
|
16864
16921
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
|
|
16865
16922
|
#
|
|
16866
16923
|
# @option params [Boolean] :allow_engine_mode_change
|
|
16867
|
-
#
|
|
16868
|
-
#
|
|
16924
|
+
# Specifies whether engine mode changes from `serverless` to
|
|
16925
|
+
# `provisioned` are allowed.
|
|
16926
|
+
#
|
|
16927
|
+
# Valid for Cluster Type: Aurora Serverless v1 DB clusters only
|
|
16928
|
+
#
|
|
16929
|
+
# Constraints:
|
|
16869
16930
|
#
|
|
16870
|
-
#
|
|
16871
|
-
#
|
|
16872
|
-
#
|
|
16931
|
+
# * You must allow engine mode changes when specifying a different value
|
|
16932
|
+
# for the `EngineMode` parameter from the DB cluster's current engine
|
|
16933
|
+
# mode.
|
|
16873
16934
|
#
|
|
16874
|
-
#
|
|
16935
|
+
# ^
|
|
16875
16936
|
#
|
|
16876
16937
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
16877
16938
|
#
|
|
@@ -17090,6 +17151,10 @@ module Aws::RDS
|
|
|
17090
17151
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
17091
17152
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
17092
17153
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
17154
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
17155
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
17156
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
17157
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
17093
17158
|
# resp.db_cluster.tag_list #=> Array
|
|
17094
17159
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
17095
17160
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -17489,12 +17554,12 @@ module Aws::RDS
|
|
|
17489
17554
|
# before you call `ModifyDBInstance`.
|
|
17490
17555
|
#
|
|
17491
17556
|
# @option params [required, String] :db_instance_identifier
|
|
17492
|
-
# The DB instance
|
|
17493
|
-
# string.
|
|
17557
|
+
# The identifier of DB instance to modify. This value is stored as a
|
|
17558
|
+
# lowercase string.
|
|
17494
17559
|
#
|
|
17495
17560
|
# Constraints:
|
|
17496
17561
|
#
|
|
17497
|
-
# * Must match the identifier of an existing
|
|
17562
|
+
# * Must match the identifier of an existing DB instance.
|
|
17498
17563
|
#
|
|
17499
17564
|
# ^
|
|
17500
17565
|
#
|
|
@@ -17502,17 +17567,18 @@ module Aws::RDS
|
|
|
17502
17567
|
# The new amount of storage in gibibytes (GiB) to allocate for the DB
|
|
17503
17568
|
# instance.
|
|
17504
17569
|
#
|
|
17505
|
-
# For MariaDB, MySQL, Oracle, and
|
|
17506
|
-
# at least 10% greater than the
|
|
17507
|
-
#
|
|
17508
|
-
# are 10% greater than the
|
|
17570
|
+
# For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
|
|
17571
|
+
# PostgreSQL, the value supplied must be at least 10% greater than the
|
|
17572
|
+
# current value. Values that are not at least 10% greater than the
|
|
17573
|
+
# existing value are rounded up so that they are 10% greater than the
|
|
17574
|
+
# current value.
|
|
17509
17575
|
#
|
|
17510
17576
|
# For the valid values for allocated storage for each engine, see
|
|
17511
17577
|
# `CreateDBInstance`.
|
|
17512
17578
|
#
|
|
17513
17579
|
# @option params [String] :db_instance_class
|
|
17514
17580
|
# The new compute and memory capacity of the DB instance, for example
|
|
17515
|
-
# db.m4.large
|
|
17581
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
|
17516
17582
|
# Web Services Regions, or for all database engines. For the full list
|
|
17517
17583
|
# of DB instance classes, and availability for your engine, see [DB
|
|
17518
17584
|
# Instance Class][1] in the *Amazon RDS User Guide* or [Aurora DB
|
|
@@ -17544,10 +17610,13 @@ module Aws::RDS
|
|
|
17544
17610
|
# change is applied during the next maintenance window, unless you
|
|
17545
17611
|
# enable `ApplyImmediately`.
|
|
17546
17612
|
#
|
|
17547
|
-
# This parameter doesn't apply to RDS Custom.
|
|
17613
|
+
# This parameter doesn't apply to RDS Custom DB instances.
|
|
17548
17614
|
#
|
|
17549
|
-
# Constraints:
|
|
17550
|
-
#
|
|
17615
|
+
# Constraints:
|
|
17616
|
+
#
|
|
17617
|
+
# * If supplied, must match existing DB subnet group.
|
|
17618
|
+
#
|
|
17619
|
+
# ^
|
|
17551
17620
|
#
|
|
17552
17621
|
# Example: `mydbsubnetgroup`
|
|
17553
17622
|
#
|
|
@@ -17560,37 +17629,37 @@ module Aws::RDS
|
|
|
17560
17629
|
# Changing this setting doesn't result in an outage and the change is
|
|
17561
17630
|
# asynchronously applied as soon as possible.
|
|
17562
17631
|
#
|
|
17563
|
-
# This setting doesn't apply to RDS Custom.
|
|
17632
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17564
17633
|
#
|
|
17565
17634
|
# Constraints:
|
|
17566
17635
|
#
|
|
17567
|
-
# * If supplied, must match existing
|
|
17636
|
+
# * If supplied, must match existing DB security groups.
|
|
17568
17637
|
#
|
|
17569
17638
|
# ^
|
|
17570
17639
|
#
|
|
17571
17640
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
17572
|
-
# A list of Amazon EC2 VPC security groups to
|
|
17641
|
+
# A list of Amazon EC2 VPC security groups to associate with this DB
|
|
17573
17642
|
# instance. This change is asynchronously applied as soon as possible.
|
|
17574
17643
|
#
|
|
17575
|
-
# This setting doesn't apply to
|
|
17644
|
+
# This setting doesn't apply to the following DB instances:
|
|
17576
17645
|
#
|
|
17577
|
-
#
|
|
17646
|
+
# * Amazon Aurora (The associated list of EC2 VPC security groups is
|
|
17647
|
+
# managed by the DB cluster. For more information, see
|
|
17648
|
+
# `ModifyDBCluster`.)
|
|
17578
17649
|
#
|
|
17579
|
-
#
|
|
17580
|
-
# managed by the DB cluster. For more information, see
|
|
17581
|
-
# `ModifyDBCluster`.
|
|
17650
|
+
# * RDS Custom
|
|
17582
17651
|
#
|
|
17583
17652
|
# Constraints:
|
|
17584
17653
|
#
|
|
17585
|
-
# * If supplied, must match existing
|
|
17654
|
+
# * If supplied, must match existing VPC security group IDs.
|
|
17586
17655
|
#
|
|
17587
17656
|
# ^
|
|
17588
17657
|
#
|
|
17589
17658
|
# @option params [Boolean] :apply_immediately
|
|
17590
|
-
#
|
|
17591
|
-
#
|
|
17592
|
-
#
|
|
17593
|
-
#
|
|
17659
|
+
# Specifies whether the modifications in this request and any pending
|
|
17660
|
+
# modifications are asynchronously applied as soon as possible,
|
|
17661
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
|
17662
|
+
# instance. By default, this parameter is disabled.
|
|
17594
17663
|
#
|
|
17595
17664
|
# If this parameter is disabled, changes to the DB instance are applied
|
|
17596
17665
|
# during the next maintenance window. Some parameter changes can cause
|
|
@@ -17605,8 +17674,7 @@ module Aws::RDS
|
|
|
17605
17674
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html
|
|
17606
17675
|
#
|
|
17607
17676
|
# @option params [String] :master_user_password
|
|
17608
|
-
# The new password for the master user.
|
|
17609
|
-
# printable ASCII character except "/", """, or "@".
|
|
17677
|
+
# The new password for the master user.
|
|
17610
17678
|
#
|
|
17611
17679
|
# Changing this parameter doesn't result in an outage and the change is
|
|
17612
17680
|
# asynchronously applied as soon as possible. Between the time of the
|
|
@@ -17614,44 +17682,41 @@ module Aws::RDS
|
|
|
17614
17682
|
# element exists in the `PendingModifiedValues` element of the operation
|
|
17615
17683
|
# response.
|
|
17616
17684
|
#
|
|
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`.
|
|
17685
|
+
# <note markdown="1"> Amazon RDS API operations never return the password, so this action
|
|
17686
|
+
# provides a way to regain access to a primary instance user if the
|
|
17687
|
+
# password is lost. This includes restoring privileges that might have
|
|
17688
|
+
# been accidentally revoked.
|
|
17623
17689
|
#
|
|
17624
|
-
#
|
|
17690
|
+
# </note>
|
|
17625
17691
|
#
|
|
17626
|
-
#
|
|
17627
|
-
# turned on.
|
|
17692
|
+
# This setting doesn't apply to the following DB instances:
|
|
17628
17693
|
#
|
|
17629
|
-
#
|
|
17694
|
+
# * Amazon Aurora (The password for the master user is managed by the DB
|
|
17695
|
+
# cluster. For more information, see `ModifyDBCluster`.)
|
|
17630
17696
|
#
|
|
17631
|
-
#
|
|
17697
|
+
# * RDS Custom
|
|
17632
17698
|
#
|
|
17633
|
-
#
|
|
17699
|
+
# Default: Uses existing setting
|
|
17634
17700
|
#
|
|
17635
|
-
# Constraints:
|
|
17701
|
+
# Constraints:
|
|
17636
17702
|
#
|
|
17637
|
-
#
|
|
17703
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
|
17638
17704
|
#
|
|
17639
|
-
#
|
|
17705
|
+
# * Can include any printable ASCII character except "/", """, or
|
|
17706
|
+
# "@".
|
|
17640
17707
|
#
|
|
17641
|
-
#
|
|
17708
|
+
# Length Constraints:
|
|
17642
17709
|
#
|
|
17643
|
-
#
|
|
17710
|
+
# * RDS for MariaDB - Must contain from 8 to 41 characters.
|
|
17644
17711
|
#
|
|
17645
|
-
#
|
|
17712
|
+
# * RDS for Microsoft SQL Server - Must contain from 8 to 128
|
|
17713
|
+
# characters.
|
|
17646
17714
|
#
|
|
17647
|
-
#
|
|
17715
|
+
# * RDS for MySQL - Must contain from 8 to 41 characters.
|
|
17648
17716
|
#
|
|
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.
|
|
17717
|
+
# * RDS for Oracle - Must contain from 8 to 30 characters.
|
|
17653
17718
|
#
|
|
17654
|
-
#
|
|
17719
|
+
# * RDS for PostgreSQL - Must contain from 8 to 128 characters.
|
|
17655
17720
|
#
|
|
17656
17721
|
# @option params [String] :db_parameter_group_name
|
|
17657
17722
|
# The name of the DB parameter group to apply to the DB instance.
|
|
@@ -17665,12 +17730,15 @@ module Aws::RDS
|
|
|
17665
17730
|
# associated DB parameter group, these changes are applied immediately
|
|
17666
17731
|
# without a reboot.
|
|
17667
17732
|
#
|
|
17668
|
-
# This setting doesn't apply to RDS Custom.
|
|
17733
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17669
17734
|
#
|
|
17670
17735
|
# Default: Uses existing setting
|
|
17671
17736
|
#
|
|
17672
|
-
# Constraints:
|
|
17673
|
-
#
|
|
17737
|
+
# Constraints:
|
|
17738
|
+
#
|
|
17739
|
+
# * Must be in the same DB parameter group family as the DB instance.
|
|
17740
|
+
#
|
|
17741
|
+
# ^
|
|
17674
17742
|
#
|
|
17675
17743
|
# @option params [Integer] :backup_retention_period
|
|
17676
17744
|
# The number of days to retain automated backups. Setting this parameter
|
|
@@ -17688,24 +17756,19 @@ module Aws::RDS
|
|
|
17688
17756
|
# change the parameter from one non-zero value to another non-zero
|
|
17689
17757
|
# value, the change is asynchronously applied as soon as possible.
|
|
17690
17758
|
#
|
|
17691
|
-
#
|
|
17692
|
-
#
|
|
17693
|
-
#
|
|
17694
|
-
# by the DB cluster. For more information, see `ModifyDBCluster`.
|
|
17759
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The
|
|
17760
|
+
# retention period for automated backups is managed by the DB cluster.
|
|
17761
|
+
# For more information, see `ModifyDBCluster`.
|
|
17695
17762
|
#
|
|
17696
17763
|
# Default: Uses existing setting
|
|
17697
17764
|
#
|
|
17698
17765
|
# Constraints:
|
|
17699
17766
|
#
|
|
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.
|
|
17767
|
+
# * Must be a value from 0 to 35.
|
|
17703
17768
|
#
|
|
17704
|
-
# *
|
|
17705
|
-
# running MySQL 5.6 or later.
|
|
17769
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas.
|
|
17706
17770
|
#
|
|
17707
|
-
# *
|
|
17708
|
-
# is running PostgreSQL 9.3.5.
|
|
17771
|
+
# * Can't be set to 0 for an RDS Custom for Oracle DB instance.
|
|
17709
17772
|
#
|
|
17710
17773
|
# @option params [String] :preferred_backup_window
|
|
17711
17774
|
# The daily time range during which automated backups are created if
|
|
@@ -17714,61 +17777,65 @@ module Aws::RDS
|
|
|
17714
17777
|
# result in an outage and the change is asynchronously applied as soon
|
|
17715
17778
|
# as possible. The default is a 30-minute window selected at random from
|
|
17716
17779
|
# 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**
|
|
17780
|
+
# information, see [Backup window][1] in the *Amazon RDS User Guide*.
|
|
17720
17781
|
#
|
|
17721
|
-
#
|
|
17722
|
-
#
|
|
17723
|
-
# `ModifyDBCluster`.
|
|
17782
|
+
# This setting doesn't apply to Amazon Aurora DB instances. The daily
|
|
17783
|
+
# time range for creating automated backups is managed by the DB
|
|
17784
|
+
# cluster. For more information, see `ModifyDBCluster`.
|
|
17724
17785
|
#
|
|
17725
17786
|
# Constraints:
|
|
17726
17787
|
#
|
|
17727
|
-
# * Must be in the format hh24:mi-hh24:mi
|
|
17788
|
+
# * Must be in the format `hh24:mi-hh24:mi`.
|
|
17728
17789
|
#
|
|
17729
|
-
# * Must be in Universal Time
|
|
17790
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
17730
17791
|
#
|
|
17731
|
-
# * Must not conflict with the preferred maintenance window
|
|
17792
|
+
# * Must not conflict with the preferred maintenance window.
|
|
17732
17793
|
#
|
|
17733
|
-
# * Must be at least 30 minutes
|
|
17794
|
+
# * Must be at least 30 minutes.
|
|
17734
17795
|
#
|
|
17735
17796
|
#
|
|
17736
17797
|
#
|
|
17737
17798
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
|
|
17738
17799
|
#
|
|
17739
17800
|
# @option params [String] :preferred_maintenance_window
|
|
17740
|
-
# The weekly time range
|
|
17741
|
-
#
|
|
17742
|
-
#
|
|
17743
|
-
#
|
|
17744
|
-
#
|
|
17745
|
-
#
|
|
17746
|
-
#
|
|
17747
|
-
#
|
|
17748
|
-
#
|
|
17801
|
+
# The weekly time range during which system maintenance can occur, which
|
|
17802
|
+
# might result in an outage. Changing this parameter doesn't result in
|
|
17803
|
+
# an outage, except in the following situation, and the change is
|
|
17804
|
+
# asynchronously applied as soon as possible. If there are pending
|
|
17805
|
+
# actions that cause a reboot, and the maintenance window is changed to
|
|
17806
|
+
# include the current time, then changing this parameter causes a reboot
|
|
17807
|
+
# of the DB instance. If you change this window to the current time,
|
|
17808
|
+
# there must be at least 30 minutes between the current time and end of
|
|
17809
|
+
# the window to ensure pending changes are applied.
|
|
17749
17810
|
#
|
|
17750
17811
|
# For more information, see [Amazon RDS Maintenance Window][1] in the
|
|
17751
17812
|
# *Amazon RDS User Guide.*
|
|
17752
17813
|
#
|
|
17753
17814
|
# Default: Uses existing setting
|
|
17754
17815
|
#
|
|
17755
|
-
#
|
|
17816
|
+
# Constraints:
|
|
17817
|
+
#
|
|
17818
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
|
17819
|
+
#
|
|
17820
|
+
# * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
|
|
17821
|
+
#
|
|
17822
|
+
# * Must be in Universal Coordinated Time (UTC).
|
|
17756
17823
|
#
|
|
17757
|
-
#
|
|
17824
|
+
# * Must not conflict with the preferred backup window.
|
|
17758
17825
|
#
|
|
17759
|
-
#
|
|
17826
|
+
# * Must be at least 30 minutes.
|
|
17760
17827
|
#
|
|
17761
17828
|
#
|
|
17762
17829
|
#
|
|
17763
17830
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
|
|
17764
17831
|
#
|
|
17765
17832
|
# @option params [Boolean] :multi_az
|
|
17766
|
-
#
|
|
17767
|
-
#
|
|
17768
|
-
#
|
|
17769
|
-
#
|
|
17833
|
+
# Specifies whether the DB instance is a Multi-AZ deployment. Changing
|
|
17834
|
+
# this parameter doesn't result in an outage. The change is applied
|
|
17835
|
+
# during the next maintenance window unless the `ApplyImmediately`
|
|
17836
|
+
# parameter is enabled for this request.
|
|
17770
17837
|
#
|
|
17771
|
-
# This setting doesn't apply to RDS Custom.
|
|
17838
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17772
17839
|
#
|
|
17773
17840
|
# @option params [String] :engine_version
|
|
17774
17841
|
# The version number of the database engine to upgrade to. Changing this
|
|
@@ -17781,33 +17848,37 @@ module Aws::RDS
|
|
|
17781
17848
|
# family for the new engine version must be specified. The new DB
|
|
17782
17849
|
# parameter group can be the default for that DB parameter group family.
|
|
17783
17850
|
#
|
|
17784
|
-
# If you specify only a major version, Amazon RDS
|
|
17851
|
+
# If you specify only a major version, Amazon RDS updates the DB
|
|
17785
17852
|
# instance to the default minor version if the current minor version is
|
|
17786
17853
|
# lower. For information about valid engine versions, see
|
|
17787
17854
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
|
17788
17855
|
#
|
|
17789
17856
|
# 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.
|
|
17857
|
+
# the engine version that you specify must be the same or higher than
|
|
17858
|
+
# the version that the source DB instance or cluster is running.
|
|
17792
17859
|
#
|
|
17793
17860
|
# In RDS Custom for Oracle, this parameter is supported for read
|
|
17794
17861
|
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
|
17795
17862
|
#
|
|
17796
17863
|
# @option params [Boolean] :allow_major_version_upgrade
|
|
17797
|
-
#
|
|
17798
|
-
#
|
|
17864
|
+
# Specifies whether major version upgrades are allowed. Changing this
|
|
17865
|
+
# parameter doesn't result in an outage and the change is
|
|
17799
17866
|
# asynchronously applied as soon as possible.
|
|
17800
17867
|
#
|
|
17801
|
-
# This setting doesn't apply to RDS Custom.
|
|
17868
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17802
17869
|
#
|
|
17803
|
-
# Constraints:
|
|
17804
|
-
#
|
|
17805
|
-
# version
|
|
17870
|
+
# Constraints:
|
|
17871
|
+
#
|
|
17872
|
+
# * Major version upgrades must be allowed when specifying a value for
|
|
17873
|
+
# the `EngineVersion` parameter that's a different major version than
|
|
17874
|
+
# the DB instance's current version.
|
|
17875
|
+
#
|
|
17876
|
+
# ^
|
|
17806
17877
|
#
|
|
17807
17878
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
17808
|
-
#
|
|
17809
|
-
#
|
|
17810
|
-
#
|
|
17879
|
+
# Specifies whether minor version upgrades are applied automatically to
|
|
17880
|
+
# the DB instance during the maintenance window. An outage occurs when
|
|
17881
|
+
# all the following conditions are met:
|
|
17811
17882
|
#
|
|
17812
17883
|
# * The automatic upgrade is enabled for the maintenance window.
|
|
17813
17884
|
#
|
|
@@ -17815,19 +17886,29 @@ module Aws::RDS
|
|
|
17815
17886
|
#
|
|
17816
17887
|
# * RDS has enabled automatic patching for the engine version.
|
|
17817
17888
|
#
|
|
17818
|
-
# If any of the preceding conditions isn't met, RDS applies the
|
|
17819
|
-
# as soon as possible and doesn't cause an outage.
|
|
17889
|
+
# If any of the preceding conditions isn't met, Amazon RDS applies the
|
|
17890
|
+
# change as soon as possible and doesn't cause an outage.
|
|
17820
17891
|
#
|
|
17821
|
-
# For an RDS Custom DB instance,
|
|
17822
|
-
#
|
|
17892
|
+
# For an RDS Custom DB instance, don't enable this setting. Otherwise,
|
|
17893
|
+
# the operation returns an error.
|
|
17823
17894
|
#
|
|
17824
17895
|
# @option params [String] :license_model
|
|
17825
17896
|
# The license model for the DB instance.
|
|
17826
17897
|
#
|
|
17827
|
-
# This setting doesn't apply to RDS Custom
|
|
17898
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
17899
|
+
# instances.
|
|
17828
17900
|
#
|
|
17829
|
-
# Valid
|
|
17830
|
-
#
|
|
17901
|
+
# Valid Values:
|
|
17902
|
+
#
|
|
17903
|
+
# * RDS for MariaDB - `general-public-license`
|
|
17904
|
+
#
|
|
17905
|
+
# * RDS for Microsoft SQL Server - `license-included`
|
|
17906
|
+
#
|
|
17907
|
+
# * RDS for MySQL - `general-public-license`
|
|
17908
|
+
#
|
|
17909
|
+
# * RDS for Oracle - `bring-your-own-license | license-included`
|
|
17910
|
+
#
|
|
17911
|
+
# * RDS for PostgreSQL - `postgresql-license`
|
|
17831
17912
|
#
|
|
17832
17913
|
# @option params [Integer] :iops
|
|
17833
17914
|
# The new Provisioned IOPS (I/O operations per second) value for the RDS
|
|
@@ -17855,16 +17936,20 @@ module Aws::RDS
|
|
|
17855
17936
|
# rebooting the instance, deleting the instance, creating a read replica
|
|
17856
17937
|
# for the instance, and creating a DB snapshot of the instance.
|
|
17857
17938
|
#
|
|
17858
|
-
# Constraints:
|
|
17859
|
-
#
|
|
17860
|
-
#
|
|
17861
|
-
#
|
|
17939
|
+
# Constraints:
|
|
17940
|
+
#
|
|
17941
|
+
# * For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
|
|
17942
|
+
# PostgreSQL - The value supplied must be at least 10% greater than
|
|
17943
|
+
# the current value. Values that are not at least 10% greater than the
|
|
17944
|
+
# existing value are rounded up so that they are 10% greater than the
|
|
17945
|
+
# current value.
|
|
17946
|
+
#
|
|
17947
|
+
# ^
|
|
17862
17948
|
#
|
|
17863
17949
|
# Default: Uses existing setting
|
|
17864
17950
|
#
|
|
17865
17951
|
# @option params [String] :option_group_name
|
|
17866
|
-
#
|
|
17867
|
-
# specified option group.
|
|
17952
|
+
# The option group to associate the DB instance with.
|
|
17868
17953
|
#
|
|
17869
17954
|
# Changing this parameter doesn't result in an outage, with one
|
|
17870
17955
|
# exception. If the parameter change results in an option group that
|
|
@@ -17880,16 +17965,16 @@ module Aws::RDS
|
|
|
17880
17965
|
# can't be removed from a DB instance after it is associated with a DB
|
|
17881
17966
|
# instance.
|
|
17882
17967
|
#
|
|
17883
|
-
# This setting doesn't apply to RDS Custom.
|
|
17968
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17884
17969
|
#
|
|
17885
17970
|
# @option params [String] :new_db_instance_identifier
|
|
17886
|
-
# The new
|
|
17887
|
-
#
|
|
17888
|
-
#
|
|
17889
|
-
#
|
|
17890
|
-
#
|
|
17971
|
+
# The new identifier for the DB instance when renaming a DB instance.
|
|
17972
|
+
# When you change the DB instance identifier, an instance reboot occurs
|
|
17973
|
+
# immediately if you enable `ApplyImmediately`, or will occur during the
|
|
17974
|
+
# next maintenance window if you disable `ApplyImmediately`. This value
|
|
17975
|
+
# is stored as a lowercase string.
|
|
17891
17976
|
#
|
|
17892
|
-
# This setting doesn't apply to RDS Custom.
|
|
17977
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17893
17978
|
#
|
|
17894
17979
|
# Constraints:
|
|
17895
17980
|
#
|
|
@@ -17902,7 +17987,7 @@ module Aws::RDS
|
|
|
17902
17987
|
# Example: `mydbinstance`
|
|
17903
17988
|
#
|
|
17904
17989
|
# @option params [String] :storage_type
|
|
17905
|
-
#
|
|
17990
|
+
# The storage type to associate with the DB instance.
|
|
17906
17991
|
#
|
|
17907
17992
|
# If you specify Provisioned IOPS (`io1`), you must also include a value
|
|
17908
17993
|
# for the `Iops` parameter.
|
|
@@ -17922,27 +18007,28 @@ module Aws::RDS
|
|
|
17922
18007
|
# rebooting the instance, deleting the instance, creating a read replica
|
|
17923
18008
|
# for the instance, and creating a DB snapshot of the instance.
|
|
17924
18009
|
#
|
|
17925
|
-
# Valid
|
|
18010
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
|
17926
18011
|
#
|
|
17927
|
-
# Default: `io1
|
|
18012
|
+
# Default: `io1`, if the `Iops` parameter is specified. Otherwise,
|
|
18013
|
+
# `gp2`.
|
|
17928
18014
|
#
|
|
17929
18015
|
# @option params [String] :tde_credential_arn
|
|
17930
18016
|
# The ARN from the key store with which to associate the instance for
|
|
17931
18017
|
# TDE encryption.
|
|
17932
18018
|
#
|
|
17933
|
-
# This setting doesn't apply to RDS Custom.
|
|
18019
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17934
18020
|
#
|
|
17935
18021
|
# @option params [String] :tde_credential_password
|
|
17936
18022
|
# The password for the given ARN from the key store in order to access
|
|
17937
18023
|
# the device.
|
|
17938
18024
|
#
|
|
17939
|
-
# This setting doesn't apply to RDS Custom.
|
|
18025
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17940
18026
|
#
|
|
17941
18027
|
# @option params [String] :ca_certificate_identifier
|
|
17942
|
-
#
|
|
17943
|
-
#
|
|
18028
|
+
# The CA certificate identifier to use for the DB instance6's server
|
|
18029
|
+
# certificate.
|
|
17944
18030
|
#
|
|
17945
|
-
# This setting doesn't apply to RDS Custom.
|
|
18031
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17946
18032
|
#
|
|
17947
18033
|
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
17948
18034
|
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
@@ -17964,33 +18050,79 @@ module Aws::RDS
|
|
|
17964
18050
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
|
17965
18051
|
# RDS User Guide*.
|
|
17966
18052
|
#
|
|
17967
|
-
# This setting doesn't apply to RDS Custom.
|
|
18053
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17968
18054
|
#
|
|
17969
18055
|
#
|
|
17970
18056
|
#
|
|
17971
18057
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
|
17972
18058
|
#
|
|
17973
|
-
# @option params [
|
|
17974
|
-
#
|
|
17975
|
-
#
|
|
18059
|
+
# @option params [String] :domain_fqdn
|
|
18060
|
+
# Specifies the fully qualified domain name of an Active Directory
|
|
18061
|
+
# domain.
|
|
18062
|
+
#
|
|
18063
|
+
# Constraints:
|
|
18064
|
+
#
|
|
18065
|
+
# * Cannot be greater than 64 characters.
|
|
18066
|
+
#
|
|
18067
|
+
# ^
|
|
18068
|
+
#
|
|
18069
|
+
# Example: `mymanagedADtest.mymanagedAD.mydomain`
|
|
18070
|
+
#
|
|
18071
|
+
# @option params [String] :domain_ou
|
|
18072
|
+
# The Active Directory organizational unit for your DB instance to join.
|
|
18073
|
+
#
|
|
18074
|
+
# Constraints:
|
|
18075
|
+
#
|
|
18076
|
+
# * Must be in the distinguished name format.
|
|
18077
|
+
#
|
|
18078
|
+
# * Cannot be greater than 64 characters.
|
|
18079
|
+
#
|
|
18080
|
+
# Example:
|
|
18081
|
+
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
|
17976
18082
|
#
|
|
17977
|
-
#
|
|
18083
|
+
# @option params [String] :domain_auth_secret_arn
|
|
18084
|
+
# The ARN for the Secrets Manager secret that contains the credentials
|
|
18085
|
+
# for the user performing the domain join.
|
|
17978
18086
|
#
|
|
17979
|
-
#
|
|
17980
|
-
#
|
|
17981
|
-
#
|
|
18087
|
+
# Example:
|
|
18088
|
+
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
|
18089
|
+
#
|
|
18090
|
+
# @option params [Array<String>] :domain_dns_ips
|
|
18091
|
+
# The IPv4 DNS IP addresses of your primary and secondary Active
|
|
18092
|
+
# Directory domain controllers.
|
|
18093
|
+
#
|
|
18094
|
+
# Constraints:
|
|
18095
|
+
#
|
|
18096
|
+
# * Two IP addresses must be provided. If there isn't a secondary
|
|
18097
|
+
# domain controller, use the IP address of the primary domain
|
|
18098
|
+
# controller for both entries in the list.
|
|
18099
|
+
#
|
|
18100
|
+
# ^
|
|
18101
|
+
#
|
|
18102
|
+
# Example: `123.124.125.126,234.235.236.237`
|
|
18103
|
+
#
|
|
18104
|
+
# @option params [Boolean] :copy_tags_to_snapshot
|
|
18105
|
+
# Specifies whether to copy all tags from the DB instance to snapshots
|
|
18106
|
+
# of the DB instance. By default, tags aren't copied.
|
|
18107
|
+
#
|
|
18108
|
+
# This setting doesn't apply to Amazon Aurora DB instances. Copying
|
|
18109
|
+
# tags to snapshots is managed by the DB cluster. Setting this value for
|
|
18110
|
+
# an Aurora DB instance has no effect on the DB cluster setting. For
|
|
18111
|
+
# more information, see `ModifyDBCluster`.
|
|
17982
18112
|
#
|
|
17983
18113
|
# @option params [Integer] :monitoring_interval
|
|
17984
18114
|
# 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
|
|
18115
|
+
# metrics are collected for the DB instance. To disable collection of
|
|
18116
|
+
# Enhanced Monitoring metrics, specify `0`.
|
|
17987
18117
|
#
|
|
17988
18118
|
# If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
|
|
17989
|
-
# value other than 0
|
|
18119
|
+
# value other than `0`.
|
|
17990
18120
|
#
|
|
17991
|
-
# This setting doesn't apply to RDS Custom.
|
|
18121
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
17992
18122
|
#
|
|
17993
|
-
# Valid Values: `0
|
|
18123
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
|
18124
|
+
#
|
|
18125
|
+
# Default: `0`
|
|
17994
18126
|
#
|
|
17995
18127
|
# @option params [Integer] :db_port_number
|
|
17996
18128
|
# The port number on which the database accepts connections.
|
|
@@ -18002,49 +18134,33 @@ module Aws::RDS
|
|
|
18002
18134
|
# If you change the `DBPortNumber` value, your database restarts
|
|
18003
18135
|
# regardless of the value of the `ApplyImmediately` parameter.
|
|
18004
18136
|
#
|
|
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`
|
|
18137
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18018
18138
|
#
|
|
18019
|
-
#
|
|
18020
|
-
#
|
|
18021
|
-
# Default: `5432`
|
|
18022
|
-
#
|
|
18023
|
-
# Valid values: `1150-65535`
|
|
18139
|
+
# Valid Values: `1150-65535`
|
|
18024
18140
|
#
|
|
18025
|
-
#
|
|
18141
|
+
# Default:
|
|
18026
18142
|
#
|
|
18027
|
-
#
|
|
18143
|
+
# * Amazon Aurora - `3306`
|
|
18028
18144
|
#
|
|
18029
|
-
#
|
|
18145
|
+
# * RDS for MariaDB - `3306`
|
|
18030
18146
|
#
|
|
18031
|
-
#
|
|
18147
|
+
# * RDS for Microsoft SQL Server - `1433`
|
|
18032
18148
|
#
|
|
18033
|
-
#
|
|
18149
|
+
# * RDS for MySQL - `3306`
|
|
18034
18150
|
#
|
|
18035
|
-
#
|
|
18151
|
+
# * RDS for Oracle - `1521`
|
|
18036
18152
|
#
|
|
18037
|
-
#
|
|
18038
|
-
# `3389`, `47001`, and `49152-49156`.
|
|
18153
|
+
# * RDS for PostgreSQL - `5432`
|
|
18039
18154
|
#
|
|
18040
|
-
#
|
|
18155
|
+
# Constraints:
|
|
18041
18156
|
#
|
|
18042
|
-
#
|
|
18157
|
+
# * For RDS for Microsoft SQL Server, the value can't be `1234`,
|
|
18158
|
+
# `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
|
|
18043
18159
|
#
|
|
18044
|
-
#
|
|
18160
|
+
# ^
|
|
18045
18161
|
#
|
|
18046
18162
|
# @option params [Boolean] :publicly_accessible
|
|
18047
|
-
#
|
|
18163
|
+
# Specifies whether the DB instance is publicly accessible.
|
|
18048
18164
|
#
|
|
18049
18165
|
# When the DB cluster is publicly accessible, its Domain Name System
|
|
18050
18166
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
|
@@ -18071,10 +18187,10 @@ module Aws::RDS
|
|
|
18071
18187
|
# a monitoring role, see [To create an IAM role for Amazon RDS Enhanced
|
|
18072
18188
|
# Monitoring][1] in the *Amazon RDS User Guide.*
|
|
18073
18189
|
#
|
|
18074
|
-
# If `MonitoringInterval` is set to a value other than 0
|
|
18190
|
+
# If `MonitoringInterval` is set to a value other than `0`, supply a
|
|
18075
18191
|
# `MonitoringRoleArn` value.
|
|
18076
18192
|
#
|
|
18077
|
-
# This setting doesn't apply to RDS Custom.
|
|
18193
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18078
18194
|
#
|
|
18079
18195
|
#
|
|
18080
18196
|
#
|
|
@@ -18084,28 +18200,32 @@ module Aws::RDS
|
|
|
18084
18200
|
# The name of the IAM role to use when making API calls to the Directory
|
|
18085
18201
|
# Service.
|
|
18086
18202
|
#
|
|
18087
|
-
# This setting doesn't apply to RDS Custom.
|
|
18203
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18204
|
+
#
|
|
18205
|
+
# @option params [Boolean] :disable_domain
|
|
18206
|
+
# Boolean. If present, removes the instance from the Active Directory
|
|
18207
|
+
# domain.
|
|
18088
18208
|
#
|
|
18089
18209
|
# @option params [Integer] :promotion_tier
|
|
18090
|
-
#
|
|
18091
|
-
#
|
|
18092
|
-
#
|
|
18093
|
-
#
|
|
18210
|
+
# The order of priority in which an Aurora Replica is promoted to the
|
|
18211
|
+
# primary instance after a failure of the existing primary instance. For
|
|
18212
|
+
# more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
|
|
18213
|
+
# in the *Amazon Aurora User Guide*.
|
|
18094
18214
|
#
|
|
18095
|
-
# This setting doesn't apply to RDS Custom.
|
|
18215
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18096
18216
|
#
|
|
18097
|
-
# Default: 1
|
|
18217
|
+
# Default: `1`
|
|
18098
18218
|
#
|
|
18099
|
-
# Valid Values: 0 - 15
|
|
18219
|
+
# Valid Values: `0 - 15`
|
|
18100
18220
|
#
|
|
18101
18221
|
#
|
|
18102
18222
|
#
|
|
18103
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
|
18223
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
|
|
18104
18224
|
#
|
|
18105
18225
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
18106
|
-
#
|
|
18107
|
-
#
|
|
18108
|
-
#
|
|
18226
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
|
18227
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
|
18228
|
+
# mapping isn't enabled.
|
|
18109
18229
|
#
|
|
18110
18230
|
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
|
18111
18231
|
# Services IAM accounts to database accounts is managed by the DB
|
|
@@ -18115,20 +18235,19 @@ module Aws::RDS
|
|
|
18115
18235
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
|
18116
18236
|
# RDS User Guide.*
|
|
18117
18237
|
#
|
|
18118
|
-
# This setting doesn't apply to RDS Custom.
|
|
18238
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18119
18239
|
#
|
|
18120
18240
|
#
|
|
18121
18241
|
#
|
|
18122
18242
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
|
18123
18243
|
#
|
|
18124
18244
|
# @option params [Boolean] :enable_performance_insights
|
|
18125
|
-
#
|
|
18126
|
-
# DB instance.
|
|
18245
|
+
# Specifies whether to enable Performance Insights for the DB instance.
|
|
18127
18246
|
#
|
|
18128
18247
|
# For more information, see [Using Amazon Performance Insights][1] in
|
|
18129
18248
|
# the *Amazon RDS User Guide*.
|
|
18130
18249
|
#
|
|
18131
|
-
# This setting doesn't apply to RDS Custom.
|
|
18250
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18132
18251
|
#
|
|
18133
18252
|
#
|
|
18134
18253
|
#
|
|
@@ -18141,65 +18260,60 @@ module Aws::RDS
|
|
|
18141
18260
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
|
18142
18261
|
# alias ARN, or alias name for the KMS key.
|
|
18143
18262
|
#
|
|
18144
|
-
# If you
|
|
18263
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
|
18145
18264
|
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
|
18146
18265
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
|
18147
18266
|
# a different default KMS key for each Amazon Web Services Region.
|
|
18148
18267
|
#
|
|
18149
|
-
# This setting doesn't apply to RDS Custom.
|
|
18268
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18150
18269
|
#
|
|
18151
18270
|
# @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:
|
|
18154
|
-
#
|
|
18155
|
-
# * 7
|
|
18156
|
-
#
|
|
18157
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
|
18158
|
-
#
|
|
18159
|
-
# * 731
|
|
18271
|
+
# The number of days to retain Performance Insights data.
|
|
18160
18272
|
#
|
|
18161
|
-
#
|
|
18273
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18162
18274
|
#
|
|
18163
|
-
#
|
|
18275
|
+
# Valid Values:
|
|
18164
18276
|
#
|
|
18165
|
-
# *
|
|
18277
|
+
# * `7`
|
|
18166
18278
|
#
|
|
18167
|
-
# *
|
|
18279
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
|
18280
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
|
18281
|
+
# months * 31)
|
|
18168
18282
|
#
|
|
18169
|
-
# * 731
|
|
18283
|
+
# * `731`
|
|
18170
18284
|
#
|
|
18171
|
-
#
|
|
18172
|
-
# value, RDS issues an error.
|
|
18285
|
+
# Default: `7` days
|
|
18173
18286
|
#
|
|
18174
|
-
#
|
|
18287
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
|
18288
|
+
# Amazon RDS returns an error.
|
|
18175
18289
|
#
|
|
18176
18290
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
|
18177
|
-
# The
|
|
18178
|
-
#
|
|
18291
|
+
# The log types to be enabled for export to CloudWatch Logs for a
|
|
18292
|
+
# specific DB instance.
|
|
18179
18293
|
#
|
|
18180
18294
|
# A change to the `CloudwatchLogsExportConfiguration` parameter is
|
|
18181
18295
|
# always applied to the DB instance immediately. Therefore, the
|
|
18182
18296
|
# `ApplyImmediately` parameter has no effect.
|
|
18183
18297
|
#
|
|
18184
|
-
# This setting doesn't apply to RDS Custom.
|
|
18298
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18185
18299
|
#
|
|
18186
18300
|
# @option params [Array<Types::ProcessorFeature>] :processor_features
|
|
18187
18301
|
# The number of CPU cores and the number of threads per core for the DB
|
|
18188
18302
|
# instance class of the DB instance.
|
|
18189
18303
|
#
|
|
18190
|
-
# This setting doesn't apply to RDS Custom.
|
|
18304
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18191
18305
|
#
|
|
18192
18306
|
# @option params [Boolean] :use_default_processor_features
|
|
18193
|
-
#
|
|
18194
|
-
#
|
|
18307
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
|
18308
|
+
# default processor features.
|
|
18195
18309
|
#
|
|
18196
|
-
# This setting doesn't apply to RDS Custom.
|
|
18310
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18197
18311
|
#
|
|
18198
18312
|
# @option params [Boolean] :deletion_protection
|
|
18199
|
-
#
|
|
18200
|
-
#
|
|
18201
|
-
#
|
|
18202
|
-
#
|
|
18313
|
+
# Specifies whether the DB instance has deletion protection enabled. The
|
|
18314
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
18315
|
+
# default, deletion protection isn't enabled. For more information, see
|
|
18316
|
+
# [ Deleting a DB Instance][1].
|
|
18203
18317
|
#
|
|
18204
18318
|
#
|
|
18205
18319
|
#
|
|
@@ -18213,15 +18327,15 @@ module Aws::RDS
|
|
|
18213
18327
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
|
18214
18328
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
|
18215
18329
|
#
|
|
18216
|
-
# This setting doesn't apply to RDS Custom.
|
|
18330
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18217
18331
|
#
|
|
18218
18332
|
#
|
|
18219
18333
|
#
|
|
18220
18334
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
18221
18335
|
#
|
|
18222
18336
|
# @option params [Boolean] :certificate_rotation_restart
|
|
18223
|
-
#
|
|
18224
|
-
#
|
|
18337
|
+
# Specifies whether the DB instance is restarted when you rotate your
|
|
18338
|
+
# SSL/TLS certificate.
|
|
18225
18339
|
#
|
|
18226
18340
|
# By default, the DB instance is restarted when you rotate your SSL/TLS
|
|
18227
18341
|
# certificate. The certificate is not updated until the DB instance is
|
|
@@ -18242,7 +18356,7 @@ module Aws::RDS
|
|
|
18242
18356
|
# Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
|
|
18243
18357
|
# the *Amazon Aurora User Guide*.
|
|
18244
18358
|
#
|
|
18245
|
-
# This setting doesn't apply to RDS Custom.
|
|
18359
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18246
18360
|
#
|
|
18247
18361
|
#
|
|
18248
18362
|
#
|
|
@@ -18265,15 +18379,15 @@ module Aws::RDS
|
|
|
18265
18379
|
# more information, see [Working with Oracle Read Replicas for Amazon
|
|
18266
18380
|
# RDS][1] in the *Amazon RDS User Guide*.
|
|
18267
18381
|
#
|
|
18268
|
-
# This setting doesn't apply to RDS Custom.
|
|
18382
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18269
18383
|
#
|
|
18270
18384
|
#
|
|
18271
18385
|
#
|
|
18272
18386
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
|
18273
18387
|
#
|
|
18274
18388
|
# @option params [Boolean] :enable_customer_owned_ip
|
|
18275
|
-
#
|
|
18276
|
-
#
|
|
18389
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
18390
|
+
# RDS on Outposts DB instance.
|
|
18277
18391
|
#
|
|
18278
18392
|
# A *CoIP* provides local or external connectivity to resources in your
|
|
18279
18393
|
# Outpost subnets through your on-premises network. For some use cases,
|
|
@@ -18296,27 +18410,28 @@ module Aws::RDS
|
|
|
18296
18410
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
18297
18411
|
# Services Backup.
|
|
18298
18412
|
#
|
|
18299
|
-
# This setting doesn't apply to RDS Custom.
|
|
18413
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
18300
18414
|
#
|
|
18301
18415
|
# @option params [String] :automation_mode
|
|
18302
|
-
# The automation mode of the RDS Custom DB instance
|
|
18303
|
-
#
|
|
18304
|
-
#
|
|
18305
|
-
#
|
|
18416
|
+
# The automation mode of the RDS Custom DB instance. If `full`, the DB
|
|
18417
|
+
# instance automates monitoring and instance recovery. If `all paused`,
|
|
18418
|
+
# the instance pauses automation for the duration set by
|
|
18419
|
+
# `ResumeFullAutomationModeMinutes`.
|
|
18306
18420
|
#
|
|
18307
18421
|
# @option params [Integer] :resume_full_automation_mode_minutes
|
|
18308
18422
|
# 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`.
|
|
18423
|
+
# ends, RDS Custom resumes full automation.
|
|
18311
18424
|
#
|
|
18312
|
-
#
|
|
18313
|
-
# The network type of the DB instance.
|
|
18425
|
+
# Default: `60`
|
|
18314
18426
|
#
|
|
18315
|
-
#
|
|
18427
|
+
# Constraints:
|
|
18316
18428
|
#
|
|
18317
|
-
# *
|
|
18429
|
+
# * Must be at least 60.
|
|
18318
18430
|
#
|
|
18319
|
-
# *
|
|
18431
|
+
# * Must be no more than 1,440.
|
|
18432
|
+
#
|
|
18433
|
+
# @option params [String] :network_type
|
|
18434
|
+
# The network type of the DB instance.
|
|
18320
18435
|
#
|
|
18321
18436
|
# The network type is determined by the `DBSubnetGroup` specified for
|
|
18322
18437
|
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
@@ -18325,20 +18440,23 @@ module Aws::RDS
|
|
|
18325
18440
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
18326
18441
|
# the *Amazon RDS User Guide.*
|
|
18327
18442
|
#
|
|
18443
|
+
# Valid Values: `IPV4 | DUAL`
|
|
18444
|
+
#
|
|
18328
18445
|
#
|
|
18329
18446
|
#
|
|
18330
18447
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
18331
18448
|
#
|
|
18332
18449
|
# @option params [Integer] :storage_throughput
|
|
18333
|
-
#
|
|
18450
|
+
# The storage throughput value for the DB instance.
|
|
18334
18451
|
#
|
|
18335
18452
|
# This setting applies only to the `gp3` storage type.
|
|
18336
18453
|
#
|
|
18337
|
-
# This setting doesn't apply to
|
|
18454
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
18455
|
+
# instances.
|
|
18338
18456
|
#
|
|
18339
18457
|
# @option params [Boolean] :manage_master_user_password
|
|
18340
|
-
#
|
|
18341
|
-
#
|
|
18458
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
18459
|
+
# Services Secrets Manager.
|
|
18342
18460
|
#
|
|
18343
18461
|
# If the DB instance doesn't manage the master user password with
|
|
18344
18462
|
# Amazon Web Services Secrets Manager, you can turn on this management.
|
|
@@ -18347,9 +18465,9 @@ module Aws::RDS
|
|
|
18347
18465
|
# If the DB instance already manages the master user password with
|
|
18348
18466
|
# Amazon Web Services Secrets Manager, and you specify that the master
|
|
18349
18467
|
# 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`.
|
|
18468
|
+
# then you must specify `MasterUserPassword`. In this case, Amazon RDS
|
|
18469
|
+
# deletes the secret and uses the new password for the master user
|
|
18470
|
+
# specified by `MasterUserPassword`.
|
|
18353
18471
|
#
|
|
18354
18472
|
# For more information, see [Password management with Amazon Web
|
|
18355
18473
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
|
@@ -18366,8 +18484,8 @@ module Aws::RDS
|
|
|
18366
18484
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
18367
18485
|
#
|
|
18368
18486
|
# @option params [Boolean] :rotate_master_user_password
|
|
18369
|
-
#
|
|
18370
|
-
#
|
|
18487
|
+
# Specifies whether to rotate the secret managed by Amazon Web Services
|
|
18488
|
+
# Secrets Manager for the master user password.
|
|
18371
18489
|
#
|
|
18372
18490
|
# This setting is valid only if the master user password is managed by
|
|
18373
18491
|
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
|
@@ -18532,12 +18650,17 @@ module Aws::RDS
|
|
|
18532
18650
|
# tde_credential_password: "String",
|
|
18533
18651
|
# ca_certificate_identifier: "String",
|
|
18534
18652
|
# domain: "String",
|
|
18653
|
+
# domain_fqdn: "String",
|
|
18654
|
+
# domain_ou: "String",
|
|
18655
|
+
# domain_auth_secret_arn: "String",
|
|
18656
|
+
# domain_dns_ips: ["String"],
|
|
18535
18657
|
# copy_tags_to_snapshot: false,
|
|
18536
18658
|
# monitoring_interval: 1,
|
|
18537
18659
|
# db_port_number: 1,
|
|
18538
18660
|
# publicly_accessible: false,
|
|
18539
18661
|
# monitoring_role_arn: "String",
|
|
18540
18662
|
# domain_iam_role_name: "String",
|
|
18663
|
+
# disable_domain: false,
|
|
18541
18664
|
# promotion_tier: 1,
|
|
18542
18665
|
# enable_iam_database_authentication: false,
|
|
18543
18666
|
# enable_performance_insights: false,
|
|
@@ -18671,6 +18794,10 @@ module Aws::RDS
|
|
|
18671
18794
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
18672
18795
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
18673
18796
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
18797
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
18798
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
18799
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
18800
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
18674
18801
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
18675
18802
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
18676
18803
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -19097,6 +19224,12 @@ module Aws::RDS
|
|
|
19097
19224
|
#
|
|
19098
19225
|
# **Oracle**
|
|
19099
19226
|
#
|
|
19227
|
+
# * `19.0.0.0.ru-2022-01.rur-2022-01.r1` (supported for 12.2.0.1 DB
|
|
19228
|
+
# snapshots)
|
|
19229
|
+
#
|
|
19230
|
+
# * `19.0.0.0.ru-2022-07.rur-2022-07.r1` (supported for 12.1.0.2 DB
|
|
19231
|
+
# snapshots)
|
|
19232
|
+
#
|
|
19100
19233
|
# * `12.1.0.2.v8` (supported for 12.1.0.1 DB snapshots)
|
|
19101
19234
|
#
|
|
19102
19235
|
# * `11.2.0.4.v12` (supported for 11.2.0.2 DB snapshots)
|
|
@@ -20071,6 +20204,10 @@ module Aws::RDS
|
|
|
20071
20204
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
20072
20205
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
20073
20206
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
20207
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
20208
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
20209
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
20210
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
20074
20211
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
20075
20212
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
20076
20213
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -20235,6 +20372,10 @@ module Aws::RDS
|
|
|
20235
20372
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
20236
20373
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
20237
20374
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
20375
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
20376
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
20377
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
20378
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
20238
20379
|
# resp.db_cluster.tag_list #=> Array
|
|
20239
20380
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
20240
20381
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -20506,6 +20647,10 @@ module Aws::RDS
|
|
|
20506
20647
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
20507
20648
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
20508
20649
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
20650
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
20651
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
20652
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
20653
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
20509
20654
|
# resp.db_cluster.tag_list #=> Array
|
|
20510
20655
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
20511
20656
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -20726,6 +20871,10 @@ module Aws::RDS
|
|
|
20726
20871
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
20727
20872
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
20728
20873
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
20874
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
20875
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
20876
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
20877
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
20729
20878
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
20730
20879
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
20731
20880
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -21954,6 +22103,10 @@ module Aws::RDS
|
|
|
21954
22103
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
21955
22104
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
21956
22105
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
22106
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
22107
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
22108
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
22109
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
21957
22110
|
# resp.db_cluster.tag_list #=> Array
|
|
21958
22111
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
21959
22112
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -22642,6 +22795,10 @@ module Aws::RDS
|
|
|
22642
22795
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
22643
22796
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
22644
22797
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
22798
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
22799
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
22800
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
22801
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
22645
22802
|
# resp.db_cluster.tag_list #=> Array
|
|
22646
22803
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
22647
22804
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -23299,6 +23456,10 @@ module Aws::RDS
|
|
|
23299
23456
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
23300
23457
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
23301
23458
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
23459
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
23460
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
23461
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
23462
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
23302
23463
|
# resp.db_cluster.tag_list #=> Array
|
|
23303
23464
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
23304
23465
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -23600,6 +23761,53 @@ module Aws::RDS
|
|
|
23600
23761
|
#
|
|
23601
23762
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
|
23602
23763
|
#
|
|
23764
|
+
# @option params [String] :domain_fqdn
|
|
23765
|
+
# Specifies the fully qualified domain name of an Active Directory
|
|
23766
|
+
# domain.
|
|
23767
|
+
#
|
|
23768
|
+
# Constraints:
|
|
23769
|
+
#
|
|
23770
|
+
# * Cannot be greater than 64 characters.
|
|
23771
|
+
#
|
|
23772
|
+
# ^
|
|
23773
|
+
#
|
|
23774
|
+
# Example: `mymanagedADtest.mymanagedAD.mydomain`
|
|
23775
|
+
#
|
|
23776
|
+
# @option params [String] :domain_ou
|
|
23777
|
+
# The Active Directory organizational unit for your DB instance to join.
|
|
23778
|
+
#
|
|
23779
|
+
# Constraints:
|
|
23780
|
+
#
|
|
23781
|
+
# * Must be in the distinguished name format.
|
|
23782
|
+
#
|
|
23783
|
+
# * Cannot be greater than 64 characters.
|
|
23784
|
+
#
|
|
23785
|
+
# Example:
|
|
23786
|
+
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
|
23787
|
+
#
|
|
23788
|
+
# @option params [String] :domain_auth_secret_arn
|
|
23789
|
+
# The ARN for the Secrets Manager secret that contains the credentials
|
|
23790
|
+
# for the user performing the domain join.
|
|
23791
|
+
#
|
|
23792
|
+
# Constraints:
|
|
23793
|
+
#
|
|
23794
|
+
# Example:
|
|
23795
|
+
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
|
23796
|
+
#
|
|
23797
|
+
# @option params [Array<String>] :domain_dns_ips
|
|
23798
|
+
# The IPv4 DNS IP addresses of your primary and secondary Active
|
|
23799
|
+
# Directory domain controllers.
|
|
23800
|
+
#
|
|
23801
|
+
# Constraints:
|
|
23802
|
+
#
|
|
23803
|
+
# * Two IP addresses must be provided. If there isn't a secondary
|
|
23804
|
+
# domain controller, use the IP address of the primary domain
|
|
23805
|
+
# controller for both entries in the list.
|
|
23806
|
+
#
|
|
23807
|
+
# ^
|
|
23808
|
+
#
|
|
23809
|
+
# Example: `123.124.125.126,234.235.236.237`
|
|
23810
|
+
#
|
|
23603
23811
|
# @option params [Boolean] :copy_tags_to_snapshot
|
|
23604
23812
|
# A value that indicates whether to copy all tags from the restored DB
|
|
23605
23813
|
# instance to snapshots of the DB instance.
|
|
@@ -23884,6 +24092,10 @@ module Aws::RDS
|
|
|
23884
24092
|
# tde_credential_password: "String",
|
|
23885
24093
|
# vpc_security_group_ids: ["String"],
|
|
23886
24094
|
# domain: "String",
|
|
24095
|
+
# domain_fqdn: "String",
|
|
24096
|
+
# domain_ou: "String",
|
|
24097
|
+
# domain_auth_secret_arn: "String",
|
|
24098
|
+
# domain_dns_ips: ["String"],
|
|
23887
24099
|
# copy_tags_to_snapshot: false,
|
|
23888
24100
|
# domain_iam_role_name: "String",
|
|
23889
24101
|
# enable_iam_database_authentication: false,
|
|
@@ -24007,6 +24219,10 @@ module Aws::RDS
|
|
|
24007
24219
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
24008
24220
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
24009
24221
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
24222
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
24223
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
24224
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
24225
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
24010
24226
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
24011
24227
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
24012
24228
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -24735,6 +24951,10 @@ module Aws::RDS
|
|
|
24735
24951
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
24736
24952
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
24737
24953
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
24954
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
24955
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
24956
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
24957
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
24738
24958
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
24739
24959
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
24740
24960
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -25061,6 +25281,57 @@ module Aws::RDS
|
|
|
25061
25281
|
#
|
|
25062
25282
|
# This setting doesn't apply to RDS Custom.
|
|
25063
25283
|
#
|
|
25284
|
+
# @option params [String] :domain_fqdn
|
|
25285
|
+
# Specifies the fully qualified domain name of an Active Directory
|
|
25286
|
+
# domain.
|
|
25287
|
+
#
|
|
25288
|
+
# Constraints:
|
|
25289
|
+
#
|
|
25290
|
+
# * Cannot be greater than 64 characters.
|
|
25291
|
+
#
|
|
25292
|
+
# ^
|
|
25293
|
+
#
|
|
25294
|
+
# Example: `mymanagedADtest.mymanagedAD.mydomain`
|
|
25295
|
+
#
|
|
25296
|
+
# @option params [String] :domain_ou
|
|
25297
|
+
# The Active Directory organizational unit for your DB instance to join.
|
|
25298
|
+
#
|
|
25299
|
+
# Constraints:
|
|
25300
|
+
#
|
|
25301
|
+
# * Must be in the distinguished name format.
|
|
25302
|
+
#
|
|
25303
|
+
# * Cannot be greater than 64 characters.
|
|
25304
|
+
#
|
|
25305
|
+
# Example:
|
|
25306
|
+
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
|
25307
|
+
#
|
|
25308
|
+
# @option params [String] :domain_auth_secret_arn
|
|
25309
|
+
# The ARN for the Secrets Manager secret that contains the credentials
|
|
25310
|
+
# for the user performing the domain join.
|
|
25311
|
+
#
|
|
25312
|
+
# Constraints:
|
|
25313
|
+
#
|
|
25314
|
+
# * Cannot be greater than 64 characters.
|
|
25315
|
+
#
|
|
25316
|
+
# ^
|
|
25317
|
+
#
|
|
25318
|
+
# Example:
|
|
25319
|
+
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
|
25320
|
+
#
|
|
25321
|
+
# @option params [Array<String>] :domain_dns_ips
|
|
25322
|
+
# The IPv4 DNS IP addresses of your primary and secondary Active
|
|
25323
|
+
# Directory domain controllers.
|
|
25324
|
+
#
|
|
25325
|
+
# Constraints:
|
|
25326
|
+
#
|
|
25327
|
+
# * Two IP addresses must be provided. If there isn't a secondary
|
|
25328
|
+
# domain controller, use the IP address of the primary domain
|
|
25329
|
+
# controller for both entries in the list.
|
|
25330
|
+
#
|
|
25331
|
+
# ^
|
|
25332
|
+
#
|
|
25333
|
+
# Example: `123.124.125.126,234.235.236.237`
|
|
25334
|
+
#
|
|
25064
25335
|
# @option params [Boolean] :enable_iam_database_authentication
|
|
25065
25336
|
# A value that indicates whether to enable mapping of Amazon Web
|
|
25066
25337
|
# Services Identity and Access Management (IAM) accounts to database
|
|
@@ -25379,6 +25650,10 @@ module Aws::RDS
|
|
|
25379
25650
|
# vpc_security_group_ids: ["String"],
|
|
25380
25651
|
# domain: "String",
|
|
25381
25652
|
# domain_iam_role_name: "String",
|
|
25653
|
+
# domain_fqdn: "String",
|
|
25654
|
+
# domain_ou: "String",
|
|
25655
|
+
# domain_auth_secret_arn: "String",
|
|
25656
|
+
# domain_dns_ips: ["String"],
|
|
25382
25657
|
# enable_iam_database_authentication: false,
|
|
25383
25658
|
# enable_cloudwatch_logs_exports: ["String"],
|
|
25384
25659
|
# processor_features: [
|
|
@@ -25502,6 +25777,10 @@ module Aws::RDS
|
|
|
25502
25777
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
25503
25778
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
25504
25779
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
25780
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
25781
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
25782
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
25783
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
25505
25784
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
25506
25785
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
25507
25786
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -25894,6 +26173,10 @@ module Aws::RDS
|
|
|
25894
26173
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
25895
26174
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
25896
26175
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
26176
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
26177
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
26178
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
26179
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
25897
26180
|
# resp.db_cluster.tag_list #=> Array
|
|
25898
26181
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
25899
26182
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -26085,6 +26368,10 @@ module Aws::RDS
|
|
|
26085
26368
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
26086
26369
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
26087
26370
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
26371
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
26372
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
26373
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
26374
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
26088
26375
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
26089
26376
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
26090
26377
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -26697,6 +26984,10 @@ module Aws::RDS
|
|
|
26697
26984
|
# resp.db_cluster.domain_memberships[0].status #=> String
|
|
26698
26985
|
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
|
26699
26986
|
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
|
26987
|
+
# resp.db_cluster.domain_memberships[0].ou #=> String
|
|
26988
|
+
# resp.db_cluster.domain_memberships[0].auth_secret_arn #=> String
|
|
26989
|
+
# resp.db_cluster.domain_memberships[0].dns_ips #=> Array
|
|
26990
|
+
# resp.db_cluster.domain_memberships[0].dns_ips[0] #=> String
|
|
26700
26991
|
# resp.db_cluster.tag_list #=> Array
|
|
26701
26992
|
# resp.db_cluster.tag_list[0].key #=> String
|
|
26702
26993
|
# resp.db_cluster.tag_list[0].value #=> String
|
|
@@ -26895,6 +27186,10 @@ module Aws::RDS
|
|
|
26895
27186
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
26896
27187
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
26897
27188
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
27189
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
27190
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
27191
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
27192
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
26898
27193
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
26899
27194
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
26900
27195
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -27395,6 +27690,10 @@ module Aws::RDS
|
|
|
27395
27690
|
# resp.db_instance.domain_memberships[0].status #=> String
|
|
27396
27691
|
# resp.db_instance.domain_memberships[0].fqdn #=> String
|
|
27397
27692
|
# resp.db_instance.domain_memberships[0].iam_role_name #=> String
|
|
27693
|
+
# resp.db_instance.domain_memberships[0].ou #=> String
|
|
27694
|
+
# resp.db_instance.domain_memberships[0].auth_secret_arn #=> String
|
|
27695
|
+
# resp.db_instance.domain_memberships[0].dns_ips #=> Array
|
|
27696
|
+
# resp.db_instance.domain_memberships[0].dns_ips[0] #=> String
|
|
27398
27697
|
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
|
27399
27698
|
# resp.db_instance.monitoring_interval #=> Integer
|
|
27400
27699
|
# resp.db_instance.enhanced_monitoring_resource_arn #=> String
|
|
@@ -27469,7 +27768,7 @@ module Aws::RDS
|
|
|
27469
27768
|
params: params,
|
|
27470
27769
|
config: config)
|
|
27471
27770
|
context[:gem_name] = 'aws-sdk-rds'
|
|
27472
|
-
context[:gem_version] = '1.
|
|
27771
|
+
context[:gem_version] = '1.183.0'
|
|
27473
27772
|
Seahorse::Client::Request.new(handlers, context)
|
|
27474
27773
|
end
|
|
27475
27774
|
|