aws-sdk-rds 1.80.0 → 1.81.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.
Files changed (33) hide show
  1. checksums.yaml +5 -5
  2. data/lib/aws-sdk-rds.rb +1 -1
  3. data/lib/aws-sdk-rds/account_quota.rb +13 -11
  4. data/lib/aws-sdk-rds/certificate.rb +13 -11
  5. data/lib/aws-sdk-rds/client.rb +231 -136
  6. data/lib/aws-sdk-rds/customizations/auth_token_generator.rb +6 -3
  7. data/lib/aws-sdk-rds/db_cluster.rb +41 -24
  8. data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +13 -11
  9. data/lib/aws-sdk-rds/db_cluster_snapshot.rb +14 -12
  10. data/lib/aws-sdk-rds/db_engine.rb +13 -11
  11. data/lib/aws-sdk-rds/db_engine_version.rb +20 -12
  12. data/lib/aws-sdk-rds/db_instance.rb +98 -76
  13. data/lib/aws-sdk-rds/db_log_file.rb +13 -11
  14. data/lib/aws-sdk-rds/db_parameter_group.rb +13 -11
  15. data/lib/aws-sdk-rds/db_parameter_group_family.rb +13 -11
  16. data/lib/aws-sdk-rds/db_security_group.rb +13 -11
  17. data/lib/aws-sdk-rds/db_snapshot.rb +13 -11
  18. data/lib/aws-sdk-rds/db_snapshot_attribute.rb +13 -11
  19. data/lib/aws-sdk-rds/db_subnet_group.rb +13 -11
  20. data/lib/aws-sdk-rds/event.rb +13 -11
  21. data/lib/aws-sdk-rds/event_category_map.rb +13 -11
  22. data/lib/aws-sdk-rds/event_subscription.rb +13 -11
  23. data/lib/aws-sdk-rds/option_group.rb +13 -11
  24. data/lib/aws-sdk-rds/option_group_option.rb +13 -11
  25. data/lib/aws-sdk-rds/parameter.rb +13 -11
  26. data/lib/aws-sdk-rds/pending_maintenance_action.rb +13 -11
  27. data/lib/aws-sdk-rds/reserved_db_instance.rb +13 -11
  28. data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +13 -11
  29. data/lib/aws-sdk-rds/resource.rb +29 -20
  30. data/lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb +13 -11
  31. data/lib/aws-sdk-rds/types.rb +174 -118
  32. data/lib/aws-sdk-rds/waiters.rb +66 -0
  33. metadata +3 -3
@@ -75,7 +75,8 @@ module Aws::RDS
75
75
  # Waiter polls an API operation until a resource enters a desired
76
76
  # state.
77
77
  #
78
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
78
+ # @note The waiting operation is performed on a copy. The original resource
79
+ # remains unchanged.
79
80
  #
80
81
  # ## Basic Usage
81
82
  #
@@ -88,13 +89,15 @@ module Aws::RDS
88
89
  #
89
90
  # ## Example
90
91
  #
91
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
92
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
93
+ # instance.state.name == 'running'
94
+ # end
92
95
  #
93
96
  # ## Configuration
94
97
  #
95
98
  # You can configure the maximum number of polling attempts, and the
96
- # delay (in seconds) between each polling attempt. The waiting condition is set
97
- # by passing a block to {#wait_until}:
99
+ # delay (in seconds) between each polling attempt. The waiting condition is
100
+ # set by passing a block to {#wait_until}:
98
101
  #
99
102
  # # poll for ~25 seconds
100
103
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -125,17 +128,16 @@ module Aws::RDS
125
128
  # # resource did not enter the desired state in time
126
129
  # end
127
130
  #
131
+ # @yieldparam [Resource] resource to be used in the waiting condition.
128
132
  #
129
- # @yield param [Resource] resource to be used in the waiting condition
130
- #
131
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
132
- # because the waiter has entered a state that it will not transition
133
- # out of, preventing success.
133
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
134
+ # terminates because the waiter has entered a state that it will not
135
+ # transition out of, preventing success.
134
136
  #
135
137
  # yet successful.
136
138
  #
137
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
138
- # while polling for a resource that is not expected.
139
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
140
+ # encountered while polling for a resource that is not expected.
139
141
  #
140
142
  # @raise [NotImplementedError] Raised when the resource does not
141
143
  #
@@ -90,10 +90,10 @@ module Aws::RDS
90
90
  # excluding default option groups. The used value is the count of
91
91
  # nondefault DB option groups in the account.
92
92
  #
93
- # * `ReadReplicasPerMaster` - The number of Read Replicas per DB
94
- # instance. The used value is the highest number of Read Replicas for
93
+ # * `ReadReplicasPerMaster` - The number of read replicas per DB
94
+ # instance. The used value is the highest number of read replicas for
95
95
  # a DB instance in the account. Other DB instances in the account
96
- # might have a lower number of Read Replicas.
96
+ # might have a lower number of read replicas.
97
97
  #
98
98
  # * `ReservedDBInstances` - The number of reserved DB instances per
99
99
  # account. The used value is the count of the active reserved DB
@@ -1051,7 +1051,7 @@ module Aws::RDS
1051
1051
  # copying an encrypted DB cluster snapshot in the same AWS Region.
1052
1052
  #
1053
1053
  # The pre-signed URL must be a valid request for the
