aws-sdk-rds 1.80.0 → 1.85.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 +5 -5
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/account_quota.rb +13 -11
- data/lib/aws-sdk-rds/certificate.rb +13 -11
- data/lib/aws-sdk-rds/client.rb +280 -151
- data/lib/aws-sdk-rds/client_api.rb +18 -1
- data/lib/aws-sdk-rds/customizations/auth_token_generator.rb +6 -3
- data/lib/aws-sdk-rds/db_cluster.rb +41 -24
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +13 -11
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +14 -12
- data/lib/aws-sdk-rds/db_engine.rb +13 -11
- data/lib/aws-sdk-rds/db_engine_version.rb +20 -12
- data/lib/aws-sdk-rds/db_instance.rb +98 -76
- data/lib/aws-sdk-rds/db_log_file.rb +13 -11
- data/lib/aws-sdk-rds/db_parameter_group.rb +13 -11
- data/lib/aws-sdk-rds/db_parameter_group_family.rb +13 -11
- data/lib/aws-sdk-rds/db_security_group.rb +13 -11
- data/lib/aws-sdk-rds/db_snapshot.rb +13 -11
- data/lib/aws-sdk-rds/db_snapshot_attribute.rb +13 -11
- data/lib/aws-sdk-rds/db_subnet_group.rb +13 -11
- data/lib/aws-sdk-rds/event.rb +13 -11
- data/lib/aws-sdk-rds/event_category_map.rb +13 -11
- data/lib/aws-sdk-rds/event_subscription.rb +13 -11
- data/lib/aws-sdk-rds/option_group.rb +13 -11
- data/lib/aws-sdk-rds/option_group_option.rb +13 -11
- data/lib/aws-sdk-rds/parameter.rb +13 -11
- data/lib/aws-sdk-rds/pending_maintenance_action.rb +13 -11
- data/lib/aws-sdk-rds/reserved_db_instance.rb +13 -11
- data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +13 -11
- data/lib/aws-sdk-rds/resource.rb +29 -20
- data/lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb +13 -11
- data/lib/aws-sdk-rds/types.rb +261 -143
- data/lib/aws-sdk-rds/waiters.rb +66 -0
- 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
|
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)
|
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
|
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
|
-
# @
|
130
|
-
#
|
131
|
-
#
|
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
|
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
|
#
|
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -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
|
94
|
-
# instance. The used value is the highest number of
|
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
|
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
|
@@ -790,6 +790,8 @@ module Aws::RDS
|
|
790
790
|
# the separator. You can also include multiple variables in a single
|
791
791
|
# `SET` statement, such as `SET x=1, y=2`.
|
792
792
|
#
|
793
|
+
# `InitQuery` is not currently supported for PostgreSQL.
|
794
|
+
#
|
793
795
|
# Default: no initialization query
|
794
796
|
# @return [String]
|
795
797
|
#
|
@@ -853,6 +855,8 @@ module Aws::RDS
|
|
853
855
|
# multiple statements, use semicolons as the separator. You can also
|
854
856
|
# include multiple variables in a single `SET` statement, such as `SET
|
855
857
|
# x=1, y=2`.
|
858
|
+
#
|
859
|
+
# `InitQuery` is not currently supported for PostgreSQL.
|
856
860
|
# @return [String]
|
857
861
|
#
|
858
862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ConnectionPoolConfigurationInfo AWS API Documentation
|
@@ -1051,7 +1055,7 @@ module Aws::RDS
|
|
1051
1055
|
# copying an encrypted DB cluster snapshot in the same AWS Region.
|
1052
1056
|
#
|
1053
1057
|
# The pre-signed URL must be a valid request for the
|
1054
|
-
# `
|
1058
|
+
# `CopyDBClusterSnapshot` API action that can be executed in the
|
1055
1059
|
# source AWS Region that contains the encrypted DB cluster snapshot to
|
1056
1060
|
# be copied. The pre-signed URL request must contain the following
|
1057
1061
|
# parameter values:
|
@@ -1899,7 +1903,7 @@ module Aws::RDS
|
|
1899
1903
|
#
|
1900
1904
|
# @!attribute [rw] replication_source_identifier
|
1901
1905
|
# The Amazon Resource Name (ARN) of the source DB instance or DB
|
1902
|
-
# cluster if this DB cluster is created as a
|
1906
|
+
# cluster if this DB cluster is created as a read replica.
|
1903
1907
|
# @return [String]
|
1904
1908
|
#
|
1905
1909
|
# @!attribute [rw] tags
|
@@ -1934,10 +1938,10 @@ module Aws::RDS
|
|
1934
1938
|
# Your AWS account has a different default encryption key for each AWS
|
1935
1939
|
# Region.
|
1936
1940
|
#
|
1937
|
-
# If you create a
|
1941
|
+
# If you create a read replica of an encrypted DB cluster in another
|
1938
1942
|
# 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
|
1940
|
-
#
|
1943
|
+
# the destination AWS Region. This key is used to encrypt the read
|
1944
|
+
# replica in that AWS Region.
|
1941
1945
|
# @return [String]
|
1942
1946
|
#
|
1943
1947
|
# @!attribute [rw] pre_signed_url
|
@@ -1960,8 +1964,8 @@ module Aws::RDS
|
|
1960
1964
|
# `CreateDBCluster` action that is called in the destination AWS
|
1961
1965
|
# Region, and the action contained in the pre-signed URL.
|
1962
1966
|
#
|
1963
|
-
# * `DestinationRegion` - The name of the AWS Region that Aurora
|
1964
|
-
#
|
1967
|
+
# * `DestinationRegion` - The name of the AWS Region that Aurora read
|
1968
|
+
# replica will be created in.
|
1965
1969
|
#
|
1966
1970
|
# * `ReplicationSourceIdentifier` - The DB cluster identifier for the
|
1967
1971
|
# encrypted DB cluster to be copied. This identifier must be in the
|
@@ -2031,6 +2035,13 @@ module Aws::RDS
|
|
2031
2035
|
# The DB engine mode of the DB cluster, either `provisioned`,
|
2032
2036
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
2033
2037
|
#
|
2038
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters
|
2039
|
+
# created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
|
2040
|
+
# versions, the clusters in a global database use `provisioned` engine
|
2041
|
+
# mode.
|
2042
|
+
#
|
2043
|
+
# </note>
|
2044
|
+
#
|
2034
2045
|
# Limitations and requirements apply to some DB engine modes. For more
|
2035
2046
|
# information, see the following sections in the *Amazon Aurora User
|
2036
2047
|
# Guide*\:
|
@@ -2095,12 +2106,12 @@ module Aws::RDS
|
|
2095
2106
|
#
|
2096
2107
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
2097
2108
|
# Authentication to authenticate users that connect to the DB cluster.
|
2098
|
-
# For more information, see [
|
2099
|
-
#
|
2109
|
+
# For more information, see [Kerberos Authentication][1] in the
|
2110
|
+
# *Amazon Aurora User Guide*.
|
2100
2111
|
#
|
2101
2112
|
#
|
2102
2113
|
#
|
2103
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
2114
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
2104
2115
|
# @return [String]
|
2105
2116
|
#
|
2106
2117
|
# @!attribute [rw] domain_iam_role_name
|
@@ -2807,7 +2818,7 @@ module Aws::RDS
|
|
2807
2818
|
#
|
2808
2819
|
# * Must be a value from 0 to 35
|
2809
2820
|
#
|
2810
|
-
# * Can't be set to 0 if the DB instance is a source to
|
2821
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas
|
2811
2822
|
# @return [Integer]
|
2812
2823
|
#
|
2813
2824
|
# @!attribute [rw] preferred_backup_window
|
@@ -2849,7 +2860,7 @@ module Aws::RDS
|
|
2849
2860
|
#
|
2850
2861
|
# Default: `3306`
|
2851
2862
|
#
|
2852
|
-
# Valid
|
2863
|
+
# Valid values: `1150-65535`
|
2853
2864
|
#
|
2854
2865
|
# Type: Integer
|
2855
2866
|
#
|
@@ -2857,7 +2868,7 @@ module Aws::RDS
|
|
2857
2868
|
#
|
2858
2869
|
# Default: `3306`
|
2859
2870
|
#
|
2860
|
-
# Valid
|
2871
|
+
# Valid values: `1150-65535`
|
2861
2872
|
#
|
2862
2873
|
# Type: Integer
|
2863
2874
|
#
|
@@ -2865,7 +2876,7 @@ module Aws::RDS
|
|
2865
2876
|
#
|
2866
2877
|
# Default: `5432`
|
2867
2878
|
#
|
2868
|
-
# Valid
|
2879
|
+
# Valid values: `1150-65535`
|
2869
2880
|
#
|
2870
2881
|
# Type: Integer
|
2871
2882
|
#
|
@@ -2873,20 +2884,20 @@ module Aws::RDS
|
|
2873
2884
|
#
|
2874
2885
|
# Default: `1521`
|
2875
2886
|
#
|
2876
|
-
# Valid
|
2887
|
+
# Valid values: `1150-65535`
|
2877
2888
|
#
|
2878
2889
|
# **SQL Server**
|
2879
2890
|
#
|
2880
2891
|
# Default: `1433`
|
2881
2892
|
#
|
2882
|
-
# Valid
|
2883
|
-
# `
|
2893
|
+
# Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
|
2894
|
+
# `3389`, `47001`, and `49152-49156`.
|
2884
2895
|
#
|
2885
2896
|
# **Amazon Aurora**
|
2886
2897
|
#
|
2887
2898
|
# Default: `3306`
|
2888
2899
|
#
|
2889
|
-
# Valid
|
2900
|
+
# Valid values: `1150-65535`
|
2890
2901
|
#
|
2891
2902
|
# Type: Integer
|
2892
2903
|
# @return [Integer]
|
@@ -3096,15 +3107,13 @@ module Aws::RDS
|
|
3096
3107
|
# with an Amazon RDS DB Instance Running Microsoft SQL Server][1] in
|
3097
3108
|
# the *Amazon RDS User Guide*.
|
3098
3109
|
#
|
3099
|
-
# For Oracle DB
|
3110
|
+
# For Oracle DB instances, Amazon RDS can use Kerberos Authentication
|
3100
3111
|
# to authenticate users that connect to the DB instance. For more
|
3101
3112
|
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
3102
3113
|
# Oracle][2] in the *Amazon RDS User Guide*.
|
3103
3114
|
#
|
3104
3115
|
#
|
3105
3116
|
#
|
3106
|
-
#
|
3107
|
-
#
|
3108
3117
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
3109
3118
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
3110
3119
|
# @return [String]
|
@@ -3380,50 +3389,56 @@ module Aws::RDS
|
|
3380
3389
|
# }
|
3381
3390
|
#
|
3382
3391
|
# @!attribute [rw] db_instance_identifier
|
3383
|
-
# The DB instance identifier of the
|
3392
|
+
# The DB instance identifier of the read replica. This identifier is
|
3384
3393
|
# the unique key that identifies a DB instance. This parameter is
|
3385
3394
|
# stored as a lowercase string.
|
3386
3395
|
# @return [String]
|
3387
3396
|
#
|
3388
3397
|
# @!attribute [rw] source_db_instance_identifier
|
3389
3398
|
# The identifier of the DB instance that will act as the source for
|
3390
|
-
# the
|
3391
|
-
#
|
3399
|
+
# the read replica. Each DB instance can have up to five read
|
3400
|
+
# replicas.
|
3392
3401
|
#
|
3393
3402
|
# Constraints:
|
3394
3403
|
#
|
3395
|
-
# * Must be the identifier of an existing MySQL, MariaDB, Oracle,
|
3396
|
-
# PostgreSQL DB instance.
|
3404
|
+
# * Must be the identifier of an existing MySQL, MariaDB, Oracle,
|
3405
|
+
# PostgreSQL, or SQL Server DB instance.
|
3397
3406
|
#
|
3398
|
-
# * Can specify a DB instance that is a MySQL
|
3407
|
+
# * Can specify a DB instance that is a MySQL read replica only if the
|
3399
3408
|
# source is running MySQL 5.6 or later.
|
3400
3409
|
#
|
3401
|
-
# * For the limitations of Oracle
|
3410
|
+
# * For the limitations of Oracle read replicas, see [Read Replica
|
3402
3411
|
# Limitations with Oracle][1] in the *Amazon RDS User Guide*.
|
3403
3412
|
#
|
3404
|
-
# *
|
3405
|
-
#
|
3406
|
-
#
|
3413
|
+
# * For the limitations of SQL Server read replicas, see [Read Replica
|
3414
|
+
# Limitations with Microsoft SQL Server][2] in the *Amazon RDS User
|
3415
|
+
# Guide*.
|
3416
|
+
#
|
3417
|
+
# * Can specify a PostgreSQL DB instance only if the source is running
|
3418
|
+
# PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region
|
3419
|
+
# replication).
|
3407
3420
|
#
|
3408
|
-
# * The specified DB instance must have automatic backups enabled,
|
3409
|
-
# backup retention period must be greater than 0.
|
3421
|
+
# * The specified DB instance must have automatic backups enabled,
|
3422
|
+
# that is, its backup retention period must be greater than 0.
|
3410
3423
|
#
|
3411
|
-
# * If the source DB instance is in the same AWS Region as the
|
3412
|
-
#
|
3424
|
+
# * If the source DB instance is in the same AWS Region as the read
|
3425
|
+
# replica, specify a valid DB instance identifier.
|
3413
3426
|
#
|
3414
|
-
# * If the source DB instance is in a different AWS Region
|
3415
|
-
#
|
3416
|
-
# information,
|
3417
|
-
# *Amazon RDS User Guide*.
|
3427
|
+
# * If the source DB instance is in a different AWS Region from the
|
3428
|
+
# read replica, specify a valid DB instance ARN. For more
|
3429
|
+
# information, see [Constructing an ARN for Amazon RDS][3] in the
|
3430
|
+
# *Amazon RDS User Guide*. This doesn't apply to SQL Server, which
|
3431
|
+
# doesn't support cross-region replicas.
|
3418
3432
|
#
|
3419
3433
|
#
|
3420
3434
|
#
|
3421
3435
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
3422
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
3436
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html
|
3437
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
|
3423
3438
|
# @return [String]
|
3424
3439
|
#
|
3425
3440
|
# @!attribute [rw] db_instance_class
|
3426
|
-
# The compute and memory capacity of the
|
3441
|
+
# The compute and memory capacity of the read replica, for example,
|
3427
3442
|
# `db.m4.large`. Not all DB instance classes are available in all AWS
|
3428
3443
|
# Regions, or for all database engines. For the full list of DB
|
3429
3444
|
# instance classes, and availability for your engine, see [DB Instance
|
@@ -3437,7 +3452,7 @@ module Aws::RDS
|
|
3437
3452
|
# @return [String]
|
3438
3453
|
#
|
3439
3454
|
# @!attribute [rw] availability_zone
|
3440
|
-
# The Availability Zone (AZ) where the
|
3455
|
+
# The Availability Zone (AZ) where the read replica will be created.
|
3441
3456
|
#
|
3442
3457
|
# Default: A random, system-chosen Availability Zone in the
|
3443
3458
|
# endpoint's AWS Region.
|
@@ -3454,19 +3469,19 @@ module Aws::RDS
|
|
3454
3469
|
# @return [Integer]
|
3455
3470
|
#
|
3456
3471
|
# @!attribute [rw] multi_az
|
3457
|
-
# A value that indicates whether the
|
3472
|
+
# A value that indicates whether the read replica is in a Multi-AZ
|
3458
3473
|
# deployment.
|
3459
3474
|
#
|
3460
|
-
# You can create a
|
3475
|
+
# You can create a read replica as a Multi-AZ DB instance. RDS creates
|
3461
3476
|
# a standby of your replica in another Availability Zone for failover
|
3462
|
-
# support for the replica. Creating your
|
3477
|
+
# support for the replica. Creating your read replica as a Multi-AZ DB
|
3463
3478
|
# instance is independent of whether the source database is a Multi-AZ
|
3464
3479
|
# DB instance.
|
3465
3480
|
# @return [Boolean]
|
3466
3481
|
#
|
3467
3482
|
# @!attribute [rw] auto_minor_version_upgrade
|
3468
3483
|
# A value that indicates whether minor engine upgrades are applied
|
3469
|
-
# automatically to the
|
3484
|
+
# automatically to the read replica during the maintenance window.
|
3470
3485
|
#
|
3471
3486
|
# Default: Inherits from the source DB instance
|
3472
3487
|
# @return [Boolean]
|
@@ -3479,6 +3494,11 @@ module Aws::RDS
|
|
3479
3494
|
# @!attribute [rw] option_group_name
|
3480
3495
|
# The option group the DB instance is associated with. If omitted, the
|
3481
3496
|
# option group associated with the source instance is used.
|
3497
|
+
#
|
3498
|
+
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
3499
|
+
# source instance.
|
3500
|
+
#
|
3501
|
+
# </note>
|
3482
3502
|
# @return [String]
|
3483
3503
|
#
|
3484
3504
|
# @!attribute [rw] db_parameter_group_name
|
@@ -3487,8 +3507,8 @@ module Aws::RDS
|
|
3487
3507
|
#
|
3488
3508
|
# If you do not specify a value for `DBParameterGroupName`, then
|
3489
3509
|
# Amazon RDS uses the `DBParameterGroup` of source DB instance for a
|
3490
|
-
# same region
|
3491
|
-
# specified DB engine for a cross region
|
3510
|
+
# same region read replica, or the default `DBParameterGroup` for the
|
3511
|
+
# specified DB engine for a cross region read replica.
|
3492
3512
|
#
|
3493
3513
|
# <note markdown="1"> Currently, specifying a parameter group for this operation is only
|
3494
3514
|
# supported for Oracle DB instances.
|
@@ -3539,28 +3559,28 @@ module Aws::RDS
|
|
3539
3559
|
# * The specified DB subnet group must be in the same AWS Region in
|
3540
3560
|
# which the operation is running.
|
3541
3561
|
#
|
3542
|
-
# * All
|
3562
|
+
# * All read replicas in one AWS Region that are created from the same
|
3543
3563
|
# source DB instance must either:>
|
3544
3564
|
#
|
3545
|
-
# * Specify DB subnet groups from the same VPC. All these
|
3546
|
-
#
|
3565
|
+
# * Specify DB subnet groups from the same VPC. All these read
|
3566
|
+
# replicas are created in the same VPC.
|
3547
3567
|
#
|
3548
|
-
# * Not specify a DB subnet group. All these
|
3568
|
+
# * Not specify a DB subnet group. All these read replicas are
|
3549
3569
|
# created outside of any VPC.
|
3550
3570
|
#
|
3551
3571
|
# Example: `mySubnetgroup`
|
3552
3572
|
# @return [String]
|
3553
3573
|
#
|
3554
3574
|
# @!attribute [rw] vpc_security_group_ids
|
3555
|
-
# A list of EC2 VPC security groups to associate with the
|
3556
|
-
#
|
3575
|
+
# A list of EC2 VPC security groups to associate with the read
|
3576
|
+
# replica.
|
3557
3577
|
#
|
3558
3578
|
# Default: The default EC2 VPC security group for the DB subnet
|
3559
3579
|
# group's VPC.
|
3560
3580
|
# @return [Array<String>]
|
3561
3581
|
#
|
3562
3582
|
# @!attribute [rw] storage_type
|
3563
|
-
# Specifies the storage type to be associated with the
|
3583
|
+
# Specifies the storage type to be associated with the read replica.
|
3564
3584
|
#
|
3565
3585
|
# Valid values: `standard | gp2 | io1`
|
3566
3586
|
#
|
@@ -3571,14 +3591,14 @@ module Aws::RDS
|
|
3571
3591
|
# @return [String]
|
3572
3592
|
#
|
3573
3593
|
# @!attribute [rw] copy_tags_to_snapshot
|
3574
|
-
# A value that indicates whether to copy all tags from the
|
3575
|
-
#
|
3594
|
+
# A value that indicates whether to copy all tags from the read
|
3595
|
+
# replica to snapshots of the read replica. By default, tags are not
|
3576
3596
|
# copied.
|
3577
3597
|
# @return [Boolean]
|
3578
3598
|
#
|
3579
3599
|
# @!attribute [rw] monitoring_interval
|
3580
3600
|
# The interval, in seconds, between points when Enhanced Monitoring
|
3581
|
-
# metrics are collected for the
|
3601
|
+
# metrics are collected for the read replica. To disable collecting
|
3582
3602
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
3583
3603
|
#
|
3584
3604
|
# If `MonitoringRoleArn` is specified, then you must also set
|
@@ -3603,22 +3623,22 @@ module Aws::RDS
|
|
3603
3623
|
# @return [String]
|
3604
3624
|
#
|
3605
3625
|
# @!attribute [rw] kms_key_id
|
3606
|
-
# The AWS KMS key ID for an encrypted
|
3626
|
+
# The AWS KMS key ID for an encrypted read replica. The KMS key ID is
|
3607
3627
|
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
3608
3628
|
# alias for the KMS encryption key.
|
3609
3629
|
#
|
3610
|
-
# If you create an encrypted
|
3630
|
+
# If you create an encrypted read replica in the same AWS Region as
|
3611
3631
|
# the source DB instance, then you do not have to specify a value for
|
3612
|
-
# this parameter. The
|
3632
|
+
# this parameter. The read replica is encrypted with the same KMS key
|
3613
3633
|
# as the source DB instance.
|
3614
3634
|
#
|
3615
|
-
# If you create an encrypted
|
3635
|
+
# If you create an encrypted read replica in a different AWS Region,
|
3616
3636
|
# then you must specify a KMS key for the destination AWS Region. KMS
|
3617
3637
|
# encryption keys are specific to the AWS Region that they are created
|
3618
3638
|
# in, and you can't use encryption keys from one AWS Region in
|
3619
3639
|
# another AWS Region.
|
3620
3640
|
#
|
3621
|
-
# You can't create an encrypted
|
3641
|
+
# You can't create an encrypted read replica from an unencrypted DB
|
3622
3642
|
# instance.
|
3623
3643
|
# @return [String]
|
3624
3644
|
#
|
@@ -3627,10 +3647,10 @@ module Aws::RDS
|
|
3627
3647
|
# `CreateDBInstanceReadReplica` API action in the source AWS Region
|
3628
3648
|
# that contains the source DB instance.
|
3629
3649
|
#
|
3630
|
-
# You must specify this parameter when you create an encrypted
|
3631
|
-
#
|
3632
|
-
# specify `PreSignedUrl` when you are creating an encrypted
|
3633
|
-
#
|
3650
|
+
# You must specify this parameter when you create an encrypted read
|
3651
|
+
# replica from another AWS Region by using the Amazon RDS API. Don't
|
3652
|
+
# specify `PreSignedUrl` when you are creating an encrypted read
|
3653
|
+
# replica in the same AWS Region.
|
3634
3654
|
#
|
3635
3655
|
# The presigned URL must be a valid request for the
|
3636
3656
|
# `CreateDBInstanceReadReplica` API action that can be executed in the
|
@@ -3638,8 +3658,8 @@ module Aws::RDS
|
|
3638
3658
|
# The presigned URL request must contain the following parameter
|
3639
3659
|
# values:
|
3640
3660
|
#
|
3641
|
-
# * `DestinationRegion` - The AWS Region that the encrypted
|
3642
|
-
#
|
3661
|
+
# * `DestinationRegion` - The AWS Region that the encrypted read
|
3662
|
+
# replica is created in. This AWS Region is the same one where the
|
3643
3663
|
# `CreateDBInstanceReadReplica` action is called that contains this
|
3644
3664
|
# presigned URL.
|
3645
3665
|
#
|
@@ -3652,7 +3672,7 @@ module Aws::RDS
|
|
3652
3672
|
# the presigned URL must be set to the us-east-1 AWS Region.
|
3653
3673
|
#
|
3654
3674
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
3655
|
-
# encrypt the
|
3675
|
+
# encrypt the read replica in the destination AWS Region. This is
|
3656
3676
|
# the same identifier for both the `CreateDBInstanceReadReplica`
|
3657
3677
|
# action that is called in the destination AWS Region, and the
|
3658
3678
|
# action contained in the presigned URL.
|
@@ -3660,7 +3680,7 @@ module Aws::RDS
|
|
3660
3680
|
# * `SourceDBInstanceIdentifier` - The DB instance identifier for the
|
3661
3681
|
# encrypted DB instance to be replicated. This identifier must be in
|
3662
3682
|
# the Amazon Resource Name (ARN) format for the source AWS Region.
|
3663
|
-
# For example, if you are creating an encrypted
|
3683
|
+
# For example, if you are creating an encrypted read replica from a
|
3664
3684
|
# DB instance in the us-west-2 AWS Region, then your
|
3665
3685
|
# `SourceDBInstanceIdentifier` looks like the following example:
|
3666
3686
|
# `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
|
@@ -3672,9 +3692,12 @@ module Aws::RDS
|
|
3672
3692
|
# <note markdown="1"> If you are using an AWS SDK tool or the AWS CLI, you can specify
|
3673
3693
|
# `SourceRegion` (or `--source-region` for the AWS CLI) instead of
|
3674
3694
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
3675
|
-
# autogenerates a
|
3695
|
+
# autogenerates a presigned URL that is a valid request for the
|
3676
3696
|
# operation that can be executed in the source AWS Region.
|
3677
3697
|
#
|
3698
|
+
# `SourceRegion` isn't supported for SQL Server, because SQL Server
|
3699
|
+
# on Amazon RDS doesn't support cross-region read replicas.
|
3700
|
+
#
|
3678
3701
|
# </note>
|
3679
3702
|
#
|
3680
3703
|
#
|
@@ -3700,7 +3723,7 @@ module Aws::RDS
|
|
3700
3723
|
#
|
3701
3724
|
# @!attribute [rw] enable_performance_insights
|
3702
3725
|
# A value that indicates whether to enable Performance Insights for
|
3703
|
-
# the
|
3726
|
+
# the read replica.
|
3704
3727
|
#
|
3705
3728
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3706
3729
|
# the *Amazon RDS User Guide*.
|
@@ -3766,9 +3789,16 @@ module Aws::RDS
|
|
3766
3789
|
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
3767
3790
|
# Oracle][1] in the *Amazon RDS User Guide*.
|
3768
3791
|
#
|
3792
|
+
# For Microsoft SQL Server DB instances, Amazon RDS can use Windows
|
3793
|
+
# Authentication to authenticate users that connect to the DB
|
3794
|
+
# instance. For more information, see [ Using Windows Authentication
|
3795
|
+
# with an Amazon RDS DB Instance Running Microsoft SQL Server][2] in
|
3796
|
+
# the *Amazon RDS User Guide*.
|
3797
|
+
#
|
3769
3798
|
#
|
3770
3799
|
#
|
3771
3800
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
3801
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
3772
3802
|
# @return [String]
|
3773
3803
|
#
|
3774
3804
|
# @!attribute [rw] domain_iam_role_name
|
@@ -3935,7 +3965,7 @@ module Aws::RDS
|
|
3935
3965
|
#
|
3936
3966
|
# {
|
3937
3967
|
# db_proxy_name: "String", # required
|
3938
|
-
# engine_family: "MYSQL", # required, accepts MYSQL
|
3968
|
+
# engine_family: "MYSQL", # required, accepts MYSQL, POSTGRESQL
|
3939
3969
|
# auth: [ # required
|
3940
3970
|
# {
|
3941
3971
|
# description: "String",
|
@@ -3970,9 +4000,8 @@ module Aws::RDS
|
|
3970
4000
|
# @!attribute [rw] engine_family
|
3971
4001
|
# The kinds of databases that the proxy can connect to. This value
|
3972
4002
|
# determines which database network protocol the proxy recognizes when
|
3973
|
-
# it interprets network traffic to and from the database.
|
3974
|
-
#
|
3975
|
-
# MySQL and Aurora MySQL.
|
4003
|
+
# it interprets network traffic to and from the database. The engine
|
4004
|
+
# family applies to MySQL and PostgreSQL for both RDS and Aurora.
|
3976
4005
|
# @return [String]
|
3977
4006
|
#
|
3978
4007
|
# @!attribute [rw] auth
|
@@ -4711,11 +4740,11 @@ module Aws::RDS
|
|
4711
4740
|
#
|
4712
4741
|
# @!attribute [rw] replication_source_identifier
|
4713
4742
|
# Contains the identifier of the source DB cluster if this DB cluster
|
4714
|
-
# is a
|
4743
|
+
# is a read replica.
|
4715
4744
|
# @return [String]
|
4716
4745
|
#
|
4717
4746
|
# @!attribute [rw] read_replica_identifiers
|
4718
|
-
# Contains one or more identifiers of the
|
4747
|
+
# Contains one or more identifiers of the read replicas associated
|
4719
4748
|
# with this DB cluster.
|
4720
4749
|
# @return [Array<String>]
|
4721
4750
|
#
|
@@ -4815,6 +4844,15 @@ module Aws::RDS
|
|
4815
4844
|
# @!attribute [rw] engine_mode
|
4816
4845
|
# The DB engine mode of the DB cluster, either `provisioned`,
|
4817
4846
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
4847
|
+
#
|
4848
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters
|
4849
|
+
# created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
|
4850
|
+
# versions, the clusters in a global database use `provisioned` engine
|
4851
|
+
# mode. To check if a DB cluster is part of a global database, use
|
4852
|
+
# `DescribeGlobalClusters` instead of checking the `EngineMode` return
|
4853
|
+
# value from `DescribeDBClusters`.
|
4854
|
+
#
|
4855
|
+
# </note>
|
4818
4856
|
# @return [String]
|
4819
4857
|
#
|
4820
4858
|
# @!attribute [rw] scaling_configuration_info
|
@@ -5706,12 +5744,19 @@ module Aws::RDS
|
|
5706
5744
|
# @return [Boolean]
|
5707
5745
|
#
|
5708
5746
|
# @!attribute [rw] supports_read_replica
|
5709
|
-
# Indicates whether the database engine version supports
|
5710
|
-
#
|
5747
|
+
# Indicates whether the database engine version supports read
|
5748
|
+
# replicas.
|
5711
5749
|
# @return [Boolean]
|
5712
5750
|
#
|
5713
5751
|
# @!attribute [rw] supported_engine_modes
|
5714
5752
|
# A list of the supported DB engine modes.
|
5753
|
+
#
|
5754
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters
|
5755
|
+
# created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
|
5756
|
+
# versions, the clusters in a global database use `provisioned` engine
|
5757
|
+
# mode.
|
5758
|
+
#
|
5759
|
+
# </note>
|
5715
5760
|
# @return [Array<String>]
|
5716
5761
|
#
|
5717
5762
|
# @!attribute [rw] supported_feature_names
|
@@ -5792,6 +5837,13 @@ module Aws::RDS
|
|
5792
5837
|
#
|
5793
5838
|
# @!attribute [rw] db_instance_status
|
5794
5839
|
# Specifies the current state of this database.
|
5840
|
+
#
|
5841
|
+
# For information about DB instance statuses, see [DB Instance
|
5842
|
+
# Status][1] in the *Amazon RDS User Guide.*
|
5843
|
+
#
|
5844
|
+
#
|
5845
|
+
#
|
5846
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Status.html
|
5795
5847
|
# @return [String]
|
5796
5848
|
#
|
5797
5849
|
# @!attribute [rw] master_username
|
@@ -5897,24 +5949,24 @@ module Aws::RDS
|
|
5897
5949
|
#
|
5898
5950
|
# @!attribute [rw] read_replica_source_db_instance_identifier
|
5899
5951
|
# Contains the identifier of the source DB instance if this DB
|
5900
|
-
# instance is a
|
5952
|
+
# instance is a read replica.
|
5901
5953
|
# @return [String]
|
5902
5954
|
#
|
5903
5955
|
# @!attribute [rw] read_replica_db_instance_identifiers
|
5904
|
-
# Contains one or more identifiers of the
|
5956
|
+
# Contains one or more identifiers of the read replicas associated
|
5905
5957
|
# with this DB instance.
|
5906
5958
|
# @return [Array<String>]
|
5907
5959
|
#
|
5908
5960
|
# @!attribute [rw] read_replica_db_cluster_identifiers
|
5909
5961
|
# Contains one or more identifiers of Aurora DB clusters to which the
|
5910
|
-
# RDS DB instance is replicated as a
|
5911
|
-
# you create an Aurora
|
5912
|
-
# Aurora MySQL DB cluster for the Aurora
|
5913
|
-
# output does not contain information about cross region Aurora
|
5914
|
-
#
|
5962
|
+
# RDS DB instance is replicated as a read replica. For example, when
|
5963
|
+
# you create an Aurora read replica of an RDS MySQL DB instance, the
|
5964
|
+
# Aurora MySQL DB cluster for the Aurora read replica is shown. This
|
5965
|
+
# output does not contain information about cross region Aurora read
|
5966
|
+
# replicas.
|
5915
5967
|
#
|
5916
|
-
# <note markdown="1"> Currently, each RDS DB instance can have only one Aurora
|
5917
|
-
#
|
5968
|
+
# <note markdown="1"> Currently, each RDS DB instance can have only one Aurora read
|
5969
|
+
# replica.
|
5918
5970
|
#
|
5919
5971
|
# </note>
|
5920
5972
|
# @return [Array<String>]
|
@@ -5950,7 +6002,7 @@ module Aws::RDS
|
|
5950
6002
|
# @return [Boolean]
|
5951
6003
|
#
|
5952
6004
|
# @!attribute [rw] status_infos
|
5953
|
-
# The status of a
|
6005
|
+
# The status of a read replica. If the instance isn't a read replica,
|
5954
6006
|
# this is blank.
|
5955
6007
|
# @return [Array<Types::DBInstanceStatusInfo>]
|
5956
6008
|
#
|
@@ -6473,7 +6525,7 @@ module Aws::RDS
|
|
6473
6525
|
# @return [Boolean]
|
6474
6526
|
#
|
6475
6527
|
# @!attribute [rw] status
|
6476
|
-
# Status of the DB instance. For a StatusType of
|
6528
|
+
# Status of the DB instance. For a StatusType of read replica, the
|
6477
6529
|
# values can be replicating, replication stop point set, replication
|
6478
6530
|
# stop point reached, error, stopped, or terminated.
|
6479
6531
|
# @return [String]
|
@@ -6667,8 +6719,8 @@ module Aws::RDS
|
|
6667
6719
|
# @return [String]
|
6668
6720
|
#
|
6669
6721
|
# @!attribute [rw] engine_family
|
6670
|
-
#
|
6671
|
-
#
|
6722
|
+
# The engine family applies to MySQL and PostgreSQL for both RDS and
|
6723
|
+
# Aurora.
|
6672
6724
|
# @return [String]
|
6673
6725
|
#
|
6674
6726
|
# @!attribute [rw] vpc_security_group_ids
|
@@ -6814,6 +6866,10 @@ module Aws::RDS
|
|
6814
6866
|
# Aurora DB cluster, that the target represents.
|
6815
6867
|
# @return [String]
|
6816
6868
|
#
|
6869
|
+
# @!attribute [rw] target_health
|
6870
|
+
# Information about the connection health of the RDS Proxy target.
|
6871
|
+
# @return [Types::TargetHealth]
|
6872
|
+
#
|
6817
6873
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBProxyTarget AWS API Documentation
|
6818
6874
|
#
|
6819
6875
|
class DBProxyTarget < Struct.new(
|
@@ -6822,7 +6878,8 @@ module Aws::RDS
|
|
6822
6878
|
:tracked_cluster_id,
|
6823
6879
|
:rds_resource_id,
|
6824
6880
|
:port,
|
6825
|
-
:type
|
6881
|
+
:type,
|
6882
|
+
:target_health)
|
6826
6883
|
include Aws::Structure
|
6827
6884
|
end
|
6828
6885
|
|
@@ -7659,7 +7716,7 @@ module Aws::RDS
|
|
7659
7716
|
# 'failed', 'incompatible-restore', or 'incompatible-network',
|
7660
7717
|
# it can only be deleted when skip is specified.
|
7661
7718
|
#
|
7662
|
-
# Specify skip when deleting a
|
7719
|
+
# Specify skip when deleting a read replica.
|
7663
7720
|
#
|
7664
7721
|
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip
|
7665
7722
|
# isn't specified.
|
@@ -7684,7 +7741,7 @@ module Aws::RDS
|
|
7684
7741
|
#
|
7685
7742
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
7686
7743
|
#
|
7687
|
-
# * Can't be specified when deleting a
|
7744
|
+
# * Can't be specified when deleting a read replica.
|
7688
7745
|
# @return [String]
|
7689
7746
|
#
|
7690
7747
|
# @!attribute [rw] delete_automated_backups
|
@@ -10373,6 +10430,7 @@ module Aws::RDS
|
|
10373
10430
|
# engine_version: "String",
|
10374
10431
|
# db_instance_class: "String",
|
10375
10432
|
# license_model: "String",
|
10433
|
+
# availability_zone_group: "String",
|
10376
10434
|
# vpc: false,
|
10377
10435
|
# filters: [
|
10378
10436
|
# {
|
@@ -10404,6 +10462,15 @@ module Aws::RDS
|
|
10404
10462
|
# the available offerings matching the specified license model.
|
10405
10463
|
# @return [String]
|
10406
10464
|
#
|
10465
|
+
# @!attribute [rw] availability_zone_group
|
10466
|
+
# The Availability Zone group associated with a Local Zone. Specify
|
10467
|
+
# this parameter to retrieve available offerings for the Local Zones
|
10468
|
+
# in the group.
|
10469
|
+
#
|
10470
|
+
# Omit this parameter to show the available offerings in the specified
|
10471
|
+
# AWS Region.
|
10472
|
+
# @return [String]
|
10473
|
+
#
|
10407
10474
|
# @!attribute [rw] vpc
|
10408
10475
|
# A value that indicates whether to show only VPC or non-VPC
|
10409
10476
|
# offerings.
|
@@ -10438,6 +10505,7 @@ module Aws::RDS
|
|
10438
10505
|
:engine_version,
|
10439
10506
|
:db_instance_class,
|
10440
10507
|
:license_model,
|
10508
|
+
:availability_zone_group,
|
10441
10509
|
:vpc,
|
10442
10510
|
:filters,
|
10443
10511
|
:max_records,
|
@@ -11266,17 +11334,19 @@ module Aws::RDS
|
|
11266
11334
|
# @!attribute [rw] export_only
|
11267
11335
|
# The data exported from the snapshot. Valid values are the following:
|
11268
11336
|
#
|
11269
|
-
# * `database` - Export all the data
|
11337
|
+
# * `database` - Export all the data from a specified database.
|
11270
11338
|
#
|
11271
|
-
# * `database.table
|
11339
|
+
# * `database.table` *table-name* - Export a table of the snapshot.
|
11340
|
+
# This format is valid only for RDS for MySQL, RDS for MariaDB, and
|
11341
|
+
# Aurora MySQL.
|
11272
11342
|
#
|
11273
|
-
# * `database.schema
|
11274
|
-
# snapshot. This
|
11275
|
-
#
|
11343
|
+
# * `database.schema` *schema-name* - Export a database schema of the
|
11344
|
+
# snapshot. This format is valid only for RDS for PostgreSQL and
|
11345
|
+
# Aurora PostgreSQL.
|
11276
11346
|
#
|
11277
|
-
# * `database.schema.table
|
11278
|
-
# database schema. This
|
11279
|
-
#
|
11347
|
+
# * `database.schema.table` *table-name* - Export a table of the
|
11348
|
+
# database schema. This format is valid only for RDS for PostgreSQL
|
11349
|
+
# and Aurora PostgreSQL.
|
11280
11350
|
# @return [Array<String>]
|
11281
11351
|
#
|
11282
11352
|
# @!attribute [rw] snapshot_time
|
@@ -12916,13 +12986,13 @@ module Aws::RDS
|
|
12916
12986
|
#
|
12917
12987
|
# * Must be a value from 0 to 35
|
12918
12988
|
#
|
12919
|
-
# * Can be specified for a MySQL
|
12989
|
+
# * Can be specified for a MySQL read replica only if the source is
|
12920
12990
|
# running MySQL 5.6 or later
|
12921
12991
|
#
|
12922
|
-
# * Can be specified for a PostgreSQL
|
12992
|
+
# * Can be specified for a PostgreSQL read replica only if the source
|
12923
12993
|
# is running PostgreSQL 9.3.5
|
12924
12994
|
#
|
12925
|
-
# * Can't be set to 0 if the DB instance is a source to
|
12995
|
+
# * Can't be set to 0 if the DB instance is a source to read replicas
|
12926
12996
|
# @return [Integer]
|
12927
12997
|
#
|
12928
12998
|
# @!attribute [rw] preferred_backup_window
|
@@ -13043,7 +13113,7 @@ module Aws::RDS
|
|
13043
13113
|
# nightly backups for the instance are suspended. No other Amazon RDS
|
13044
13114
|
# operations can take place for the instance, including modifying the
|
13045
13115
|
# instance, rebooting the instance, deleting the instance, creating a
|
13046
|
-
#
|
13116
|
+
# read replica for the instance, and creating a DB snapshot of the
|
13047
13117
|
# instance.
|
13048
13118
|
#
|
13049
13119
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value
|
@@ -13107,7 +13177,7 @@ module Aws::RDS
|
|
13107
13177
|
# nightly backups for the instance are suspended. No other Amazon RDS
|
13108
13178
|
# operations can take place for the instance, including modifying the
|
13109
13179
|
# instance, rebooting the instance, deleting the instance, creating a
|
13110
|
-
#
|
13180
|
+
# read replica for the instance, and creating a DB snapshot of the
|
13111
13181
|
# instance.
|
13112
13182
|
#
|
13113
13183
|
# Valid values: `standard | gp2 | io1`
|
@@ -13191,19 +13261,19 @@ module Aws::RDS
|
|
13191
13261
|
#
|
13192
13262
|
# Default: `3306`
|
13193
13263
|
#
|
13194
|
-
# Valid
|
13264
|
+
# Valid values: `1150-65535`
|
13195
13265
|
#
|
13196
13266
|
# **MariaDB**
|
13197
13267
|
#
|
13198
13268
|
# Default: `3306`
|
13199
13269
|
#
|
13200
|
-
# Valid
|
13270
|
+
# Valid values: `1150-65535`
|
13201
13271
|
#
|
13202
13272
|
# **PostgreSQL**
|
13203
13273
|
#
|
13204
13274
|
# Default: `5432`
|
13205
13275
|
#
|
13206
|
-
# Valid
|
13276
|
+
# Valid values: `1150-65535`
|
13207
13277
|
#
|
13208
13278
|
# Type: Integer
|
13209
13279
|
#
|
@@ -13211,20 +13281,20 @@ module Aws::RDS
|
|
13211
13281
|
#
|
13212
13282
|
# Default: `1521`
|
13213
13283
|
#
|
13214
|
-
# Valid
|
13284
|
+
# Valid values: `1150-65535`
|
13215
13285
|
#
|
13216
13286
|
# **SQL Server**
|
13217
13287
|
#
|
13218
13288
|
# Default: `1433`
|
13219
13289
|
#
|
13220
|
-
# Valid
|
13221
|
-
# `
|
13290
|
+
# Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
|
13291
|
+
# `3389`, `47001`, and `49152-49156`.
|
13222
13292
|
#
|
13223
13293
|
# **Amazon Aurora**
|
13224
13294
|
#
|
13225
13295
|
# Default: `3306`
|
13226
13296
|
#
|
13227
|
-
# Valid
|
13297
|
+
# Valid values: `1150-65535`
|
13228
13298
|
# @return [Integer]
|
13229
13299
|
#
|
13230
13300
|
# @!attribute [rw] publicly_accessible
|
@@ -14585,6 +14655,10 @@ module Aws::RDS
|
|
14585
14655
|
# The license model for a DB instance.
|
14586
14656
|
# @return [String]
|
14587
14657
|
#
|
14658
|
+
# @!attribute [rw] availability_zone_group
|
14659
|
+
# The Availability Zone group for a DB instance.
|
14660
|
+
# @return [String]
|
14661
|
+
#
|
14588
14662
|
# @!attribute [rw] availability_zones
|
14589
14663
|
# A list of Availability Zones for a DB instance.
|
14590
14664
|
# @return [Array<Types::AvailabilityZone>]
|
@@ -14594,7 +14668,7 @@ module Aws::RDS
|
|
14594
14668
|
# @return [Boolean]
|
14595
14669
|
#
|
14596
14670
|
# @!attribute [rw] read_replica_capable
|
14597
|
-
# Indicates whether a DB instance can have a
|
14671
|
+
# Indicates whether a DB instance can have a read replica.
|
14598
14672
|
# @return [Boolean]
|
14599
14673
|
#
|
14600
14674
|
# @!attribute [rw] vpc
|
@@ -14659,11 +14733,18 @@ module Aws::RDS
|
|
14659
14733
|
#
|
14660
14734
|
# @!attribute [rw] supported_engine_modes
|
14661
14735
|
# A list of the supported DB engine modes.
|
14736
|
+
#
|
14737
|
+
# <note markdown="1"> `global` engine mode only applies for global database clusters
|
14738
|
+
# created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL
|
14739
|
+
# versions, the clusters in a global database use `provisioned` engine
|
14740
|
+
# mode.
|
14741
|
+
#
|
14742
|
+
# </note>
|
14662
14743
|
# @return [Array<String>]
|
14663
14744
|
#
|
14664
14745
|
# @!attribute [rw] supports_storage_autoscaling
|
14665
|
-
# Whether
|
14666
|
-
#
|
14746
|
+
# Whether Amazon RDS can automatically scale storage for DB instances
|
14747
|
+
# that use the specified DB instance class.
|
14667
14748
|
# @return [Boolean]
|
14668
14749
|
#
|
14669
14750
|
# @!attribute [rw] supports_kerberos_authentication
|
@@ -14677,6 +14758,7 @@ module Aws::RDS
|
|
14677
14758
|
:engine_version,
|
14678
14759
|
:db_instance_class,
|
14679
14760
|
:license_model,
|
14761
|
+
:availability_zone_group,
|
14680
14762
|
:availability_zones,
|
14681
14763
|
:multi_az_capable,
|
14682
14764
|
:read_replica_capable,
|
@@ -15080,12 +15162,12 @@ module Aws::RDS
|
|
15080
15162
|
# }
|
15081
15163
|
#
|
15082
15164
|
# @!attribute [rw] db_cluster_identifier
|
15083
|
-
# The identifier of the DB cluster
|
15165
|
+
# The identifier of the DB cluster read replica to promote. This
|
15084
15166
|
# parameter isn't case-sensitive.
|
15085
15167
|
#
|
15086
15168
|
# Constraints:
|
15087
15169
|
#
|
15088
|
-
# * Must match the identifier of an existing
|
15170
|
+
# * Must match the identifier of an existing DB cluster read replica.
|
15089
15171
|
#
|
15090
15172
|
# ^
|
15091
15173
|
#
|
@@ -15128,7 +15210,7 @@ module Aws::RDS
|
|
15128
15210
|
#
|
15129
15211
|
# Constraints:
|
15130
15212
|
#
|
15131
|
-
# * Must match the identifier of an existing
|
15213
|
+
# * Must match the identifier of an existing read replica DB instance.
|
15132
15214
|
#
|
15133
15215
|
# ^
|
15134
15216
|
#
|
@@ -15146,8 +15228,8 @@ module Aws::RDS
|
|
15146
15228
|
#
|
15147
15229
|
# * Must be a value from 0 to 35.
|
15148
15230
|
#
|
15149
|
-
# * Can't be set to 0 if the DB instance is a source to
|
15150
|
-
#
|
15231
|
+
# * Can't be set to 0 if the DB instance is a source to read
|
15232
|
+
# replicas.
|
15151
15233
|
# @return [Integer]
|
15152
15234
|
#
|
15153
15235
|
# @!attribute [rw] preferred_backup_window
|
@@ -16307,12 +16389,12 @@ module Aws::RDS
|
|
16307
16389
|
#
|
16308
16390
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
16309
16391
|
# Authentication to authenticate users that connect to the DB cluster.
|
16310
|
-
# For more information, see [
|
16311
|
-
#
|
16392
|
+
# For more information, see [Kerberos Authentication][1] in the
|
16393
|
+
# *Amazon Aurora User Guide*.
|
16312
16394
|
#
|
16313
16395
|
#
|
16314
16396
|
#
|
16315
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
16397
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
16316
16398
|
# @return [String]
|
16317
16399
|
#
|
16318
16400
|
# @!attribute [rw] domain_iam_role_name
|
@@ -16910,12 +16992,12 @@ module Aws::RDS
|
|
16910
16992
|
#
|
16911
16993
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
16912
16994
|
# Authentication to authenticate users that connect to the DB cluster.
|
16913
|
-
# For more information, see [
|
16914
|
-
#
|
16995
|
+
# For more information, see [Kerberos Authentication][1] in the
|
16996
|
+
# *Amazon Aurora User Guide*.
|
16915
16997
|
#
|
16916
16998
|
#
|
16917
16999
|
#
|
16918
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
17000
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
16919
17001
|
# @return [String]
|
16920
17002
|
#
|
16921
17003
|
# @!attribute [rw] domain_iam_role_name
|
@@ -18614,7 +18696,7 @@ module Aws::RDS
|
|
18614
18696
|
#
|
18615
18697
|
# @!attribute [rw] source_regions
|
18616
18698
|
# A list of SourceRegion instances that contains each source AWS
|
18617
|
-
# Region that the current AWS Region can get a
|
18699
|
+
# Region that the current AWS Region can get a read replica or a DB
|
18618
18700
|
# snapshot from.
|
18619
18701
|
# @return [Array<Types::SourceRegion>]
|
18620
18702
|
#
|
@@ -18821,17 +18903,19 @@ module Aws::RDS
|
|
18821
18903
|
# provided, all the snapshot data is exported. Valid values are the
|
18822
18904
|
# following:
|
18823
18905
|
#
|
18824
|
-
# * `database` - Export all the data
|
18906
|
+
# * `database` - Export all the data from a specified database.
|
18825
18907
|
#
|
18826
|
-
# * `database.table
|
18908
|
+
# * `database.table` *table-name* - Export a table of the snapshot.
|
18909
|
+
# This format is valid only for RDS for MySQL, RDS for MariaDB, and
|
18910
|
+
# Aurora MySQL.
|
18827
18911
|
#
|
18828
|
-
# * `database.schema
|
18829
|
-
# snapshot. This
|
18830
|
-
#
|
18912
|
+
# * `database.schema` *schema-name* - Export a database schema of the
|
18913
|
+
# snapshot. This format is valid only for RDS for PostgreSQL and
|
18914
|
+
# Aurora PostgreSQL.
|
18831
18915
|
#
|
18832
|
-
# * `database.schema.table
|
18833
|
-
# database schema. This
|
18834
|
-
#
|
18916
|
+
# * `database.schema.table` *table-name* - Export a table of the
|
18917
|
+
# database schema. This format is valid only for RDS for PostgreSQL
|
18918
|
+
# and Aurora PostgreSQL.
|
18835
18919
|
# @return [Array<String>]
|
18836
18920
|
#
|
18837
18921
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartExportTaskMessage AWS API Documentation
|
@@ -19083,6 +19167,40 @@ module Aws::RDS
|
|
19083
19167
|
include Aws::Structure
|
19084
19168
|
end
|
19085
19169
|
|
19170
|
+
# <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
|
19171
|
+
# preview release. It is subject to change.
|
19172
|
+
#
|
19173
|
+
# </note>
|
19174
|
+
#
|
19175
|
+
# Information about the connection health of an RDS Proxy target.
|
19176
|
+
#
|
19177
|
+
# @!attribute [rw] state
|
19178
|
+
# The current state of the connection health lifecycle for the RDS
|
19179
|
+
# Proxy target. The following is a typical lifecycle example for the
|
19180
|
+
# states of an RDS Proxy target:
|
19181
|
+
#
|
19182
|
+
# `registering` > `unavailable` > `available` > `unavailable`
|
19183
|
+
# > `available`
|
19184
|
+
# @return [String]
|
19185
|
+
#
|
19186
|
+
# @!attribute [rw] reason
|
19187
|
+
# The reason for the current health `State` of the RDS Proxy target.
|
19188
|
+
# @return [String]
|
19189
|
+
#
|
19190
|
+
# @!attribute [rw] description
|
19191
|
+
# A description of the health of the RDS Proxy target. If the `State`
|
19192
|
+
# is `AVAILABLE`, a description is not included.
|
19193
|
+
# @return [String]
|
19194
|
+
#
|
19195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/TargetHealth AWS API Documentation
|
19196
|
+
#
|
19197
|
+
class TargetHealth < Struct.new(
|
19198
|
+
:state,
|
19199
|
+
:reason,
|
19200
|
+
:description)
|
19201
|
+
include Aws::Structure
|
19202
|
+
end
|
19203
|
+
|
19086
19204
|
# A time zone associated with a `DBInstance` or a `DBSnapshot`. This
|
19087
19205
|
# data type is an element in the response to the `DescribeDBInstances`,
|
19088
19206
|
# the `DescribeDBSnapshots`, and the `DescribeDBEngineVersions` actions.
|