1054
- # `CopyDBSClusterSnapshot` API action that can be executed in the
1054
+ # `CopyDBClusterSnapshot` API action that can be executed in the
1055
1055
  # source AWS Region that contains the encrypted DB cluster snapshot to
1056
1056
  # be copied. The pre-signed URL request must contain the following
1057
1057
  # parameter values:
@@ -1899,7 +1899,7 @@ module Aws::RDS
1899
1899
  #
1900
1900
  # @!attribute [rw] replication_source_identifier
1901
1901
  # The Amazon Resource Name (ARN) of the source DB instance or DB
1902
- # cluster if this DB cluster is created as a Read Replica.
1902
+ # cluster if this DB cluster is created as a read replica.
1903
1903
  # @return [String]
1904
1904
  #
1905
1905
  # @!attribute [rw] tags
@@ -1934,10 +1934,10 @@ module Aws::RDS
1934
1934
  # Your AWS account has a different default encryption key for each AWS
1935
1935
  # Region.
1936
1936
  #
1937
- # If you create a Read Replica of an encrypted DB cluster in another
1937
+ # If you create a read replica of an encrypted DB cluster in another
1938
1938
  # AWS Region, you must set `KmsKeyId` to a KMS key ID that is valid in
1939
- # the destination AWS Region. This key is used to encrypt the Read
1940
- # Replica in that AWS Region.
1939
+ # the destination AWS Region. This key is used to encrypt the read
1940
+ # replica in that AWS Region.
1941
1941
  # @return [String]
1942
1942
  #
1943
1943
  # @!attribute [rw] pre_signed_url
@@ -1960,8 +1960,8 @@ module Aws::RDS
1960
1960
  # `CreateDBCluster` action that is called in the destination AWS
1961
1961
  # Region, and the action contained in the pre-signed URL.
1962
1962
  #
1963
- # * `DestinationRegion` - The name of the AWS Region that Aurora Read
1964
- # Replica will be created in.
1963
+ # * `DestinationRegion` - The name of the AWS Region that Aurora read
1964
+ # replica will be created in.
1965
1965
  #
1966
1966
  # * `ReplicationSourceIdentifier` - The DB cluster identifier for the
1967
1967
  # encrypted DB cluster to be copied. This identifier must be in the
@@ -2031,6 +2031,13 @@ module Aws::RDS
2031
2031
  # The DB engine mode of the DB cluster, either `provisioned`,
2032
2032
  # `serverless`, `parallelquery`, `global`, or `multimaster`.
2033
2033
  #
2034
+ # <note markdown="1"> `global` engine mode only applies for global database clusters
2035
+ # created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
2036
+ # versions, the clusters in a global database use `provisioned` engine
2037
+ # mode.
2038
+ #
2039
+ # </note>
2040
+ #
2034
2041
  # Limitations and requirements apply to some DB engine modes. For more
2035
2042
  # information, see the following sections in the *Amazon Aurora User
2036
2043
  # Guide*\:
@@ -2095,12 +2102,12 @@ module Aws::RDS
2095
2102
  #
2096
2103
  # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
2097
2104
  # Authentication to authenticate users that connect to the DB cluster.
2098
- # For more information, see [Using Kerberos Authentication for Aurora
2099
- # MySQL][1] in the *Amazon Aurora User Guide*.
2105
+ # For more information, see [Kerberos Authentication][1] in the
2106
+ # *Amazon Aurora User Guide*.
2100
2107
  #
2101
2108
  #
2102
2109
  #
2103
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html
2110
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
2104
2111
  # @return [String]
2105
2112
  #
2106
2113
  # @!attribute [rw] domain_iam_role_name
@@ -2807,7 +2814,7 @@ module Aws::RDS
2807
2814
  #
2808
2815
  # * Must be a value from 0 to 35
2809
2816
  #
2810
- # * Can't be set to 0 if the DB instance is a source to Read Replicas
2817
+ # * Can't be set to 0 if the DB instance is a source to read replicas
2811
2818
  # @return [Integer]
2812
2819
  #
2813
2820
  # @!attribute [rw] preferred_backup_window
@@ -2849,7 +2856,7 @@ module Aws::RDS
2849
2856
  #
2850
2857
  # Default: `3306`
2851
2858
  #
2852
- # Valid Values: `1150-65535`
2859
+ # Valid values: `1150-65535`
2853
2860
  #
2854
2861
  # Type: Integer
2855
2862
  #
@@ -2857,7 +2864,7 @@ module Aws::RDS
2857
2864
  #
2858
2865
  # Default: `3306`
2859
2866
  #
2860
- # Valid Values: `1150-65535`
2867
+ # Valid values: `1150-65535`
2861
2868
  #
2862
2869
  # Type: Integer
2863
2870
  #
@@ -2865,7 +2872,7 @@ module Aws::RDS
2865
2872
  #
2866
2873
  # Default: `5432`
2867
2874
  #
2868
- # Valid Values: `1150-65535`
2875
+ # Valid values: `1150-65535`
2869
2876
  #
2870
2877
  # Type: Integer
2871
2878
  #
@@ -2873,20 +2880,20 @@ module Aws::RDS
2873
2880
  #
2874
2881
  # Default: `1521`
2875
2882
  #
2876
- # Valid Values: `1150-65535`
2883
+ # Valid values: `1150-65535`
2877
2884
  #
2878
2885
  # **SQL Server**
2879
2886
  #
2880
2887
  # Default: `1433`
2881
2888
  #
2882
- # Valid Values: `1150-65535` except for `1434`, `3389`, `47001`,
2883
- # `49152`, and `49152` through `49156`.
2889
+ # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
2890
+ # `3389`, `47001`, and `49152-49156`.
2884
2891
  #
2885
2892
  # **Amazon Aurora**
2886
2893
  #
2887
2894
  # Default: `3306`
2888
2895
  #
2889
- # Valid Values: `1150-65535`
2896
+ # Valid values: `1150-65535`
2890
2897
  #
2891
2898
  # Type: Integer
2892
2899
  # @return [Integer]
@@ -3096,15 +3103,13 @@ module Aws::RDS
3096
3103
  # with an Amazon RDS DB Instance Running Microsoft SQL Server][1] in
3097
3104
  # the *Amazon RDS User Guide*.
3098
3105
  #
3099
- # For Oracle DB instance, Amazon RDS can use Kerberos Authentication
3106
+ # For Oracle DB instances, Amazon RDS can use Kerberos Authentication
3100
3107
  # to authenticate users that connect to the DB instance. For more
3101
3108
  # information, see [ Using Kerberos Authentication with Amazon RDS for
3102
3109
  # Oracle][2] in the *Amazon RDS User Guide*.
3103
3110
  #
3104
3111
  #
3105
3112
  #
3106
- #
3107
- #
3108
3113
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
3109
3114
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
3110
3115
  # @return [String]
@@ -3380,50 +3385,56 @@ module Aws::RDS
3380
3385
  # }
3381
3386
  #
3382
3387
  # @!attribute [rw] db_instance_identifier
3383
- # The DB instance identifier of the Read Replica. This identifier is
3388
+ # The DB instance identifier of the read replica. This identifier is
3384
3389
  # the unique key that identifies a DB instance. This parameter is
3385
3390
  # stored as a lowercase string.
3386
3391
  # @return [String]
3387
3392
  #
3388
3393
  # @!attribute [rw] source_db_instance_identifier
3389
3394
  # The identifier of the DB instance that will act as the source for
3390
- # the Read Replica. Each DB instance can have up to five Read
3391
- # Replicas.
3395
+ # the read replica. Each DB instance can have up to five read
3396
+ # replicas.
3392
3397
  #
3393
3398
  # Constraints:
3394
3399
  #
3395
- # * Must be the identifier of an existing MySQL, MariaDB, Oracle, or
3396
- # PostgreSQL DB instance.
3400
+ # * Must be the identifier of an existing MySQL, MariaDB, Oracle,
3401
+ # PostgreSQL, or SQL Server DB instance.
3397
3402
  #
3398
- # * Can specify a DB instance that is a MySQL Read Replica only if the
3403
+ # * Can specify a DB instance that is a MySQL read replica only if the
3399
3404
  # source is running MySQL 5.6 or later.
3400
3405
  #
3401
- # * For the limitations of Oracle Read Replicas, see [Read Replica
3406
+ # * For the limitations of Oracle read replicas, see [Read Replica
3402
3407
  # Limitations with Oracle][1] in the *Amazon RDS User Guide*.
3403
3408
  #
3404
- # * Can specify a DB instance that is a PostgreSQL DB instance only if
3405
- # the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher
3406
- # for cross-region replication).
3409
+ # * For the limitations of SQL Server read replicas, see [Read Replica
3410
+ # Limitations with Microsoft SQL Server][2] in the *Amazon RDS User
3411
+ # Guide*.
3412
+ #
3413
+ # * Can specify a PostgreSQL DB instance only if the source is running
3414
+ # PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region
3415
+ # replication).
3407
3416
  #
3408
- # * The specified DB instance must have automatic backups enabled, its
3409
- # backup retention period must be greater than 0.
3417
+ # * The specified DB instance must have automatic backups enabled,
3418
+ # that is, its backup retention period must be greater than 0.
3410
3419
  #
3411
- # * If the source DB instance is in the same AWS Region as the Read
3412
- # Replica, specify a valid DB instance identifier.
3420
+ # * If the source DB instance is in the same AWS Region as the read
3421
+ # replica, specify a valid DB instance identifier.
3413
3422
  #
3414
- # * If the source DB instance is in a different AWS Region than the
3415
- # Read Replica, specify a valid DB instance ARN. For more
3416
- # information, go to [ Constructing an ARN for Amazon RDS][2] in the
3417
- # *Amazon RDS User Guide*.
3423
+ # * If the source DB instance is in a different AWS Region from the
3424
+ # read replica, specify a valid DB instance ARN. For more
3425
+ # information, see [Constructing an ARN for Amazon RDS][3] in the
3426
+ # *Amazon RDS User Guide*. This doesn't apply to SQL Server, which
3427
+ # doesn't support cross-region replicas.
3418
3428
  #
3419
3429
  #
3420
3430
  #
3421
3431
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
3422
- # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
3432
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html
3433
+ # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
3423
3434
  # @return [String]
3424
3435
  #
3425
3436
  # @!attribute [rw] db_instance_class
3426
- # The compute and memory capacity of the Read Replica, for example,
3437
+ # The compute and memory capacity of the read replica, for example,
3427
3438
  # `db.m4.large`. Not all DB instance classes are available in all AWS
3428
3439
  # Regions, or for all database engines. For the full list of DB
3429
3440
  # instance classes, and availability for your engine, see [DB Instance
@@ -3437,7 +3448,7 @@ module Aws::RDS
3437
3448
  # @return [String]
3438
3449
  #
3439
3450
  # @!attribute [rw] availability_zone
3440
- # The Availability Zone (AZ) where the Read Replica will be created.
3451
+ # The Availability Zone (AZ) where the read replica will be created.
3441
3452
  #
3442
3453
  # Default: A random, system-chosen Availability Zone in the
3443
3454
  # endpoint's AWS Region.
@@ -3454,19 +3465,19 @@ module Aws::RDS
3454
3465
  # @return [Integer]
3455
3466
  #
3456
3467
  # @!attribute [rw] multi_az
3457
- # A value that indicates whether the Read Replica is in a Multi-AZ
3468
+ # A value that indicates whether the read replica is in a Multi-AZ
3458
3469
  # deployment.
3459
3470
  #
3460
- # You can create a Read Replica as a Multi-AZ DB instance. RDS creates
3471
+ # You can create a read replica as a Multi-AZ DB instance. RDS creates
3461
3472
  # a standby of your replica in another Availability Zone for failover
3462
- # support for the replica. Creating your Read Replica as a Multi-AZ DB
3473
+ # support for the replica. Creating your read replica as a Multi-AZ DB
3463
3474
  # instance is independent of whether the source database is a Multi-AZ
3464
3475
  # DB instance.
3465
3476
  # @return [Boolean]
3466
3477
  #
3467
3478
  # @!attribute [rw] auto_minor_version_upgrade
3468
3479
  # A value that indicates whether minor engine upgrades are applied
3469
- # automatically to the Read Replica during the maintenance window.
3480
+ # automatically to the read replica during the maintenance window.
3470
3481
  #
3471
3482
  # Default: Inherits from the source DB instance
3472
3483
  # @return [Boolean]
@@ -3479,6 +3490,11 @@ module Aws::RDS
3479
3490
  # @!attribute [rw] option_group_name
3480
3491
  # The option group the DB instance is associated with. If omitted, the
3481
3492
  # option group associated with the source instance is used.
3493
+ #
3494
+ # <note markdown="1"> For SQL Server, you must use the option group associated with the
3495
+ # source instance.
3496
+ #
3497
+ # </note>
3482
3498
  # @return [String]
3483
3499
  #
3484
3500
  # @!attribute [rw] db_parameter_group_name
@@ -3487,8 +3503,8 @@ module Aws::RDS
3487
3503
  #
3488
3504
  # If you do not specify a value for `DBParameterGroupName`, then
3489
3505
  # Amazon RDS uses the `DBParameterGroup` of source DB instance for a
3490
- # same region Read Replica, or the default `DBParameterGroup` for the
3491
- # specified DB engine for a cross region Read Replica.
3506
+ # same region read replica, or the default `DBParameterGroup` for the
3507
+ # specified DB engine for a cross region read replica.
3492
3508
  #
3493
3509
  # <note markdown="1"> Currently, specifying a parameter group for this operation is only
3494
3510
  # supported for Oracle DB instances.
@@ -3539,28 +3555,28 @@ module Aws::RDS
3539
3555
  # * The specified DB subnet group must be in the same AWS Region in
3540
3556
  # which the operation is running.
3541
3557
  #
3542
- # * All Read Replicas in one AWS Region that are created from the same
3558
+ # * All read replicas in one AWS Region that are created from the same
3543
3559
  # source DB instance must either:&gt;
3544
3560
  #
3545
- # * Specify DB subnet groups from the same VPC. All these Read
3546
- # Replicas are created in the same VPC.
3561
+ # * Specify DB subnet groups from the same VPC. All these read
3562
+ # replicas are created in the same VPC.
3547
3563
  #
3548
- # * Not specify a DB subnet group. All these Read Replicas are
3564
+ # * Not specify a DB subnet group. All these read replicas are
3549
3565
  # created outside of any VPC.
3550
3566
  #
3551
3567
  # Example: `mySubnetgroup`
3552
3568
  # @return [String]
3553
3569
  #
3554
3570
  # @!attribute [rw] vpc_security_group_ids
3555
- # A list of EC2 VPC security groups to associate with the Read
3556
- # Replica.
3571
+ # A list of EC2 VPC security groups to associate with the read
3572
+ # replica.
3557
3573
  #
3558
3574
  # Default: The default EC2 VPC security group for the DB subnet
3559
3575
  # group's VPC.
3560
3576
  # @return [Array<String>]
3561
3577
  #
3562
3578
  # @!attribute [rw] storage_type
3563
- # Specifies the storage type to be associated with the Read Replica.
3579
+ # Specifies the storage type to be associated with the read replica.
3564
3580
  #
3565
3581
  # Valid values: `standard | gp2 | io1`
3566
3582
  #
@@ -3571,14 +3587,14 @@ module Aws::RDS
3571
3587
  # @return [String]
3572
3588
  #
3573
3589
  # @!attribute [rw] copy_tags_to_snapshot
3574
- # A value that indicates whether to copy all tags from the Read
3575
- # Replica to snapshots of the Read Replica. By default, tags are not
3590
+ # A value that indicates whether to copy all tags from the read
3591
+ # replica to snapshots of the read replica. By default, tags are not
3576
3592
  # copied.
3577
3593
  # @return [Boolean]
3578
3594
  #
3579
3595
  # @!attribute [rw] monitoring_interval
3580
3596
  # The interval, in seconds, between points when Enhanced Monitoring
3581
- # metrics are collected for the Read Replica. To disable collecting
3597
+ # metrics are collected for the read replica. To disable collecting
3582
3598
  # Enhanced Monitoring metrics, specify 0. The default is 0.
3583
3599
  #
3584
3600
  # If `MonitoringRoleArn` is specified, then you must also set
@@ -3603,22 +3619,22 @@ module Aws::RDS
3603
3619
  # @return [String]
3604
3620
  #
3605
3621
  # @!attribute [rw] kms_key_id
3606
- # The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is
3622
+ # The AWS KMS key ID for an encrypted read replica. The KMS key ID is
3607
3623
  # the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
3608
3624
  # alias for the KMS encryption key.
3609
3625
  #
3610
- # If you create an encrypted Read Replica in the same AWS Region as
3626
+ # If you create an encrypted read replica in the same AWS Region as
3611
3627
  # the source DB instance, then you do not have to specify a value for
3612
- # this parameter. The Read Replica is encrypted with the same KMS key
3628
+ # this parameter. The read replica is encrypted with the same KMS key
3613
3629
  # as the source DB instance.
3614
3630
  #
3615
- # If you create an encrypted Read Replica in a different AWS Region,
3631
+ # If you create an encrypted read replica in a different AWS Region,
3616
3632
  # then you must specify a KMS key for the destination AWS Region. KMS
3617
3633
  # encryption keys are specific to the AWS Region that they are created
3618
3634
  # in, and you can't use encryption keys from one AWS Region in
3619
3635
  # another AWS Region.
3620
3636
  #
3621
- # You can't create an encrypted Read Replica from an unencrypted DB
3637
+ # You can't create an encrypted read replica from an unencrypted DB
3622
3638
  # instance.
3623
3639
  # @return [String]
3624
3640
  #
@@ -3627,10 +3643,10 @@ module Aws::RDS
3627
3643
  # `CreateDBInstanceReadReplica` API action in the source AWS Region
3628
3644
  # that contains the source DB instance.
3629
3645
  #
3630
- # You must specify this parameter when you create an encrypted Read
3631
- # Replica from another AWS Region by using the Amazon RDS API. Don't
3632
- # specify `PreSignedUrl` when you are creating an encrypted Read
3633
- # Replica in the same AWS Region.
3646
+ # You must specify this parameter when you create an encrypted read
3647
+ # replica from another AWS Region by using the Amazon RDS API. Don't
3648
+ # specify `PreSignedUrl` when you are creating an encrypted read
3649
+ # replica in the same AWS Region.
3634
3650
  #
3635
3651
  # The presigned URL must be a valid request for the
3636
3652
  # `CreateDBInstanceReadReplica` API action that can be executed in the
@@ -3638,8 +3654,8 @@ module Aws::RDS
3638
3654
  # The presigned URL request must contain the following parameter
3639
3655
  # values:
3640
3656
  #
3641
- # * `DestinationRegion` - The AWS Region that the encrypted Read
3642
- # Replica is created in. This AWS Region is the same one where the
3657
+ # * `DestinationRegion` - The AWS Region that the encrypted read
3658
+ # replica is created in. This AWS Region is the same one where the
3643
3659
  # `CreateDBInstanceReadReplica` action is called that contains this
3644
3660
  # presigned URL.
3645
3661
  #
@@ -3652,7 +3668,7 @@ module Aws::RDS
3652
3668
  # the presigned URL must be set to the us-east-1 AWS Region.
3653
3669
  #
3654
3670
  # * `KmsKeyId` - The AWS KMS key identifier for the key to use to
3655
- # encrypt the Read Replica in the destination AWS Region. This is
3671
+ # encrypt the read replica in the destination AWS Region. This is
3656
3672
  # the same identifier for both the `CreateDBInstanceReadReplica`
3657
3673
  # action that is called in the destination AWS Region, and the
3658
3674
  # action contained in the presigned URL.
@@ -3660,7 +3676,7 @@ module Aws::RDS
3660
3676
  # * `SourceDBInstanceIdentifier` - The DB instance identifier for the
3661
3677
  # encrypted DB instance to be replicated. This identifier must be in
3662
3678
  # the Amazon Resource Name (ARN) format for the source AWS Region.
3663
- # For example, if you are creating an encrypted Read Replica from a
3679
+ # For example, if you are creating an encrypted read replica from a
3664
3680
  # DB instance in the us-west-2 AWS Region, then your
3665
3681
  # `SourceDBInstanceIdentifier` looks like the following example:
3666
3682
  # `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
@@ -3672,9 +3688,12 @@ module Aws::RDS
3672
3688
  # <note markdown="1"> If you are using an AWS SDK tool or the AWS CLI, you can specify
3673
3689
  # `SourceRegion` (or `--source-region` for the AWS CLI) instead of
3674
3690
  # specifying `PreSignedUrl` manually. Specifying `SourceRegion`
3675
- # autogenerates a pre-signed URL that is a valid request for the
3691
+ # autogenerates a presigned URL that is a valid request for the
3676
3692
  # operation that can be executed in the source AWS Region.
3677
3693
  #
3694
+ # `SourceRegion` isn't supported for SQL Server, because SQL Server
3695
+ # on Amazon RDS doesn't support cross-region read replicas.
3696
+ #
3678
3697
  # </note>
3679
3698
  #
3680
3699
  #
@@ -3700,7 +3719,7 @@ module Aws::RDS
3700
3719
  #
3701
3720
  # @!attribute [rw] enable_performance_insights
3702
3721
  # A value that indicates whether to enable Performance Insights for
3703
- # the Read Replica.
3722
+ # the read replica.
3704
3723
  #
3705
3724
  # For more information, see [Using Amazon Performance Insights][1] in
3706
3725
  # the *Amazon RDS User Guide*.
@@ -3766,9 +3785,16 @@ module Aws::RDS
3766
3785
  # information, see [ Using Kerberos Authentication with Amazon RDS for
3767
3786
  # Oracle][1] in the *Amazon RDS User Guide*.
3768
3787
  #
3788
+ # For Microsoft SQL Server DB instances, Amazon RDS can use Windows
3789
+ # Authentication to authenticate users that connect to the DB
3790
+ # instance. For more information, see [ Using Windows Authentication
3791
+ # with an Amazon RDS DB Instance Running Microsoft SQL Server][2] in
3792
+ # the *Amazon RDS User Guide*.
3793
+ #
3769
3794
  #
3770
3795
  #
3771
3796
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
3797
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
3772
3798
  # @return [String]
3773
3799
  #
3774
3800
  # @!attribute [rw] domain_iam_role_name
@@ -4711,11 +4737,11 @@ module Aws::RDS
4711
4737
  #
4712
4738
  # @!attribute [rw] replication_source_identifier
4713
4739
  # Contains the identifier of the source DB cluster if this DB cluster
4714
- # is a Read Replica.
4740
+ # is a read replica.
4715
4741
  # @return [String]
4716
4742
  #
4717
4743
  # @!attribute [rw] read_replica_identifiers
4718
- # Contains one or more identifiers of the Read Replicas associated
4744
+ # Contains one or more identifiers of the read replicas associated
4719
4745
  # with this DB cluster.
4720
4746
  # @return [Array<String>]
4721
4747
  #
@@ -4815,6 +4841,15 @@ module Aws::RDS
4815
4841
  # @!attribute [rw] engine_mode
4816
4842
  # The DB engine mode of the DB cluster, either `provisioned`,
4817
4843
  # `serverless`, `parallelquery`, `global`, or `multimaster`.
4844
+ #
4845
+ # <note markdown="1"> `global` engine mode only applies for global database clusters
4846
+ # created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
4847
+ # versions, the clusters in a global database use `provisioned` engine
4848
+ # mode. To check if a DB cluster is part of a global database, use
4849
+ # `DescribeGlobalClusters` instead of checking the `EngineMode` return
4850
+ # value from `DescribeDBClusters`.
4851
+ #
4852
+ # </note>
4818
4853
  # @return [String]
4819
4854
  #
4820
4855
  # @!attribute [rw] scaling_configuration_info
@@ -5706,12 +5741,19 @@ module Aws::RDS
5706
5741
  # @return [Boolean]
5707
5742
  #
5708
5743
  # @!attribute [rw] supports_read_replica
5709
- # Indicates whether the database engine version supports Read
5710
- # Replicas.
5744
+ # Indicates whether the database engine version supports read
5745
+ # replicas.
5711
5746
  # @return [Boolean]
5712
5747
  #
5713
5748
  # @!attribute [rw] supported_engine_modes
5714
5749
  # A list of the supported DB engine modes.
5750
+ #
5751
+ # <note markdown="1"> `global` engine mode only applies for global database clusters
5752
+ # created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
5753
+ # versions, the clusters in a global database use `provisioned` engine
5754
+ # mode.
5755
+ #
5756
+ # </note>
5715
5757
  # @return [Array<String>]
5716
5758
  #
5717
5759
  # @!attribute [rw] supported_feature_names
@@ -5792,6 +5834,13 @@ module Aws::RDS
5792
5834
  #
5793
5835
  # @!attribute [rw] db_instance_status
5794
5836
  # Specifies the current state of this database.
5837
+ #
5838
+ # For information about DB instance statuses, see [DB Instance
5839
+ # Status][1] in the *Amazon RDS User Guide.*
5840
+ #
5841
+ #
5842
+ #
5843
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Status.html
5795
5844
  # @return [String]
5796
5845
  #
5797
5846
  # @!attribute [rw] master_username
@@ -5897,24 +5946,24 @@ module Aws::RDS
5897
5946
  #
5898
5947
  # @!attribute [rw] read_replica_source_db_instance_identifier
5899
5948
  # Contains the identifier of the source DB instance if this DB
5900
- # instance is a Read Replica.
5949
+ # instance is a read replica.
5901
5950
  # @return [String]
5902
5951
  #
5903
5952
  # @!attribute [rw] read_replica_db_instance_identifiers
5904
- # Contains one or more identifiers of the Read Replicas associated
5953
+ # Contains one or more identifiers of the read replicas associated
5905
5954
  # with this DB instance.
5906
5955
  # @return [Array<String>]
5907
5956
  #
5908
5957
  # @!attribute [rw] read_replica_db_cluster_identifiers
5909
5958
  # Contains one or more identifiers of Aurora DB clusters to which the
5910
- # RDS DB instance is replicated as a Read Replica. For example, when
5911
- # you create an Aurora Read Replica of an RDS MySQL DB instance, the
5912
- # Aurora MySQL DB cluster for the Aurora Read Replica is shown. This
5913
- # output does not contain information about cross region Aurora Read
5914
- # Replicas.
5959
+ # RDS DB instance is replicated as a read replica. For example, when
5960
+ # you create an Aurora read replica of an RDS MySQL DB instance, the
5961
+ # Aurora MySQL DB cluster for the Aurora read replica is shown. This
5962
+ # output does not contain information about cross region Aurora read
5963
+ # replicas.
5915
5964
  #
5916
- # <note markdown="1"> Currently, each RDS DB instance can have only one Aurora Read
5917
- # Replica.
5965
+ # <note markdown="1"> Currently, each RDS DB instance can have only one Aurora read
5966
+ # replica.
5918
5967
  #
5919
5968
  # </note>
5920
5969
  # @return [Array<String>]
@@ -5950,7 +5999,7 @@ module Aws::RDS
5950
5999
  # @return [Boolean]
5951
6000
  #
5952
6001
  # @!attribute [rw] status_infos
5953
- # The status of a Read Replica. If the instance isn't a Read Replica,
6002
+ # The status of a read replica. If the instance isn't a read replica,
5954
6003
  # this is blank.
5955
6004
  # @return [Array<Types::DBInstanceStatusInfo>]
5956
6005
  #
@@ -6473,7 +6522,7 @@ module Aws::RDS
6473
6522
  # @return [Boolean]
6474
6523
  #
6475
6524
  # @!attribute [rw] status
6476
- # Status of the DB instance. For a StatusType of Read Replica, the
6525
+ # Status of the DB instance. For a StatusType of read replica, the
6477
6526
  # values can be replicating, replication stop point set, replication
6478
6527
  # stop point reached, error, stopped, or terminated.
6479
6528
  # @return [String]
@@ -7659,7 +7708,7 @@ module Aws::RDS
7659
7708
  # 'failed', 'incompatible-restore', or 'incompatible-network',
7660
7709
  # it can only be deleted when skip is specified.
7661
7710
  #
7662
- # Specify skip when deleting a Read Replica.
7711
+ # Specify skip when deleting a read replica.
7663
7712
  #
7664
7713
  # <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip
7665
7714
  # isn't specified.
@@ -7684,7 +7733,7 @@ module Aws::RDS
7684
7733
  #
7685
7734
  # * Can't end with a hyphen or contain two consecutive hyphens.
7686
7735
  #
7687
- # * Can't be specified when deleting a Read Replica.
7736
+ # * Can't be specified when deleting a read replica.
7688
7737
  # @return [String]
7689
7738
  #
7690
7739
  # @!attribute [rw] delete_automated_backups
@@ -12916,13 +12965,13 @@ module Aws::RDS
12916
12965
  #
12917
12966
  # * Must be a value from 0 to 35
12918
12967
  #
12919
- # * Can be specified for a MySQL Read Replica only if the source is
12968
+ # * Can be specified for a MySQL read replica only if the source is
12920
12969
  # running MySQL 5.6 or later
12921
12970
  #
12922
- # * Can be specified for a PostgreSQL Read Replica only if the source
12971
+ # * Can be specified for a PostgreSQL read replica only if the source
12923
12972
  # is running PostgreSQL 9.3.5
12924
12973
  #
12925
- # * Can't be set to 0 if the DB instance is a source to Read Replicas
12974
+ # * Can't be set to 0 if the DB instance is a source to read replicas
12926
12975
  # @return [Integer]
12927
12976
  #
12928
12977
  # @!attribute [rw] preferred_backup_window
@@ -13043,7 +13092,7 @@ module Aws::RDS
13043
13092
  # nightly backups for the instance are suspended. No other Amazon RDS
13044
13093
  # operations can take place for the instance, including modifying the
13045
13094
  # instance, rebooting the instance, deleting the instance, creating a
13046
- # Read Replica for the instance, and creating a DB snapshot of the
13095
+ # read replica for the instance, and creating a DB snapshot of the
13047
13096
  # instance.
13048
13097
  #
13049
13098
  # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value
@@ -13107,7 +13156,7 @@ module Aws::RDS
13107
13156
  # nightly backups for the instance are suspended. No other Amazon RDS
13108
13157
  # operations can take place for the instance, including modifying the
13109
13158
  # instance, rebooting the instance, deleting the instance, creating a
13110
- # Read Replica for the instance, and creating a DB snapshot of the
13159
+ # read replica for the instance, and creating a DB snapshot of the
13111
13160
  # instance.
13112
13161
  #
13113
13162
  # Valid values: `standard | gp2 | io1`
@@ -13191,19 +13240,19 @@ module Aws::RDS
13191
13240
  #
13192
13241
  # Default: `3306`
13193
13242
  #
13194
- # Valid Values: `1150-65535`
13243
+ # Valid values: `1150-65535`
13195
13244
  #
13196
13245
  # **MariaDB**
13197
13246
  #
13198
13247
  # Default: `3306`
13199
13248
  #
13200
- # Valid Values: `1150-65535`
13249
+ # Valid values: `1150-65535`
13201
13250
  #
13202
13251
  # **PostgreSQL**
13203
13252
  #
13204
13253
  # Default: `5432`
13205
13254
  #
13206
- # Valid Values: `1150-65535`
13255
+ # Valid values: `1150-65535`
13207
13256
  #
13208
13257
  # Type: Integer
13209
13258
  #
@@ -13211,20 +13260,20 @@ module Aws::RDS
13211
13260
  #
13212
13261
  # Default: `1521`
13213
13262
  #
13214
- # Valid Values: `1150-65535`
13263
+ # Valid values: `1150-65535`
13215
13264
  #
13216
13265
  # **SQL Server**
13217
13266
  #
13218
13267
  # Default: `1433`
13219
13268
  #
13220
- # Valid Values: `1150-65535` except for `1434`, `3389`, `47001`,
13221
- # `49152`, and `49152` through `49156`.
13269
+ # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
13270
+ # `3389`, `47001`, and `49152-49156`.
13222
13271
  #
13223
13272
  # **Amazon Aurora**
13224
13273
  #
13225
13274
  # Default: `3306`
13226
13275
  #
13227
- # Valid Values: `1150-65535`
13276
+ # Valid values: `1150-65535`
13228
13277
  # @return [Integer]
13229
13278
  #
13230
13279
  # @!attribute [rw] publicly_accessible
@@ -14594,7 +14643,7 @@ module Aws::RDS
14594
14643
  # @return [Boolean]
14595
14644
  #
14596
14645
  # @!attribute [rw] read_replica_capable
14597
- # Indicates whether a DB instance can have a Read Replica.
14646
+ # Indicates whether a DB instance can have a read replica.
14598
14647
  # @return [Boolean]
14599
14648
  #
14600
14649
  # @!attribute [rw] vpc
@@ -14659,6 +14708,13 @@ module Aws::RDS
14659
14708
  #
14660
14709
  # @!attribute [rw] supported_engine_modes
14661
14710
  # A list of the supported DB engine modes.
14711
+ #
14712
+ # <note markdown="1"> `global` engine mode only applies for global database clusters
14713
+ # created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
14714
+ # versions, the clusters in a global database use `provisioned` engine
14715
+ # mode.
14716
+ #
14717
+ # </note>
14662
14718
  # @return [Array<String>]
14663
14719
  #
14664
14720
  # @!attribute [rw] supports_storage_autoscaling
@@ -15080,12 +15136,12 @@ module Aws::RDS
15080
15136
  # }
15081
15137
  #
15082
15138
  # @!attribute [rw] db_cluster_identifier
15083
- # The identifier of the DB cluster Read Replica to promote. This
15139
+ # The identifier of the DB cluster read replica to promote. This
15084
15140
  # parameter isn't case-sensitive.
15085
15141
  #
15086
15142
  # Constraints:
15087
15143
  #
15088
- # * Must match the identifier of an existing DBCluster Read Replica.
15144
+ # * Must match the identifier of an existing DB cluster read replica.
15089
15145
  #
15090
15146
  # ^
15091
15147
  #
@@ -15128,7 +15184,7 @@ module Aws::RDS
15128
15184
  #
15129
15185
  # Constraints:
15130
15186
  #
15131
- # * Must match the identifier of an existing Read Replica DB instance.
15187
+ # * Must match the identifier of an existing read replica DB instance.
15132
15188
  #
15133
15189
  # ^
15134
15190
  #
@@ -15146,8 +15202,8 @@ module Aws::RDS
15146
15202
  #
15147
15203
  # * Must be a value from 0 to 35.
15148
15204
  #
15149
- # * Can't be set to 0 if the DB instance is a source to Read
15150
- # Replicas.
15205
+ # * Can't be set to 0 if the DB instance is a source to read
15206
+ # replicas.
15151
15207
  # @return [Integer]
15152
15208
  #
15153
15209
  # @!attribute [rw] preferred_backup_window
@@ -16307,12 +16363,12 @@ module Aws::RDS
16307
16363
  #
16308
16364
  # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
16309
16365
  # Authentication to authenticate users that connect to the DB cluster.
16310
- # For more information, see [Using Kerberos Authentication for Aurora
16311
- # MySQL][1] in the *Amazon Aurora User Guide*.
16366
+ # For more information, see [Kerberos Authentication][1] in the
16367
+ # *Amazon Aurora User Guide*.
16312
16368
  #
16313
16369
  #
16314
16370
  #
16315
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html
16371
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
16316
16372
  # @return [String]
16317
16373
  #
16318
16374
  # @!attribute [rw] domain_iam_role_name
@@ -16910,12 +16966,12 @@ module Aws::RDS
16910
16966
  #
16911
16967
  # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
16912
16968
  # Authentication to authenticate users that connect to the DB cluster.
16913
- # For more information, see [Using Kerberos Authentication for Aurora
16914
- # MySQL][1] in the *Amazon Aurora User Guide*.
16969
+ # For more information, see [Kerberos Authentication][1] in the
16970
+ # *Amazon Aurora User Guide*.
16915
16971
  #
16916
16972
  #
16917
16973
  #
16918
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html
16974
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
16919
16975
  # @return [String]
16920
16976
  #
16921
16977
  # @!attribute [rw] domain_iam_role_name
@@ -18614,7 +18670,7 @@ module Aws::RDS
18614
18670
  #
18615
18671
  # @!attribute [rw] source_regions
18616
18672
  # A list of SourceRegion instances that contains each source AWS
18617
- # Region that the current AWS Region can get a Read Replica or a DB
18673
+ # Region that the current AWS Region can get a read replica or a DB
18618
18674
  # snapshot from.
18619
18675
  # @return [Array<Types::SourceRegion>]
18620
18676
  #