aws-sdk-rds 1.131.0 → 1.132.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1429 -297
- data/lib/aws-sdk-rds/client_api.rb +59 -0
- data/lib/aws-sdk-rds/db_cluster.rb +727 -65
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +12 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +166 -14
- data/lib/aws-sdk-rds/db_instance.rb +76 -69
- data/lib/aws-sdk-rds/db_snapshot.rb +12 -11
- data/lib/aws-sdk-rds/resource.rb +345 -57
- data/lib/aws-sdk-rds/types.rb +1652 -258
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -158,7 +158,7 @@ module Aws::RDS
|
|
158
158
|
#
|
159
159
|
# @!attribute [rw] role_arn
|
160
160
|
# The Amazon Resource Name (ARN) of the IAM role to associate with the
|
161
|
-
# Aurora DB cluster, for example
|
161
|
+
# Aurora DB cluster, for example
|
162
162
|
# `arn:aws:iam::123456789012:role/AuroraAccessRole`.
|
163
163
|
# @return [String]
|
164
164
|
#
|
@@ -1830,7 +1830,7 @@ module Aws::RDS
|
|
1830
1830
|
# @return [String]
|
1831
1831
|
#
|
1832
1832
|
# @!attribute [rw] endpoint_type
|
1833
|
-
# The type of the endpoint
|
1833
|
+
# The type of the endpoint, one of: `READER`, `WRITER`, `ANY`.
|
1834
1834
|
# @return [String]
|
1835
1835
|
#
|
1836
1836
|
# @!attribute [rw] static_members
|
@@ -1841,8 +1841,8 @@ module Aws::RDS
|
|
1841
1841
|
# @!attribute [rw] excluded_members
|
1842
1842
|
# List of DB instance identifiers that aren't part of the custom
|
1843
1843
|
# endpoint group. All other eligible instances are reachable through
|
1844
|
-
# the custom endpoint.
|
1845
|
-
# empty.
|
1844
|
+
# the custom endpoint. This parameter is relevant only if the list of
|
1845
|
+
# static members is empty.
|
1846
1846
|
# @return [Array<String>]
|
1847
1847
|
#
|
1848
1848
|
# @!attribute [rw] tags
|
@@ -1911,14 +1911,29 @@ module Aws::RDS
|
|
1911
1911
|
# domain: "String",
|
1912
1912
|
# domain_iam_role_name: "String",
|
1913
1913
|
# enable_global_write_forwarding: false,
|
1914
|
+
# db_cluster_instance_class: "String",
|
1915
|
+
# allocated_storage: 1,
|
1916
|
+
# storage_type: "String",
|
1917
|
+
# iops: 1,
|
1918
|
+
# publicly_accessible: false,
|
1919
|
+
# auto_minor_version_upgrade: false,
|
1920
|
+
# monitoring_interval: 1,
|
1921
|
+
# monitoring_role_arn: "String",
|
1922
|
+
# enable_performance_insights: false,
|
1923
|
+
# performance_insights_kms_key_id: "String",
|
1924
|
+
# performance_insights_retention_period: 1,
|
1914
1925
|
# source_region: "String",
|
1915
1926
|
# }
|
1916
1927
|
#
|
1917
1928
|
# @!attribute [rw] availability_zones
|
1918
|
-
# A list of Availability Zones (AZs) where instances in the DB
|
1919
|
-
# can be created.
|
1920
|
-
#
|
1921
|
-
#
|
1929
|
+
# A list of Availability Zones (AZs) where DB instances in the DB
|
1930
|
+
# cluster can be created.
|
1931
|
+
#
|
1932
|
+
# For information on Amazon Web Services Regions and Availability
|
1933
|
+
# Zones, see [Choosing the Regions and Availability Zones][1] in the
|
1934
|
+
# *Amazon Aurora User Guide*.
|
1935
|
+
#
|
1936
|
+
# Valid for: Aurora DB clusters only
|
1922
1937
|
#
|
1923
1938
|
#
|
1924
1939
|
#
|
@@ -1935,17 +1950,23 @@ module Aws::RDS
|
|
1935
1950
|
# * Must be a value from 1 to 35
|
1936
1951
|
#
|
1937
1952
|
# ^
|
1953
|
+
#
|
1954
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1938
1955
|
# @return [Integer]
|
1939
1956
|
#
|
1940
1957
|
# @!attribute [rw] character_set_name
|
1941
1958
|
# A value that indicates that the DB cluster should be associated with
|
1942
1959
|
# the specified CharacterSet.
|
1960
|
+
#
|
1961
|
+
# Valid for: Aurora DB clusters only
|
1943
1962
|
# @return [String]
|
1944
1963
|
#
|
1945
1964
|
# @!attribute [rw] database_name
|
1946
1965
|
# The name for your database of up to 64 alphanumeric characters. If
|
1947
1966
|
# you do not provide a name, Amazon RDS doesn't create a database in
|
1948
1967
|
# the DB cluster you are creating.
|
1968
|
+
#
|
1969
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1949
1970
|
# @return [String]
|
1950
1971
|
#
|
1951
1972
|
# @!attribute [rw] db_cluster_identifier
|
@@ -1961,6 +1982,8 @@ module Aws::RDS
|
|
1961
1982
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
1962
1983
|
#
|
1963
1984
|
# Example: `my-cluster1`
|
1985
|
+
#
|
1986
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1964
1987
|
# @return [String]
|
1965
1988
|
#
|
1966
1989
|
# @!attribute [rw] db_cluster_parameter_group_name
|
@@ -1974,66 +1997,127 @@ module Aws::RDS
|
|
1974
1997
|
# parameter group.
|
1975
1998
|
#
|
1976
1999
|
# ^
|
2000
|
+
#
|
2001
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1977
2002
|
# @return [String]
|
1978
2003
|
#
|
1979
2004
|
# @!attribute [rw] vpc_security_group_ids
|
1980
2005
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
2006
|
+
#
|
2007
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1981
2008
|
# @return [Array<String>]
|
1982
2009
|
#
|
1983
2010
|
# @!attribute [rw] db_subnet_group_name
|
1984
2011
|
# A DB subnet group to associate with this DB cluster.
|
1985
2012
|
#
|
2013
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2014
|
+
#
|
1986
2015
|
# Constraints: Must match the name of an existing DBSubnetGroup. Must
|
1987
2016
|
# not be default.
|
1988
2017
|
#
|
1989
2018
|
# Example: `mySubnetgroup`
|
2019
|
+
#
|
2020
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1990
2021
|
# @return [String]
|
1991
2022
|
#
|
1992
2023
|
# @!attribute [rw] engine
|
1993
2024
|
# The name of the database engine to be used for this DB cluster.
|
1994
2025
|
#
|
1995
|
-
# Valid Values:
|
1996
|
-
#
|
1997
|
-
# `aurora-
|
2026
|
+
# Valid Values:
|
2027
|
+
#
|
2028
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
2029
|
+
#
|
2030
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
2031
|
+
#
|
2032
|
+
# * `aurora-postgresql`
|
2033
|
+
#
|
2034
|
+
# * `mysql`
|
2035
|
+
#
|
2036
|
+
# * `postgres`
|
2037
|
+
#
|
2038
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1998
2039
|
# @return [String]
|
1999
2040
|
#
|
2000
2041
|
# @!attribute [rw] engine_version
|
2001
2042
|
# The version number of the database engine to use.
|
2002
2043
|
#
|
2003
|
-
# To list all of the available engine versions for
|
2004
|
-
# 5.6-compatible Aurora
|
2044
|
+
# To list all of the available engine versions for MySQL
|
2045
|
+
# 5.6-compatible Aurora, use the following command:
|
2005
2046
|
#
|
2006
2047
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
2007
2048
|
# "DBEngineVersions[].EngineVersion"`
|
2008
2049
|
#
|
2009
|
-
# To list all of the available engine versions for
|
2010
|
-
#
|
2050
|
+
# To list all of the available engine versions for MySQL
|
2051
|
+
# 5.7-compatible Aurora, use the following command:
|
2011
2052
|
#
|
2012
2053
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
2013
2054
|
# "DBEngineVersions[].EngineVersion"`
|
2014
2055
|
#
|
2015
|
-
# To list all of the available engine versions for
|
2016
|
-
#
|
2056
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
2057
|
+
# use the following command:
|
2017
2058
|
#
|
2018
2059
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
2019
2060
|
# --query "DBEngineVersions[].EngineVersion"`
|
2020
2061
|
#
|
2062
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
2063
|
+
# the following command:
|
2064
|
+
#
|
2065
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
2066
|
+
# "DBEngineVersions[].EngineVersion"`
|
2067
|
+
#
|
2068
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
2069
|
+
# use the following command:
|
2070
|
+
#
|
2071
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
2072
|
+
# "DBEngineVersions[].EngineVersion"`
|
2073
|
+
#
|
2021
2074
|
# **Aurora MySQL**
|
2022
2075
|
#
|
2023
|
-
#
|
2024
|
-
#
|
2076
|
+
# For information, see [MySQL on Amazon RDS Versions][1] in the
|
2077
|
+
# *Amazon Aurora User Guide.*
|
2025
2078
|
#
|
2026
2079
|
# **Aurora PostgreSQL**
|
2027
2080
|
#
|
2028
|
-
#
|
2081
|
+
# For information, see [Amazon Aurora PostgreSQL releases and engine
|
2082
|
+
# versions][2] in the *Amazon Aurora User Guide.*
|
2083
|
+
#
|
2084
|
+
# **MySQL**
|
2085
|
+
#
|
2086
|
+
# For information, see [MySQL on Amazon RDS Versions][3] in the
|
2087
|
+
# *Amazon RDS User Guide.*
|
2088
|
+
#
|
2089
|
+
# **PostgreSQL**
|
2090
|
+
#
|
2091
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
2092
|
+
# extensions][4] in the *Amazon RDS User Guide.*
|
2093
|
+
#
|
2094
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2095
|
+
#
|
2096
|
+
#
|
2097
|
+
#
|
2098
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
|
2099
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
|
2100
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
2101
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
2029
2102
|
# @return [String]
|
2030
2103
|
#
|
2031
2104
|
# @!attribute [rw] port
|
2032
2105
|
# The port number on which the instances in the DB cluster accept
|
2033
2106
|
# connections.
|
2034
2107
|
#
|
2035
|
-
#
|
2036
|
-
#
|
2108
|
+
# **RDS for MySQL and Aurora MySQL**
|
2109
|
+
#
|
2110
|
+
# Default: `3306`
|
2111
|
+
#
|
2112
|
+
# Valid values: `1150-65535`
|
2113
|
+
#
|
2114
|
+
# **RDS for PostgreSQL and Aurora PostgreSQL**
|
2115
|
+
#
|
2116
|
+
# Default: `5432`
|
2117
|
+
#
|
2118
|
+
# Valid values: `1150-65535`
|
2119
|
+
#
|
2120
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2037
2121
|
# @return [Integer]
|
2038
2122
|
#
|
2039
2123
|
# @!attribute [rw] master_username
|
@@ -2046,6 +2130,8 @@ module Aws::RDS
|
|
2046
2130
|
# * First character must be a letter.
|
2047
2131
|
#
|
2048
2132
|
# * Can't be a reserved word for the chosen database engine.
|
2133
|
+
#
|
2134
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2049
2135
|
# @return [String]
|
2050
2136
|
#
|
2051
2137
|
# @!attribute [rw] master_user_password
|
@@ -2053,15 +2139,16 @@ module Aws::RDS
|
|
2053
2139
|
# any printable ASCII character except "/", """, or "@".
|
2054
2140
|
#
|
2055
2141
|
# Constraints: Must contain from 8 to 41 characters.
|
2142
|
+
#
|
2143
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2056
2144
|
# @return [String]
|
2057
2145
|
#
|
2058
2146
|
# @!attribute [rw] option_group_name
|
2059
2147
|
# A value that indicates that the DB cluster should be associated with
|
2060
2148
|
# the specified option group.
|
2061
2149
|
#
|
2062
|
-
#
|
2063
|
-
#
|
2064
|
-
# a DB cluster.
|
2150
|
+
# DB clusters are associated with a default option group that can't
|
2151
|
+
# be modified.
|
2065
2152
|
# @return [String]
|
2066
2153
|
#
|
2067
2154
|
# @!attribute [rw] preferred_backup_window
|
@@ -2084,6 +2171,8 @@ module Aws::RDS
|
|
2084
2171
|
#
|
2085
2172
|
# * Must be at least 30 minutes.
|
2086
2173
|
#
|
2174
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2175
|
+
#
|
2087
2176
|
#
|
2088
2177
|
#
|
2089
2178
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -2105,6 +2194,8 @@ module Aws::RDS
|
|
2105
2194
|
#
|
2106
2195
|
# Constraints: Minimum 30-minute window.
|
2107
2196
|
#
|
2197
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2198
|
+
#
|
2108
2199
|
#
|
2109
2200
|
#
|
2110
2201
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
@@ -2113,14 +2204,20 @@ module Aws::RDS
|
|
2113
2204
|
# @!attribute [rw] replication_source_identifier
|
2114
2205
|
# The Amazon Resource Name (ARN) of the source DB instance or DB
|
2115
2206
|
# cluster if this DB cluster is created as a read replica.
|
2207
|
+
#
|
2208
|
+
# Valid for: Aurora DB clusters only
|
2116
2209
|
# @return [String]
|
2117
2210
|
#
|
2118
2211
|
# @!attribute [rw] tags
|
2119
2212
|
# Tags to assign to the DB cluster.
|
2213
|
+
#
|
2214
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2120
2215
|
# @return [Array<Types::Tag>]
|
2121
2216
|
#
|
2122
2217
|
# @!attribute [rw] storage_encrypted
|
2123
2218
|
# A value that indicates whether the DB cluster is encrypted.
|
2219
|
+
#
|
2220
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2124
2221
|
# @return [Boolean]
|
2125
2222
|
#
|
2126
2223
|
# @!attribute [rw] kms_key_id
|
@@ -2151,14 +2248,16 @@ module Aws::RDS
|
|
2151
2248
|
# identifier that is valid in the destination Amazon Web Services
|
2152
2249
|
# Region. This KMS key is used to encrypt the read replica in that
|
2153
2250
|
# Amazon Web Services Region.
|
2251
|
+
#
|
2252
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2154
2253
|
# @return [String]
|
2155
2254
|
#
|
2156
2255
|
# @!attribute [rw] pre_signed_url
|
2157
2256
|
# A URL that contains a Signature Version 4 signed request for the
|
2158
2257
|
# `CreateDBCluster` action to be called in the source Amazon Web
|
2159
|
-
# Services Region where the DB cluster is replicated from.
|
2160
|
-
#
|
2161
|
-
#
|
2258
|
+
# Services Region where the DB cluster is replicated from. Specify
|
2259
|
+
# `PreSignedUrl` only when you are performing cross-Region replication
|
2260
|
+
# from an encrypted DB cluster.
|
2162
2261
|
#
|
2163
2262
|
# The pre-signed URL must be a valid request for the `CreateDBCluster`
|
2164
2263
|
# API action that can be executed in the source Amazon Web Services
|
@@ -2199,6 +2298,8 @@ module Aws::RDS
|
|
2199
2298
|
#
|
2200
2299
|
# </note>
|
2201
2300
|
#
|
2301
|
+
# Valid for: Aurora DB clusters only
|
2302
|
+
#
|
2202
2303
|
#
|
2203
2304
|
#
|
2204
2305
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -2208,11 +2309,13 @@ module Aws::RDS
|
|
2208
2309
|
# @!attribute [rw] enable_iam_database_authentication
|
2209
2310
|
# A value that indicates whether to enable mapping of Amazon Web
|
2210
2311
|
# Services Identity and Access Management (IAM) accounts to database
|
2211
|
-
# accounts. By default, mapping
|
2312
|
+
# accounts. By default, mapping isn't enabled.
|
2212
2313
|
#
|
2213
2314
|
# For more information, see [ IAM Database Authentication][1] in the
|
2214
2315
|
# *Amazon Aurora User Guide.*
|
2215
2316
|
#
|
2317
|
+
# Valid for: Aurora DB clusters only
|
2318
|
+
#
|
2216
2319
|
#
|
2217
2320
|
#
|
2218
2321
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -2222,10 +2325,6 @@ module Aws::RDS
|
|
2222
2325
|
# The target backtrack window, in seconds. To disable backtracking,
|
2223
2326
|
# set this value to 0.
|
2224
2327
|
#
|
2225
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
2226
|
-
#
|
2227
|
-
# </note>
|
2228
|
-
#
|
2229
2328
|
# Default: 0
|
2230
2329
|
#
|
2231
2330
|
# Constraints:
|
@@ -2234,6 +2333,8 @@ module Aws::RDS
|
|
2234
2333
|
# (72 hours).
|
2235
2334
|
#
|
2236
2335
|
# ^
|
2336
|
+
#
|
2337
|
+
# Valid for: Aurora MySQL DB clusters only
|
2237
2338
|
# @return [Integer]
|
2238
2339
|
#
|
2239
2340
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -2250,6 +2351,8 @@ module Aws::RDS
|
|
2250
2351
|
#
|
2251
2352
|
# Possible value is `postgresql`.
|
2252
2353
|
#
|
2354
|
+
# Valid for: Aurora DB clusters only
|
2355
|
+
#
|
2253
2356
|
#
|
2254
2357
|
#
|
2255
2358
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -2286,6 +2389,8 @@ module Aws::RDS
|
|
2286
2389
|
#
|
2287
2390
|
# * [ Limitations of Multi-Master Clusters][4]
|
2288
2391
|
#
|
2392
|
+
# Valid for: Aurora DB clusters only
|
2393
|
+
#
|
2289
2394
|
#
|
2290
2395
|
#
|
2291
2396
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
@@ -2297,17 +2402,24 @@ module Aws::RDS
|
|
2297
2402
|
# @!attribute [rw] scaling_configuration
|
2298
2403
|
# For DB clusters in `serverless` DB engine mode, the scaling
|
2299
2404
|
# properties of the DB cluster.
|
2405
|
+
#
|
2406
|
+
# Valid for: Aurora DB clusters only
|
2300
2407
|
# @return [Types::ScalingConfiguration]
|
2301
2408
|
#
|
2302
2409
|
# @!attribute [rw] deletion_protection
|
2303
2410
|
# A value that indicates whether the DB cluster has deletion
|
2304
2411
|
# protection enabled. The database can't be deleted when deletion
|
2305
|
-
# protection is enabled. By default, deletion protection
|
2412
|
+
# protection is enabled. By default, deletion protection isn't
|
2413
|
+
# enabled.
|
2414
|
+
#
|
2415
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2306
2416
|
# @return [Boolean]
|
2307
2417
|
#
|
2308
2418
|
# @!attribute [rw] global_cluster_identifier
|
2309
2419
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
2310
2420
|
# cluster in the new global database cluster.
|
2421
|
+
#
|
2422
|
+
# Valid for: Aurora DB clusters only
|
2311
2423
|
# @return [String]
|
2312
2424
|
#
|
2313
2425
|
# @!attribute [rw] enable_http_endpoint
|
@@ -2323,6 +2435,8 @@ module Aws::RDS
|
|
2323
2435
|
# For more information, see [Using the Data API for Aurora
|
2324
2436
|
# Serverless][1] in the *Amazon Aurora User Guide*.
|
2325
2437
|
#
|
2438
|
+
# Valid for: Aurora DB clusters only
|
2439
|
+
#
|
2326
2440
|
#
|
2327
2441
|
#
|
2328
2442
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
@@ -2331,16 +2445,21 @@ module Aws::RDS
|
|
2331
2445
|
# @!attribute [rw] copy_tags_to_snapshot
|
2332
2446
|
# A value that indicates whether to copy all tags from the DB cluster
|
2333
2447
|
# to snapshots of the DB cluster. The default is not to copy them.
|
2448
|
+
#
|
2449
|
+
# Valid for: Aurora DB clusters only
|
2334
2450
|
# @return [Boolean]
|
2335
2451
|
#
|
2336
2452
|
# @!attribute [rw] domain
|
2337
2453
|
# The Active Directory directory ID to create the DB cluster in.
|
2338
2454
|
#
|
2339
2455
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
2340
|
-
#
|
2341
|
-
#
|
2456
|
+
# authentication to authenticate users that connect to the DB cluster.
|
2457
|
+
#
|
2458
|
+
# For more information, see [Kerberos authentication][1] in the
|
2342
2459
|
# *Amazon Aurora User Guide*.
|
2343
2460
|
#
|
2461
|
+
# Valid for: Aurora DB clusters only
|
2462
|
+
#
|
2344
2463
|
#
|
2345
2464
|
#
|
2346
2465
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
@@ -2349,6 +2468,8 @@ module Aws::RDS
|
|
2349
2468
|
# @!attribute [rw] domain_iam_role_name
|
2350
2469
|
# Specify the name of the IAM role to be used when making API calls to
|
2351
2470
|
# the Directory Service.
|
2471
|
+
#
|
2472
|
+
# Valid for: Aurora DB clusters only
|
2352
2473
|
# @return [String]
|
2353
2474
|
#
|
2354
2475
|
# @!attribute [rw] enable_global_write_forwarding
|
@@ -2365,8 +2486,186 @@ module Aws::RDS
|
|
2365
2486
|
# the primary DB cluster of an Aurora global database, this value is
|
2366
2487
|
# used immediately if the primary is demoted by the
|
2367
2488
|
# FailoverGlobalCluster API operation, but it does nothing until then.
|
2489
|
+
#
|
2490
|
+
# Valid for: Aurora DB clusters only
|
2491
|
+
# @return [Boolean]
|
2492
|
+
#
|
2493
|
+
# @!attribute [rw] db_cluster_instance_class
|
2494
|
+
# The compute and memory capacity of each DB instance in the Multi-AZ
|
2495
|
+
# DB cluster, for example db.m6g.xlarge. Not all DB instance classes
|
2496
|
+
# are available in all Amazon Web Services Regions, or for all
|
2497
|
+
# database engines.
|
2498
|
+
#
|
2499
|
+
# For the full list of DB instance classes and availability for your
|
2500
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide.*
|
2501
|
+
#
|
2502
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2503
|
+
#
|
2504
|
+
# Valid for: Multi-AZ DB clusters only
|
2505
|
+
#
|
2506
|
+
#
|
2507
|
+
#
|
2508
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
2509
|
+
# @return [String]
|
2510
|
+
#
|
2511
|
+
# @!attribute [rw] allocated_storage
|
2512
|
+
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
2513
|
+
# instance in the Multi-AZ DB cluster.
|
2514
|
+
#
|
2515
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2516
|
+
#
|
2517
|
+
# Valid for: Multi-AZ DB clusters only
|
2518
|
+
# @return [Integer]
|
2519
|
+
#
|
2520
|
+
# @!attribute [rw] storage_type
|
2521
|
+
# Specifies the storage type to be associated with the DB cluster.
|
2522
|
+
#
|
2523
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2524
|
+
#
|
2525
|
+
# Valid values: `standard | gp2 | io1`
|
2526
|
+
#
|
2527
|
+
# If you specify `io1`, also include a value for the `Iops` parameter.
|
2528
|
+
#
|
2529
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2530
|
+
#
|
2531
|
+
# Valid for: Multi-AZ DB clusters only
|
2532
|
+
# @return [String]
|
2533
|
+
#
|
2534
|
+
# @!attribute [rw] iops
|
2535
|
+
# The amount of Provisioned IOPS (input/output operations per second)
|
2536
|
+
# to be initially allocated for each DB instance in the Multi-AZ DB
|
2537
|
+
# cluster.
|
2538
|
+
#
|
2539
|
+
# For information about valid `Iops` values, see [Amazon RDS
|
2540
|
+
# Provisioned IOPS storage to improve performance][1] in the *Amazon
|
2541
|
+
# RDS User Guide*.
|
2542
|
+
#
|
2543
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2544
|
+
#
|
2545
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
2546
|
+
# amount for the DB cluster.
|
2547
|
+
#
|
2548
|
+
# Valid for: Multi-AZ DB clusters only
|
2549
|
+
#
|
2550
|
+
#
|
2551
|
+
#
|
2552
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
2553
|
+
# @return [Integer]
|
2554
|
+
#
|
2555
|
+
# @!attribute [rw] publicly_accessible
|
2556
|
+
# A value that indicates whether the DB cluster is publicly
|
2557
|
+
# accessible.
|
2558
|
+
#
|
2559
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
2560
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
2561
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
2562
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
2563
|
+
# cluster is ultimately controlled by the security group it uses. That
|
2564
|
+
# public access isn't permitted if the security group assigned to the
|
2565
|
+
# DB cluster doesn't permit it.
|
2566
|
+
#
|
2567
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
2568
|
+
# cluster with a DNS name that resolves to a private IP address.
|
2569
|
+
#
|
2570
|
+
# Default: The default behavior varies depending on whether
|
2571
|
+
# `DBSubnetGroupName` is specified.
|
2572
|
+
#
|
2573
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
2574
|
+
# isn't specified, the following applies:
|
2575
|
+
#
|
2576
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
2577
|
+
# gateway attached to it, the DB cluster is private.
|
2578
|
+
#
|
2579
|
+
# * If the default VPC in the target Region has an internet gateway
|
2580
|
+
# attached to it, the DB cluster is public.
|
2581
|
+
#
|
2582
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
2583
|
+
# specified, the following applies:
|
2584
|
+
#
|
2585
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
2586
|
+
# gateway attached to it, the DB cluster is private.
|
2587
|
+
#
|
2588
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
2589
|
+
# attached to it, the DB cluster is public.
|
2590
|
+
#
|
2591
|
+
# Valid for: Multi-AZ DB clusters only
|
2592
|
+
# @return [Boolean]
|
2593
|
+
#
|
2594
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
2595
|
+
# A value that indicates whether minor engine upgrades are applied
|
2596
|
+
# automatically to the DB cluster during the maintenance window. By
|
2597
|
+
# default, minor engine upgrades are applied automatically.
|
2598
|
+
#
|
2599
|
+
# Valid for: Multi-AZ DB clusters only
|
2368
2600
|
# @return [Boolean]
|
2369
2601
|
#
|
2602
|
+
# @!attribute [rw] monitoring_interval
|
2603
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
2604
|
+
# metrics are collected for the DB cluster. To turn off collecting
|
2605
|
+
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
2606
|
+
#
|
2607
|
+
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval`
|
2608
|
+
# to a value other than 0.
|
2609
|
+
#
|
2610
|
+
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
2611
|
+
#
|
2612
|
+
# Valid for: Multi-AZ DB clusters only
|
2613
|
+
# @return [Integer]
|
2614
|
+
#
|
2615
|
+
# @!attribute [rw] monitoring_role_arn
|
2616
|
+
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
2617
|
+
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An
|
2618
|
+
# example is `arn:aws:iam:123456789012:role/emaccess`. For information
|
2619
|
+
# on creating a monitoring role, see [Setting up and enabling Enhanced
|
2620
|
+
# Monitoring][1] in the *Amazon RDS User Guide*.
|
2621
|
+
#
|
2622
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
2623
|
+
# `MonitoringRoleArn` value.
|
2624
|
+
#
|
2625
|
+
# Valid for: Multi-AZ DB clusters only
|
2626
|
+
#
|
2627
|
+
#
|
2628
|
+
#
|
2629
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
2630
|
+
# @return [String]
|
2631
|
+
#
|
2632
|
+
# @!attribute [rw] enable_performance_insights
|
2633
|
+
# A value that indicates whether to turn on Performance Insights for
|
2634
|
+
# the DB cluster.
|
2635
|
+
#
|
2636
|
+
# For more information, see [ Using Amazon Performance Insights][1] in
|
2637
|
+
# the *Amazon RDS User Guide*.
|
2638
|
+
#
|
2639
|
+
# Valid for: Multi-AZ DB clusters only
|
2640
|
+
#
|
2641
|
+
#
|
2642
|
+
#
|
2643
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
2644
|
+
# @return [Boolean]
|
2645
|
+
#
|
2646
|
+
# @!attribute [rw] performance_insights_kms_key_id
|
2647
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
2648
|
+
# Performance Insights data.
|
2649
|
+
#
|
2650
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2651
|
+
# alias ARN, or alias name for the KMS key.
|
2652
|
+
#
|
2653
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`,
|
2654
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
2655
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
2656
|
+
# account has a different default KMS key for each Amazon Web Services
|
2657
|
+
# Region.
|
2658
|
+
#
|
2659
|
+
# Valid for: Multi-AZ DB clusters only
|
2660
|
+
# @return [String]
|
2661
|
+
#
|
2662
|
+
# @!attribute [rw] performance_insights_retention_period
|
2663
|
+
# The amount of time, in days, to retain Performance Insights data.
|
2664
|
+
# Valid values are 7 or 731 (2 years).
|
2665
|
+
#
|
2666
|
+
# Valid for: Multi-AZ DB clusters only
|
2667
|
+
# @return [Integer]
|
2668
|
+
#
|
2370
2669
|
# @!attribute [rw] source_region
|
2371
2670
|
# The source region of the snapshot. This is only needed when the
|
2372
2671
|
# shapshot is encrypted and in a different region.
|
@@ -2408,6 +2707,17 @@ module Aws::RDS
|
|
2408
2707
|
:domain,
|
2409
2708
|
:domain_iam_role_name,
|
2410
2709
|
:enable_global_write_forwarding,
|
2710
|
+
:db_cluster_instance_class,
|
2711
|
+
:allocated_storage,
|
2712
|
+
:storage_type,
|
2713
|
+
:iops,
|
2714
|
+
:publicly_accessible,
|
2715
|
+
:auto_minor_version_upgrade,
|
2716
|
+
:monitoring_interval,
|
2717
|
+
:monitoring_role_arn,
|
2718
|
+
:enable_performance_insights,
|
2719
|
+
:performance_insights_kms_key_id,
|
2720
|
+
:performance_insights_retention_period,
|
2411
2721
|
:source_region)
|
2412
2722
|
SENSITIVE = []
|
2413
2723
|
include Aws::Structure
|
@@ -2433,7 +2743,7 @@ module Aws::RDS
|
|
2433
2743
|
#
|
2434
2744
|
# Constraints:
|
2435
2745
|
#
|
2436
|
-
# * Must match the name of an existing DB cluster parameter group.
|
2746
|
+
# * Must not match the name of an existing DB cluster parameter group.
|
2437
2747
|
#
|
2438
2748
|
# ^
|
2439
2749
|
#
|
@@ -2457,6 +2767,14 @@ module Aws::RDS
|
|
2457
2767
|
#
|
2458
2768
|
# Example: `aurora-postgresql9.6`
|
2459
2769
|
#
|
2770
|
+
# **RDS for MySQL**
|
2771
|
+
#
|
2772
|
+
# Example: `mysql8.0`
|
2773
|
+
#
|
2774
|
+
# **RDS for PostgreSQL**
|
2775
|
+
#
|
2776
|
+
# Example: `postgres12`
|
2777
|
+
#
|
2460
2778
|
# To list all of the available parameter group families for a DB
|
2461
2779
|
# engine, use the following command:
|
2462
2780
|
#
|
@@ -2481,6 +2799,10 @@ module Aws::RDS
|
|
2481
2799
|
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
2482
2800
|
#
|
2483
2801
|
# * `aurora-postgresql`
|
2802
|
+
#
|
2803
|
+
# * `mysql`
|
2804
|
+
#
|
2805
|
+
# * `postgres`
|
2484
2806
|
# @return [String]
|
2485
2807
|
#
|
2486
2808
|
# @!attribute [rw] description
|
@@ -2518,10 +2840,39 @@ module Aws::RDS
|
|
2518
2840
|
end
|
2519
2841
|
|
2520
2842
|
# @!attribute [rw] db_cluster
|
2521
|
-
# Contains the details of an Amazon Aurora DB cluster
|
2843
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
2844
|
+
# cluster.
|
2522
2845
|
#
|
2523
|
-
#
|
2524
|
-
#
|
2846
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
2847
|
+
# response element in the operations `CreateDBCluster`,
|
2848
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
2849
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
2850
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
2851
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
2852
|
+
# `StopDBCluster`.
|
2853
|
+
#
|
2854
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
2855
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
2856
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
2857
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
2858
|
+
# `RestoreDBClusterToPointInTime`.
|
2859
|
+
#
|
2860
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
2861
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
2862
|
+
#
|
2863
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
2864
|
+
# deployments with two readable standby DB instances][2] in the
|
2865
|
+
# *Amazon RDS User Guide.*
|
2866
|
+
#
|
2867
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
2868
|
+
# change.
|
2869
|
+
#
|
2870
|
+
# </note>
|
2871
|
+
#
|
2872
|
+
#
|
2873
|
+
#
|
2874
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
2875
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
2525
2876
|
# @return [Types::DBCluster]
|
2526
2877
|
#
|
2527
2878
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterResult AWS API Documentation
|
@@ -2899,11 +3250,11 @@ module Aws::RDS
|
|
2899
3250
|
# @return [Integer]
|
2900
3251
|
#
|
2901
3252
|
# @!attribute [rw] db_instance_class
|
2902
|
-
# The compute and memory capacity of the DB instance, for example
|
2903
|
-
#
|
2904
|
-
#
|
2905
|
-
#
|
2906
|
-
#
|
3253
|
+
# The compute and memory capacity of the DB instance, for example
|
3254
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
3255
|
+
# Web Services Regions, or for all database engines. For the full list
|
3256
|
+
# of DB instance classes, and availability for your engine, see [DB
|
3257
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
2907
3258
|
#
|
2908
3259
|
#
|
2909
3260
|
#
|
@@ -3223,28 +3574,28 @@ module Aws::RDS
|
|
3223
3574
|
#
|
3224
3575
|
# **MariaDB**
|
3225
3576
|
#
|
3226
|
-
#
|
3227
|
-
# Guide.*
|
3577
|
+
# For information, see [MariaDB on Amazon RDS Versions][2] in the
|
3578
|
+
# *Amazon RDS User Guide.*
|
3228
3579
|
#
|
3229
3580
|
# **Microsoft SQL Server**
|
3230
3581
|
#
|
3231
|
-
#
|
3232
|
-
# RDS User Guide.*
|
3582
|
+
# For information, see [Microsoft SQL Server Versions on Amazon
|
3583
|
+
# RDS][3] in the *Amazon RDS User Guide.*
|
3233
3584
|
#
|
3234
3585
|
# **MySQL**
|
3235
3586
|
#
|
3236
|
-
#
|
3237
|
-
# Guide.*
|
3587
|
+
# For information, see [MySQL on Amazon RDS Versions][4] in the
|
3588
|
+
# *Amazon RDS User Guide.*
|
3238
3589
|
#
|
3239
3590
|
# **Oracle**
|
3240
3591
|
#
|
3241
|
-
#
|
3242
|
-
# User Guide.*
|
3592
|
+
# For information, see [Oracle Database Engine Release Notes][5] in
|
3593
|
+
# the *Amazon RDS User Guide.*
|
3243
3594
|
#
|
3244
3595
|
# **PostgreSQL**
|
3245
3596
|
#
|
3246
|
-
#
|
3247
|
-
# *Amazon RDS User Guide.*
|
3597
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
3598
|
+
# extensions][6] in the *Amazon RDS User Guide.*
|
3248
3599
|
#
|
3249
3600
|
#
|
3250
3601
|
#
|
@@ -3277,8 +3628,8 @@ module Aws::RDS
|
|
3277
3628
|
# @!attribute [rw] iops
|
3278
3629
|
# The amount of Provisioned IOPS (input/output operations per second)
|
3279
3630
|
# to be initially allocated for the DB instance. For information about
|
3280
|
-
# valid Iops values, see [Amazon RDS Provisioned IOPS
|
3281
|
-
#
|
3631
|
+
# valid `Iops` values, see [Amazon RDS Provisioned IOPS storage to
|
3632
|
+
# improve performance][1] in the *Amazon RDS User Guide*.
|
3282
3633
|
#
|
3283
3634
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB
|
3284
3635
|
# instances, must be a multiple between .5 and 50 of the storage
|
@@ -3325,12 +3676,13 @@ module Aws::RDS
|
|
3325
3676
|
# A value that indicates whether the DB instance is publicly
|
3326
3677
|
# accessible.
|
3327
3678
|
#
|
3328
|
-
# When the DB instance is publicly accessible, its
|
3329
|
-
# resolves to the private IP address from within the DB
|
3330
|
-
#
|
3331
|
-
#
|
3332
|
-
#
|
3333
|
-
#
|
3679
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
3680
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
3681
|
+
# instance's virtual private cloud (VPC). It resolves to the public
|
3682
|
+
# IP address from outside of the DB instance's VPC. Access to the DB
|
3683
|
+
# instance is ultimately controlled by the security group it uses.
|
3684
|
+
# That public access is not permitted if the security group assigned
|
3685
|
+
# to the DB instance doesn't permit it.
|
3334
3686
|
#
|
3335
3687
|
# When the DB instance isn't publicly accessible, it is an internal
|
3336
3688
|
# DB instance with a DNS name that resolves to a private IP address.
|
@@ -3341,19 +3693,19 @@ module Aws::RDS
|
|
3341
3693
|
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
3342
3694
|
# isn't specified, the following applies:
|
3343
3695
|
#
|
3344
|
-
# * If the default VPC in the target
|
3696
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
3345
3697
|
# gateway attached to it, the DB instance is private.
|
3346
3698
|
#
|
3347
|
-
# * If the default VPC in the target
|
3699
|
+
# * If the default VPC in the target Region has an internet gateway
|
3348
3700
|
# attached to it, the DB instance is public.
|
3349
3701
|
#
|
3350
3702
|
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
3351
3703
|
# specified, the following applies:
|
3352
3704
|
#
|
3353
|
-
# * If the subnets are part of a VPC that doesn’t have an
|
3705
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
3354
3706
|
# gateway attached to it, the DB instance is private.
|
3355
3707
|
#
|
3356
|
-
# * If the subnets are part of a VPC that has an
|
3708
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
3357
3709
|
# attached to it, the DB instance is public.
|
3358
3710
|
# @return [Boolean]
|
3359
3711
|
#
|
@@ -3528,7 +3880,7 @@ module Aws::RDS
|
|
3528
3880
|
# @!attribute [rw] enable_iam_database_authentication
|
3529
3881
|
# A value that indicates whether to enable mapping of Amazon Web
|
3530
3882
|
# Services Identity and Access Management (IAM) accounts to database
|
3531
|
-
# accounts. By default, mapping
|
3883
|
+
# accounts. By default, mapping isn't enabled.
|
3532
3884
|
#
|
3533
3885
|
# This setting doesn't apply to RDS Custom or Amazon Aurora. In
|
3534
3886
|
# Aurora, mapping Amazon Web Services IAM accounts to database
|
@@ -3628,8 +3980,8 @@ module Aws::RDS
|
|
3628
3980
|
# @!attribute [rw] deletion_protection
|
3629
3981
|
# A value that indicates whether the DB instance has deletion
|
3630
3982
|
# protection enabled. The database can't be deleted when deletion
|
3631
|
-
# protection is enabled. By default, deletion protection
|
3632
|
-
# For more information, see [ Deleting a DB Instance][1].
|
3983
|
+
# protection is enabled. By default, deletion protection isn't
|
3984
|
+
# enabled. For more information, see [ Deleting a DB Instance][1].
|
3633
3985
|
#
|
3634
3986
|
# **Amazon Aurora**
|
3635
3987
|
#
|
@@ -3853,7 +4205,7 @@ module Aws::RDS
|
|
3853
4205
|
# Guide*.
|
3854
4206
|
#
|
3855
4207
|
# * Can specify a PostgreSQL DB instance only if the source is running
|
3856
|
-
# PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-
|
4208
|
+
# PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region
|
3857
4209
|
# replication).
|
3858
4210
|
#
|
3859
4211
|
# * The specified DB instance must have automatic backups enabled,
|
@@ -3877,11 +4229,11 @@ module Aws::RDS
|
|
3877
4229
|
# @return [String]
|
3878
4230
|
#
|
3879
4231
|
# @!attribute [rw] db_instance_class
|
3880
|
-
# The compute and memory capacity of the read replica, for example
|
3881
|
-
#
|
3882
|
-
#
|
3883
|
-
#
|
3884
|
-
#
|
4232
|
+
# The compute and memory capacity of the read replica, for example
|
4233
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
4234
|
+
# Web Services Regions, or for all database engines. For the full list
|
4235
|
+
# of DB instance classes, and availability for your engine, see [DB
|
4236
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
3885
4237
|
#
|
3886
4238
|
# Default: Inherits from the source DB instance.
|
3887
4239
|
#
|
@@ -3952,8 +4304,8 @@ module Aws::RDS
|
|
3952
4304
|
#
|
3953
4305
|
# If you do not specify a value for `DBParameterGroupName`, then
|
3954
4306
|
# Amazon RDS uses the `DBParameterGroup` of source DB instance for a
|
3955
|
-
# same
|
3956
|
-
# specified DB engine for a cross
|
4307
|
+
# same Region read replica, or the default `DBParameterGroup` for the
|
4308
|
+
# specified DB engine for a cross-Region read replica.
|
3957
4309
|
#
|
3958
4310
|
# Specifying a parameter group for this operation is only supported
|
3959
4311
|
# for Oracle DB instances. It isn't supported for RDS Custom.
|
@@ -3971,12 +4323,13 @@ module Aws::RDS
|
|
3971
4323
|
# A value that indicates whether the DB instance is publicly
|
3972
4324
|
# accessible.
|
3973
4325
|
#
|
3974
|
-
# When the DB
|
3975
|
-
# resolves to the private IP address from within the DB
|
3976
|
-
#
|
3977
|
-
#
|
3978
|
-
#
|
3979
|
-
# the security group assigned to the
|
4326
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
4327
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
4328
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
4329
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
4330
|
+
# cluster is ultimately controlled by the security group it uses. That
|
4331
|
+
# public access isn't permitted if the security group assigned to the
|
4332
|
+
# DB cluster doesn't permit it.
|
3980
4333
|
#
|
3981
4334
|
# When the DB instance isn't publicly accessible, it is an internal
|
3982
4335
|
# DB instance with a DNS name that resolves to a private IP address.
|
@@ -4165,7 +4518,7 @@ module Aws::RDS
|
|
4165
4518
|
# Region.
|
4166
4519
|
#
|
4167
4520
|
# `SourceRegion` isn't supported for SQL Server, because SQL Server
|
4168
|
-
# on Amazon RDS doesn't support cross-
|
4521
|
+
# on Amazon RDS doesn't support cross-Region read replicas.
|
4169
4522
|
#
|
4170
4523
|
# </note>
|
4171
4524
|
#
|
@@ -4180,7 +4533,7 @@ module Aws::RDS
|
|
4180
4533
|
# @!attribute [rw] enable_iam_database_authentication
|
4181
4534
|
# A value that indicates whether to enable mapping of Amazon Web
|
4182
4535
|
# Services Identity and Access Management (IAM) accounts to database
|
4183
|
-
# accounts. By default, mapping
|
4536
|
+
# accounts. By default, mapping isn't enabled.
|
4184
4537
|
#
|
4185
4538
|
# For more information about IAM database authentication, see [ IAM
|
4186
4539
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -4260,8 +4613,8 @@ module Aws::RDS
|
|
4260
4613
|
# @!attribute [rw] deletion_protection
|
4261
4614
|
# A value that indicates whether the DB instance has deletion
|
4262
4615
|
# protection enabled. The database can't be deleted when deletion
|
4263
|
-
# protection is enabled. By default, deletion protection
|
4264
|
-
# For more information, see [ Deleting a DB Instance][1].
|
4616
|
+
# protection is enabled. By default, deletion protection isn't
|
4617
|
+
# enabled. For more information, see [ Deleting a DB Instance][1].
|
4265
4618
|
#
|
4266
4619
|
#
|
4267
4620
|
#
|
@@ -4404,8 +4757,13 @@ module Aws::RDS
|
|
4404
4757
|
# @!attribute [rw] db_instance
|
4405
4758
|
# Contains the details of an Amazon RDS DB instance.
|
4406
4759
|
#
|
4407
|
-
# This data type is used as a response element in the
|
4408
|
-
# `
|
4760
|
+
# This data type is used as a response element in the operations
|
4761
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
4762
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
4763
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
4764
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
4765
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
4766
|
+
# `StopDBInstance`.
|
4409
4767
|
# @return [Types::DBInstance]
|
4410
4768
|
#
|
4411
4769
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplicaResult AWS API Documentation
|
@@ -4419,8 +4777,13 @@ module Aws::RDS
|
|
4419
4777
|
# @!attribute [rw] db_instance
|
4420
4778
|
# Contains the details of an Amazon RDS DB instance.
|
4421
4779
|
#
|
4422
|
-
# This data type is used as a response element in the
|
4423
|
-
# `
|
4780
|
+
# This data type is used as a response element in the operations
|
4781
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
4782
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
4783
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
4784
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
4785
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
4786
|
+
# `StopDBInstance`.
|
4424
4787
|
# @return [Types::DBInstance]
|
4425
4788
|
#
|
4426
4789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceResult AWS API Documentation
|
@@ -5341,10 +5704,38 @@ module Aws::RDS
|
|
5341
5704
|
#
|
5342
5705
|
class CustomDBEngineVersionQuotaExceededFault < Aws::EmptyStructure; end
|
5343
5706
|
|
5344
|
-
# Contains the details of an Amazon Aurora DB cluster
|
5707
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
5708
|
+
# cluster.
|
5345
5709
|
#
|
5346
|
-
#
|
5347
|
-
# `
|
5710
|
+
# For an Amazon Aurora DB cluster, this data type is used as a response
|
5711
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
5712
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
5713
|
+
# `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`,
|
5714
|
+
# `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`,
|
5715
|
+
# `StartDBCluster`, and `StopDBCluster`.
|
5716
|
+
#
|
5717
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
5718
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
5719
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
5720
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
5721
|
+
# `RestoreDBClusterToPointInTime`.
|
5722
|
+
#
|
5723
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
5724
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
5725
|
+
#
|
5726
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
5727
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
5728
|
+
# RDS User Guide.*
|
5729
|
+
#
|
5730
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
5731
|
+
# change.
|
5732
|
+
#
|
5733
|
+
# </note>
|
5734
|
+
#
|
5735
|
+
#
|
5736
|
+
#
|
5737
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
5738
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
5348
5739
|
#
|
5349
5740
|
# @!attribute [rw] allocated_storage
|
5350
5741
|
# For all database engines except Amazon Aurora, `AllocatedStorage`
|
@@ -5697,6 +6088,89 @@ module Aws::RDS
|
|
5697
6088
|
# changes are identified by subelements.
|
5698
6089
|
# @return [Types::ClusterPendingModifiedValues]
|
5699
6090
|
#
|
6091
|
+
# @!attribute [rw] db_cluster_instance_class
|
6092
|
+
# The name of the compute and memory capacity class of the DB
|
6093
|
+
# instance.
|
6094
|
+
#
|
6095
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6096
|
+
# @return [String]
|
6097
|
+
#
|
6098
|
+
# @!attribute [rw] storage_type
|
6099
|
+
# The storage type associated with DB instance.
|
6100
|
+
#
|
6101
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6102
|
+
# @return [String]
|
6103
|
+
#
|
6104
|
+
# @!attribute [rw] iops
|
6105
|
+
# The Provisioned IOPS (I/O operations per second) value.
|
6106
|
+
#
|
6107
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6108
|
+
# @return [Integer]
|
6109
|
+
#
|
6110
|
+
# @!attribute [rw] publicly_accessible
|
6111
|
+
# Specifies the accessibility options for the DB instance.
|
6112
|
+
#
|
6113
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
6114
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
6115
|
+
# instance's virtual private cloud (VPC). It resolves to the public
|
6116
|
+
# IP address from outside of the DB instance's VPC. Access to the DB
|
6117
|
+
# instance is ultimately controlled by the security group it uses.
|
6118
|
+
# That public access is not permitted if the security group assigned
|
6119
|
+
# to the DB instance doesn't permit it.
|
6120
|
+
#
|
6121
|
+
# When the DB instance isn't publicly accessible, it is an internal
|
6122
|
+
# DB instance with a DNS name that resolves to a private IP address.
|
6123
|
+
#
|
6124
|
+
# For more information, see CreateDBInstance.
|
6125
|
+
#
|
6126
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6127
|
+
# @return [Boolean]
|
6128
|
+
#
|
6129
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
6130
|
+
# A value that indicates that minor version patches are applied
|
6131
|
+
# automatically.
|
6132
|
+
#
|
6133
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6134
|
+
# @return [Boolean]
|
6135
|
+
#
|
6136
|
+
# @!attribute [rw] monitoring_interval
|
6137
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
6138
|
+
# metrics are collected for the DB cluster.
|
6139
|
+
#
|
6140
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6141
|
+
# @return [Integer]
|
6142
|
+
#
|
6143
|
+
# @!attribute [rw] monitoring_role_arn
|
6144
|
+
# The ARN for the IAM role that permits RDS to send Enhanced
|
6145
|
+
# Monitoring metrics to Amazon CloudWatch Logs.
|
6146
|
+
#
|
6147
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6148
|
+
# @return [String]
|
6149
|
+
#
|
6150
|
+
# @!attribute [rw] performance_insights_enabled
|
6151
|
+
# True if Performance Insights is enabled for the DB cluster, and
|
6152
|
+
# otherwise false.
|
6153
|
+
#
|
6154
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6155
|
+
# @return [Boolean]
|
6156
|
+
#
|
6157
|
+
# @!attribute [rw] performance_insights_kms_key_id
|
6158
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
6159
|
+
# Performance Insights data.
|
6160
|
+
#
|
6161
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
6162
|
+
# alias ARN, or alias name for the KMS key.
|
6163
|
+
#
|
6164
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6165
|
+
# @return [String]
|
6166
|
+
#
|
6167
|
+
# @!attribute [rw] performance_insights_retention_period
|
6168
|
+
# The amount of time, in days, to retain Performance Insights data.
|
6169
|
+
# Valid values are 7 or 731 (2 years).
|
6170
|
+
#
|
6171
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
6172
|
+
# @return [Integer]
|
6173
|
+
#
|
5700
6174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBCluster AWS API Documentation
|
5701
6175
|
#
|
5702
6176
|
class DBCluster < Struct.new(
|
@@ -5756,7 +6230,17 @@ module Aws::RDS
|
|
5756
6230
|
:tag_list,
|
5757
6231
|
:global_write_forwarding_status,
|
5758
6232
|
:global_write_forwarding_requested,
|
5759
|
-
:pending_modified_values
|
6233
|
+
:pending_modified_values,
|
6234
|
+
:db_cluster_instance_class,
|
6235
|
+
:storage_type,
|
6236
|
+
:iops,
|
6237
|
+
:publicly_accessible,
|
6238
|
+
:auto_minor_version_upgrade,
|
6239
|
+
:monitoring_interval,
|
6240
|
+
:monitoring_role_arn,
|
6241
|
+
:performance_insights_enabled,
|
6242
|
+
:performance_insights_kms_key_id,
|
6243
|
+
:performance_insights_retention_period)
|
5760
6244
|
SENSITIVE = []
|
5761
6245
|
include Aws::Structure
|
5762
6246
|
end
|
@@ -6709,8 +7193,12 @@ module Aws::RDS
|
|
6709
7193
|
|
6710
7194
|
# Contains the details of an Amazon RDS DB instance.
|
6711
7195
|
#
|
6712
|
-
# This data type is used as a response element in the
|
6713
|
-
# `
|
7196
|
+
# This data type is used as a response element in the operations
|
7197
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`,
|
7198
|
+
# `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`,
|
7199
|
+
# `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`,
|
7200
|
+
# `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`,
|
7201
|
+
# `StartDBInstance`, and `StopDBInstance`.
|
6714
7202
|
#
|
6715
7203
|
# @!attribute [rw] db_instance_identifier
|
6716
7204
|
# Contains a user-supplied database identifier. This identifier is the
|
@@ -6862,10 +7350,10 @@ module Aws::RDS
|
|
6862
7350
|
# @!attribute [rw] read_replica_db_cluster_identifiers
|
6863
7351
|
# Contains one or more identifiers of Aurora DB clusters to which the
|
6864
7352
|
# RDS DB instance is replicated as a read replica. For example, when
|
6865
|
-
# you create an Aurora read replica of an RDS MySQL DB instance,
|
6866
|
-
# Aurora MySQL DB cluster for the Aurora read replica is shown.
|
6867
|
-
# output
|
6868
|
-
# replicas.
|
7353
|
+
# you create an Aurora read replica of an RDS for MySQL DB instance,
|
7354
|
+
# the Aurora MySQL DB cluster for the Aurora read replica is shown.
|
7355
|
+
# This output doesn't contain information about cross-Region Aurora
|
7356
|
+
# read replicas.
|
6869
7357
|
#
|
6870
7358
|
# <note markdown="1"> Currently, each RDS DB instance can have only one Aurora read
|
6871
7359
|
# replica.
|
@@ -6919,12 +7407,13 @@ module Aws::RDS
|
|
6919
7407
|
# @!attribute [rw] publicly_accessible
|
6920
7408
|
# Specifies the accessibility options for the DB instance.
|
6921
7409
|
#
|
6922
|
-
# When the DB
|
6923
|
-
# resolves to the private IP address from within the DB
|
6924
|
-
#
|
6925
|
-
#
|
6926
|
-
#
|
6927
|
-
# the security group assigned to the
|
7410
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
7411
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
7412
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
7413
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
7414
|
+
# cluster is ultimately controlled by the security group it uses. That
|
7415
|
+
# public access isn't permitted if the security group assigned to the
|
7416
|
+
# DB cluster doesn't permit it.
|
6928
7417
|
#
|
6929
7418
|
# When the DB instance isn't publicly accessible, it is an internal
|
6930
7419
|
# DB instance with a DNS name that resolves to a private IP address.
|
@@ -8897,10 +9386,39 @@ module Aws::RDS
|
|
8897
9386
|
end
|
8898
9387
|
|
8899
9388
|
# @!attribute [rw] db_cluster
|
8900
|
-
# Contains the details of an Amazon Aurora DB cluster
|
9389
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
9390
|
+
# cluster.
|
8901
9391
|
#
|
8902
|
-
#
|
8903
|
-
#
|
9392
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
9393
|
+
# response element in the operations `CreateDBCluster`,
|
9394
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
9395
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
9396
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
9397
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
9398
|
+
# `StopDBCluster`.
|
9399
|
+
#
|
9400
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
9401
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
9402
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
9403
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
9404
|
+
# `RestoreDBClusterToPointInTime`.
|
9405
|
+
#
|
9406
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
9407
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
9408
|
+
#
|
9409
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
9410
|
+
# deployments with two readable standby DB instances][2] in the
|
9411
|
+
# *Amazon RDS User Guide.*
|
9412
|
+
#
|
9413
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
9414
|
+
# change.
|
9415
|
+
#
|
9416
|
+
# </note>
|
9417
|
+
#
|
9418
|
+
#
|
9419
|
+
#
|
9420
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
9421
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
8904
9422
|
# @return [Types::DBCluster]
|
8905
9423
|
#
|
8906
9424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterResult AWS API Documentation
|
@@ -9081,8 +9599,13 @@ module Aws::RDS
|
|
9081
9599
|
# @!attribute [rw] db_instance
|
9082
9600
|
# Contains the details of an Amazon RDS DB instance.
|
9083
9601
|
#
|
9084
|
-
# This data type is used as a response element in the
|
9085
|
-
# `
|
9602
|
+
# This data type is used as a response element in the operations
|
9603
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
9604
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
9605
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
9606
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
9607
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
9608
|
+
# `StopDBInstance`.
|
9086
9609
|
# @return [Types::DBInstance]
|
9087
9610
|
#
|
9088
9611
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceResult AWS API Documentation
|
@@ -13145,10 +13668,14 @@ module Aws::RDS
|
|
13145
13668
|
# @return [String]
|
13146
13669
|
#
|
13147
13670
|
# @!attribute [rw] target_db_instance_identifier
|
13148
|
-
# The name of the instance to promote to the primary instance.
|
13671
|
+
# The name of the DB instance to promote to the primary DB instance.
|
13672
|
+
#
|
13673
|
+
# Specify the DB instance identifier for an Aurora Replica or a
|
13674
|
+
# Multi-AZ readable standby in the DB cluster, for example
|
13675
|
+
# `mydbcluster-replica1`.
|
13149
13676
|
#
|
13150
|
-
#
|
13151
|
-
#
|
13677
|
+
# This setting isn't supported for RDS for MySQL Multi-AZ DB
|
13678
|
+
# clusters.
|
13152
13679
|
# @return [String]
|
13153
13680
|
#
|
13154
13681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBClusterMessage AWS API Documentation
|
@@ -13161,10 +13688,39 @@ module Aws::RDS
|
|
13161
13688
|
end
|
13162
13689
|
|
13163
13690
|
# @!attribute [rw] db_cluster
|
13164
|
-
# Contains the details of an Amazon Aurora DB cluster
|
13691
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
13692
|
+
# cluster.
|
13165
13693
|
#
|
13166
|
-
#
|
13167
|
-
#
|
13694
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
13695
|
+
# response element in the operations `CreateDBCluster`,
|
13696
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
13697
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
13698
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
13699
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
13700
|
+
# `StopDBCluster`.
|
13701
|
+
#
|
13702
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
13703
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
13704
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
13705
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
13706
|
+
# `RestoreDBClusterToPointInTime`.
|
13707
|
+
#
|
13708
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
13709
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
13710
|
+
#
|
13711
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
13712
|
+
# deployments with two readable standby DB instances][2] in the
|
13713
|
+
# *Amazon RDS User Guide.*
|
13714
|
+
#
|
13715
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
13716
|
+
# change.
|
13717
|
+
#
|
13718
|
+
# </note>
|
13719
|
+
#
|
13720
|
+
#
|
13721
|
+
#
|
13722
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
13723
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
13168
13724
|
# @return [Types::DBCluster]
|
13169
13725
|
#
|
13170
13726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBClusterResult AWS API Documentation
|
@@ -14200,6 +14756,16 @@ module Aws::RDS
|
|
14200
14756
|
# enable_http_endpoint: false,
|
14201
14757
|
# copy_tags_to_snapshot: false,
|
14202
14758
|
# enable_global_write_forwarding: false,
|
14759
|
+
# db_cluster_instance_class: "String",
|
14760
|
+
# allocated_storage: 1,
|
14761
|
+
# storage_type: "String",
|
14762
|
+
# iops: 1,
|
14763
|
+
# auto_minor_version_upgrade: false,
|
14764
|
+
# monitoring_interval: 1,
|
14765
|
+
# monitoring_role_arn: "String",
|
14766
|
+
# enable_performance_insights: false,
|
14767
|
+
# performance_insights_kms_key_id: "String",
|
14768
|
+
# performance_insights_retention_period: 1,
|
14203
14769
|
# }
|
14204
14770
|
#
|
14205
14771
|
# @!attribute [rw] db_cluster_identifier
|
@@ -14208,6 +14774,8 @@ module Aws::RDS
|
|
14208
14774
|
#
|
14209
14775
|
# Constraints: This identifier must match the identifier of an
|
14210
14776
|
# existing DB cluster.
|
14777
|
+
#
|
14778
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14211
14779
|
# @return [String]
|
14212
14780
|
#
|
14213
14781
|
# @!attribute [rw] new_db_cluster_identifier
|
@@ -14223,6 +14791,8 @@ module Aws::RDS
|
|
14223
14791
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
14224
14792
|
#
|
14225
14793
|
# Example: `my-cluster2`
|
14794
|
+
#
|
14795
|
+
# Valid for: Aurora DB clusters only
|
14226
14796
|
# @return [String]
|
14227
14797
|
#
|
14228
14798
|
# @!attribute [rw] apply_immediately
|
@@ -14242,11 +14812,13 @@ module Aws::RDS
|
|
14242
14812
|
# `ApplyImmediately` parameter.
|
14243
14813
|
#
|
14244
14814
|
# By default, this parameter is disabled.
|
14815
|
+
#
|
14816
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14245
14817
|
# @return [Boolean]
|
14246
14818
|
#
|
14247
14819
|
# @!attribute [rw] backup_retention_period
|
14248
|
-
# The number of days for which automated backups are retained.
|
14249
|
-
#
|
14820
|
+
# The number of days for which automated backups are retained. Specify
|
14821
|
+
# a minimum value of 1.
|
14250
14822
|
#
|
14251
14823
|
# Default: 1
|
14252
14824
|
#
|
@@ -14255,15 +14827,21 @@ module Aws::RDS
|
|
14255
14827
|
# * Must be a value from 1 to 35
|
14256
14828
|
#
|
14257
14829
|
# ^
|
14830
|
+
#
|
14831
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14258
14832
|
# @return [Integer]
|
14259
14833
|
#
|
14260
14834
|
# @!attribute [rw] db_cluster_parameter_group_name
|
14261
14835
|
# The name of the DB cluster parameter group to use for the DB
|
14262
14836
|
# cluster.
|
14837
|
+
#
|
14838
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14263
14839
|
# @return [String]
|
14264
14840
|
#
|
14265
14841
|
# @!attribute [rw] vpc_security_group_ids
|
14266
14842
|
# A list of VPC security groups that the DB cluster will belong to.
|
14843
|
+
#
|
14844
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14267
14845
|
# @return [Array<String>]
|
14268
14846
|
#
|
14269
14847
|
# @!attribute [rw] port
|
@@ -14272,6 +14850,8 @@ module Aws::RDS
|
|
14272
14850
|
# Constraints: Value must be `1150-65535`
|
14273
14851
|
#
|
14274
14852
|
# Default: The same port as the original DB cluster.
|
14853
|
+
#
|
14854
|
+
# Valid for: Aurora DB clusters only
|
14275
14855
|
# @return [Integer]
|
14276
14856
|
#
|
14277
14857
|
# @!attribute [rw] master_user_password
|
@@ -14280,21 +14860,16 @@ module Aws::RDS
|
|
14280
14860
|
# "@".
|
14281
14861
|
#
|
14282
14862
|
# Constraints: Must contain from 8 to 41 characters.
|
14863
|
+
#
|
14864
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14283
14865
|
# @return [String]
|
14284
14866
|
#
|
14285
14867
|
# @!attribute [rw] option_group_name
|
14286
14868
|
# A value that indicates that the DB cluster should be associated with
|
14287
|
-
# the specified option group.
|
14288
|
-
#
|
14289
|
-
#
|
14290
|
-
#
|
14291
|
-
# option group that enables OEM, this change can cause a brief
|
14292
|
-
# (sub-second) period during which new connections are rejected but
|
14293
|
-
# existing connections are not interrupted.
|
14294
|
-
#
|
14295
|
-
# Permanent options can't be removed from an option group. The option
|
14296
|
-
# group can't be removed from a DB cluster once it is associated with
|
14297
|
-
# a DB cluster.
|
14869
|
+
# the specified option group.
|
14870
|
+
#
|
14871
|
+
# DB clusters are associated with a default option group that can't
|
14872
|
+
# be modified.
|
14298
14873
|
# @return [String]
|
14299
14874
|
#
|
14300
14875
|
# @!attribute [rw] preferred_backup_window
|
@@ -14317,6 +14892,8 @@ module Aws::RDS
|
|
14317
14892
|
#
|
14318
14893
|
# * Must be at least 30 minutes.
|
14319
14894
|
#
|
14895
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14896
|
+
#
|
14320
14897
|
#
|
14321
14898
|
#
|
14322
14899
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -14338,6 +14915,8 @@ module Aws::RDS
|
|
14338
14915
|
#
|
14339
14916
|
# Constraints: Minimum 30-minute window.
|
14340
14917
|
#
|
14918
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14919
|
+
#
|
14341
14920
|
#
|
14342
14921
|
#
|
14343
14922
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
@@ -14346,11 +14925,13 @@ module Aws::RDS
|
|
14346
14925
|
# @!attribute [rw] enable_iam_database_authentication
|
14347
14926
|
# A value that indicates whether to enable mapping of Amazon Web
|
14348
14927
|
# Services Identity and Access Management (IAM) accounts to database
|
14349
|
-
# accounts. By default, mapping
|
14928
|
+
# accounts. By default, mapping isn't enabled.
|
14350
14929
|
#
|
14351
14930
|
# For more information, see [ IAM Database Authentication][1] in the
|
14352
14931
|
# *Amazon Aurora User Guide.*
|
14353
14932
|
#
|
14933
|
+
# Valid for: Aurora DB clusters only
|
14934
|
+
#
|
14354
14935
|
#
|
14355
14936
|
#
|
14356
14937
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -14360,10 +14941,6 @@ module Aws::RDS
|
|
14360
14941
|
# The target backtrack window, in seconds. To disable backtracking,
|
14361
14942
|
# set this value to 0.
|
14362
14943
|
#
|
14363
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
14364
|
-
#
|
14365
|
-
# </note>
|
14366
|
-
#
|
14367
14944
|
# Default: 0
|
14368
14945
|
#
|
14369
14946
|
# Constraints:
|
@@ -14372,11 +14949,15 @@ module Aws::RDS
|
|
14372
14949
|
# (72 hours).
|
14373
14950
|
#
|
14374
14951
|
# ^
|
14952
|
+
#
|
14953
|
+
# Valid for: Aurora MySQL DB clusters only
|
14375
14954
|
# @return [Integer]
|
14376
14955
|
#
|
14377
14956
|
# @!attribute [rw] cloudwatch_logs_export_configuration
|
14378
14957
|
# The configuration setting for the log types to be enabled for export
|
14379
14958
|
# to CloudWatch Logs for a specific DB cluster.
|
14959
|
+
#
|
14960
|
+
# Valid for: Aurora DB clusters only
|
14380
14961
|
# @return [Types::CloudwatchLogsExportConfiguration]
|
14381
14962
|
#
|
14382
14963
|
# @!attribute [rw] engine_version
|
@@ -14385,23 +14966,37 @@ module Aws::RDS
|
|
14385
14966
|
# applied during the next maintenance window unless `ApplyImmediately`
|
14386
14967
|
# is enabled.
|
14387
14968
|
#
|
14388
|
-
# To list all of the available engine versions for
|
14389
|
-
# 5.6-compatible Aurora
|
14969
|
+
# To list all of the available engine versions for MySQL
|
14970
|
+
# 5.6-compatible Aurora, use the following command:
|
14390
14971
|
#
|
14391
14972
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
14392
14973
|
# "DBEngineVersions[].EngineVersion"`
|
14393
14974
|
#
|
14394
|
-
# To list all of the available engine versions for
|
14395
|
-
#
|
14975
|
+
# To list all of the available engine versions for MySQL
|
14976
|
+
# 5.7-compatible Aurora, use the following command:
|
14396
14977
|
#
|
14397
14978
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
14398
14979
|
# "DBEngineVersions[].EngineVersion"`
|
14399
14980
|
#
|
14400
|
-
# To list all of the available engine versions for
|
14401
|
-
#
|
14981
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
14982
|
+
# use the following command:
|
14402
14983
|
#
|
14403
14984
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
14404
14985
|
# --query "DBEngineVersions[].EngineVersion"`
|
14986
|
+
#
|
14987
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
14988
|
+
# the following command:
|
14989
|
+
#
|
14990
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
14991
|
+
# "DBEngineVersions[].EngineVersion"`
|
14992
|
+
#
|
14993
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
14994
|
+
# use the following command:
|
14995
|
+
#
|
14996
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
14997
|
+
# "DBEngineVersions[].EngineVersion"`
|
14998
|
+
#
|
14999
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14405
15000
|
# @return [String]
|
14406
15001
|
#
|
14407
15002
|
# @!attribute [rw] allow_major_version_upgrade
|
@@ -14410,6 +15005,8 @@ module Aws::RDS
|
|
14410
15005
|
# Constraints: You must allow major version upgrades when specifying a
|
14411
15006
|
# value for the `EngineVersion` parameter that is a different major
|
14412
15007
|
# version than the DB cluster's current version.
|
15008
|
+
#
|
15009
|
+
# Valid for: Aurora DB clusters only
|
14413
15010
|
# @return [Boolean]
|
14414
15011
|
#
|
14415
15012
|
# @!attribute [rw] db_instance_parameter_group_name
|
@@ -14433,6 +15030,8 @@ module Aws::RDS
|
|
14433
15030
|
#
|
14434
15031
|
# * The `DBInstanceParameterGroupName` parameter is only valid in
|
14435
15032
|
# combination with the `AllowMajorVersionUpgrade` parameter.
|
15033
|
+
#
|
15034
|
+
# Valid for: Aurora DB clusters only
|
14436
15035
|
# @return [String]
|
14437
15036
|
#
|
14438
15037
|
# @!attribute [rw] domain
|
@@ -14443,6 +15042,8 @@ module Aws::RDS
|
|
14443
15042
|
# For more information, see [Kerberos Authentication][1] in the
|
14444
15043
|
# *Amazon Aurora User Guide*.
|
14445
15044
|
#
|
15045
|
+
# Valid for: Aurora DB clusters only
|
15046
|
+
#
|
14446
15047
|
#
|
14447
15048
|
#
|
14448
15049
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
@@ -14451,17 +15052,24 @@ module Aws::RDS
|
|
14451
15052
|
# @!attribute [rw] domain_iam_role_name
|
14452
15053
|
# Specify the name of the IAM role to be used when making API calls to
|
14453
15054
|
# the Directory Service.
|
15055
|
+
#
|
15056
|
+
# Valid for: Aurora DB clusters only
|
14454
15057
|
# @return [String]
|
14455
15058
|
#
|
14456
15059
|
# @!attribute [rw] scaling_configuration
|
14457
15060
|
# The scaling properties of the DB cluster. You can only modify
|
14458
15061
|
# scaling properties for DB clusters in `serverless` DB engine mode.
|
15062
|
+
#
|
15063
|
+
# Valid for: Aurora DB clusters only
|
14459
15064
|
# @return [Types::ScalingConfiguration]
|
14460
15065
|
#
|
14461
15066
|
# @!attribute [rw] deletion_protection
|
14462
15067
|
# A value that indicates whether the DB cluster has deletion
|
14463
15068
|
# protection enabled. The database can't be deleted when deletion
|
14464
|
-
# protection is enabled. By default, deletion protection
|
15069
|
+
# protection is enabled. By default, deletion protection isn't
|
15070
|
+
# enabled.
|
15071
|
+
#
|
15072
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14465
15073
|
# @return [Boolean]
|
14466
15074
|
#
|
14467
15075
|
# @!attribute [rw] enable_http_endpoint
|
@@ -14477,6 +15085,8 @@ module Aws::RDS
|
|
14477
15085
|
# For more information, see [Using the Data API for Aurora
|
14478
15086
|
# Serverless][1] in the *Amazon Aurora User Guide*.
|
14479
15087
|
#
|
15088
|
+
# Valid for: Aurora DB clusters only
|
15089
|
+
#
|
14480
15090
|
#
|
14481
15091
|
#
|
14482
15092
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
@@ -14485,6 +15095,8 @@ module Aws::RDS
|
|
14485
15095
|
# @!attribute [rw] copy_tags_to_snapshot
|
14486
15096
|
# A value that indicates whether to copy all tags from the DB cluster
|
14487
15097
|
# to snapshots of the DB cluster. The default is not to copy them.
|
15098
|
+
#
|
15099
|
+
# Valid for: Aurora DB clusters only
|
14488
15100
|
# @return [Boolean]
|
14489
15101
|
#
|
14490
15102
|
# @!attribute [rw] enable_global_write_forwarding
|
@@ -14501,8 +15113,142 @@ module Aws::RDS
|
|
14501
15113
|
# the primary DB cluster of an Aurora global database, this value is
|
14502
15114
|
# used immediately if the primary is demoted by the
|
14503
15115
|
# FailoverGlobalCluster API operation, but it does nothing until then.
|
15116
|
+
#
|
15117
|
+
# Valid for: Aurora DB clusters only
|
15118
|
+
# @return [Boolean]
|
15119
|
+
#
|
15120
|
+
# @!attribute [rw] db_cluster_instance_class
|
15121
|
+
# The compute and memory capacity of each DB instance in the Multi-AZ
|
15122
|
+
# DB cluster, for example db.m6g.xlarge. Not all DB instance classes
|
15123
|
+
# are available in all Amazon Web Services Regions, or for all
|
15124
|
+
# database engines.
|
15125
|
+
#
|
15126
|
+
# For the full list of DB instance classes and availability for your
|
15127
|
+
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
15128
|
+
#
|
15129
|
+
# Valid for: Multi-AZ DB clusters only
|
15130
|
+
#
|
15131
|
+
#
|
15132
|
+
#
|
15133
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
15134
|
+
# @return [String]
|
15135
|
+
#
|
15136
|
+
# @!attribute [rw] allocated_storage
|
15137
|
+
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
15138
|
+
# instance in the Multi-AZ DB cluster.
|
15139
|
+
#
|
15140
|
+
# Type: Integer
|
15141
|
+
#
|
15142
|
+
# Valid for: Multi-AZ DB clusters only
|
15143
|
+
# @return [Integer]
|
15144
|
+
#
|
15145
|
+
# @!attribute [rw] storage_type
|
15146
|
+
# Specifies the storage type to be associated with the DB cluster.
|
15147
|
+
#
|
15148
|
+
# Valid values: `standard | gp2 | io1`
|
15149
|
+
#
|
15150
|
+
# If you specify `io1`, you must also include a value for the `Iops`
|
15151
|
+
# parameter.
|
15152
|
+
#
|
15153
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
15154
|
+
#
|
15155
|
+
# Valid for: Multi-AZ DB clusters only
|
15156
|
+
# @return [String]
|
15157
|
+
#
|
15158
|
+
# @!attribute [rw] iops
|
15159
|
+
# The amount of Provisioned IOPS (input/output operations per second)
|
15160
|
+
# to be initially allocated for each DB instance in the Multi-AZ DB
|
15161
|
+
# cluster.
|
15162
|
+
#
|
15163
|
+
# For information about valid Iops values, see [Amazon RDS Provisioned
|
15164
|
+
# IOPS Storage to Improve Performance][1] in the *Amazon RDS User
|
15165
|
+
# Guide*.
|
15166
|
+
#
|
15167
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
15168
|
+
# amount for the DB cluster.
|
15169
|
+
#
|
15170
|
+
# Valid for: Multi-AZ DB clusters only
|
15171
|
+
#
|
15172
|
+
#
|
15173
|
+
#
|
15174
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
15175
|
+
# @return [Integer]
|
15176
|
+
#
|
15177
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
15178
|
+
# A value that indicates whether minor engine upgrades are applied
|
15179
|
+
# automatically to the DB cluster during the maintenance window. By
|
15180
|
+
# default, minor engine upgrades are applied automatically.
|
15181
|
+
#
|
15182
|
+
# Valid for: Multi-AZ DB clusters only
|
15183
|
+
# @return [Boolean]
|
15184
|
+
#
|
15185
|
+
# @!attribute [rw] monitoring_interval
|
15186
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
15187
|
+
# metrics are collected for the DB cluster. To turn off collecting
|
15188
|
+
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
15189
|
+
#
|
15190
|
+
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval`
|
15191
|
+
# to a value other than 0.
|
15192
|
+
#
|
15193
|
+
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
15194
|
+
#
|
15195
|
+
# Valid for: Multi-AZ DB clusters only
|
15196
|
+
# @return [Integer]
|
15197
|
+
#
|
15198
|
+
# @!attribute [rw] monitoring_role_arn
|
15199
|
+
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
15200
|
+
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An
|
15201
|
+
# example is `arn:aws:iam:123456789012:role/emaccess`. For information
|
15202
|
+
# on creating a monitoring role, see [To create an IAM role for Amazon
|
15203
|
+
# RDS Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
15204
|
+
#
|
15205
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
15206
|
+
# `MonitoringRoleArn` value.
|
15207
|
+
#
|
15208
|
+
# Valid for: Multi-AZ DB clusters only
|
15209
|
+
#
|
15210
|
+
#
|
15211
|
+
#
|
15212
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
15213
|
+
# @return [String]
|
15214
|
+
#
|
15215
|
+
# @!attribute [rw] enable_performance_insights
|
15216
|
+
# A value that indicates whether to turn on Performance Insights for
|
15217
|
+
# the DB cluster.
|
15218
|
+
#
|
15219
|
+
# For more information, see [ Using Amazon Performance Insights][1] in
|
15220
|
+
# the *Amazon RDS User Guide*.
|
15221
|
+
#
|
15222
|
+
# Valid for: Multi-AZ DB clusters only
|
15223
|
+
#
|
15224
|
+
#
|
15225
|
+
#
|
15226
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
14504
15227
|
# @return [Boolean]
|
14505
15228
|
#
|
15229
|
+
# @!attribute [rw] performance_insights_kms_key_id
|
15230
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
15231
|
+
# Performance Insights data.
|
15232
|
+
#
|
15233
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
15234
|
+
# alias ARN, or alias name for the KMS key.
|
15235
|
+
#
|
15236
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`,
|
15237
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
15238
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
15239
|
+
# account has a different default KMS key for each Amazon Web Services
|
15240
|
+
# Region.
|
15241
|
+
#
|
15242
|
+
# Valid for: Multi-AZ DB clusters only
|
15243
|
+
# @return [String]
|
15244
|
+
#
|
15245
|
+
# @!attribute [rw] performance_insights_retention_period
|
15246
|
+
# The amount of time, in days, to retain Performance Insights data.
|
15247
|
+
# Valid values are 7 or 731 (2 years).
|
15248
|
+
#
|
15249
|
+
# Valid for: Multi-AZ DB clusters only
|
15250
|
+
# @return [Integer]
|
15251
|
+
#
|
14506
15252
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterMessage AWS API Documentation
|
14507
15253
|
#
|
14508
15254
|
class ModifyDBClusterMessage < Struct.new(
|
@@ -14529,7 +15275,17 @@ module Aws::RDS
|
|
14529
15275
|
:deletion_protection,
|
14530
15276
|
:enable_http_endpoint,
|
14531
15277
|
:copy_tags_to_snapshot,
|
14532
|
-
:enable_global_write_forwarding
|
15278
|
+
:enable_global_write_forwarding,
|
15279
|
+
:db_cluster_instance_class,
|
15280
|
+
:allocated_storage,
|
15281
|
+
:storage_type,
|
15282
|
+
:iops,
|
15283
|
+
:auto_minor_version_upgrade,
|
15284
|
+
:monitoring_interval,
|
15285
|
+
:monitoring_role_arn,
|
15286
|
+
:enable_performance_insights,
|
15287
|
+
:performance_insights_kms_key_id,
|
15288
|
+
:performance_insights_retention_period)
|
14533
15289
|
SENSITIVE = []
|
14534
15290
|
include Aws::Structure
|
14535
15291
|
end
|
@@ -14590,10 +15346,39 @@ module Aws::RDS
|
|
14590
15346
|
end
|
14591
15347
|
|
14592
15348
|
# @!attribute [rw] db_cluster
|
14593
|
-
# Contains the details of an Amazon Aurora DB cluster
|
15349
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
15350
|
+
# cluster.
|
14594
15351
|
#
|
14595
|
-
#
|
14596
|
-
#
|
15352
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
15353
|
+
# response element in the operations `CreateDBCluster`,
|
15354
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
15355
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
15356
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
15357
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
15358
|
+
# `StopDBCluster`.
|
15359
|
+
#
|
15360
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
15361
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
15362
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
15363
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
15364
|
+
# `RestoreDBClusterToPointInTime`.
|
15365
|
+
#
|
15366
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
15367
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
15368
|
+
#
|
15369
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
15370
|
+
# deployments with two readable standby DB instances][2] in the
|
15371
|
+
# *Amazon RDS User Guide.*
|
15372
|
+
#
|
15373
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
15374
|
+
# change.
|
15375
|
+
#
|
15376
|
+
# </note>
|
15377
|
+
#
|
15378
|
+
#
|
15379
|
+
#
|
15380
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
15381
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
14597
15382
|
# @return [Types::DBCluster]
|
14598
15383
|
#
|
14599
15384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterResult AWS API Documentation
|
@@ -14774,11 +15559,11 @@ module Aws::RDS
|
|
14774
15559
|
# @return [Integer]
|
14775
15560
|
#
|
14776
15561
|
# @!attribute [rw] db_instance_class
|
14777
|
-
# The new compute and memory capacity of the DB instance, for example
|
14778
|
-
#
|
14779
|
-
#
|
14780
|
-
#
|
14781
|
-
#
|
15562
|
+
# The new compute and memory capacity of the DB instance, for example
|
15563
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
15564
|
+
# Web Services Regions, or for all database engines. For the full list
|
15565
|
+
# of DB instance classes, and availability for your engine, see [DB
|
15566
|
+
# Instance Class][1] in the *Amazon RDS User Guide*.
|
14782
15567
|
#
|
14783
15568
|
# If you modify the DB instance class, an outage occurs during the
|
14784
15569
|
# change. The change is applied during the next maintenance window,
|
@@ -15321,12 +16106,13 @@ module Aws::RDS
|
|
15321
16106
|
# A value that indicates whether the DB instance is publicly
|
15322
16107
|
# accessible.
|
15323
16108
|
#
|
15324
|
-
# When the DB
|
15325
|
-
# resolves to the private IP address from within the DB
|
15326
|
-
#
|
15327
|
-
#
|
15328
|
-
#
|
15329
|
-
# the security group assigned to the
|
16109
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
16110
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
16111
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
16112
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
16113
|
+
# cluster is ultimately controlled by the security group it uses. That
|
16114
|
+
# public access isn't permitted if the security group assigned to the
|
16115
|
+
# DB cluster doesn't permit it.
|
15330
16116
|
#
|
15331
16117
|
# When the DB instance isn't publicly accessible, it is an internal
|
15332
16118
|
# DB instance with a DNS name that resolves to a private IP address.
|
@@ -15386,7 +16172,7 @@ module Aws::RDS
|
|
15386
16172
|
# @!attribute [rw] enable_iam_database_authentication
|
15387
16173
|
# A value that indicates whether to enable mapping of Amazon Web
|
15388
16174
|
# Services Identity and Access Management (IAM) accounts to database
|
15389
|
-
# accounts. By default, mapping
|
16175
|
+
# accounts. By default, mapping isn't enabled.
|
15390
16176
|
#
|
15391
16177
|
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
15392
16178
|
# Services IAM accounts to database accounts is managed by the DB
|
@@ -15468,8 +16254,8 @@ module Aws::RDS
|
|
15468
16254
|
# @!attribute [rw] deletion_protection
|
15469
16255
|
# A value that indicates whether the DB instance has deletion
|
15470
16256
|
# protection enabled. The database can't be deleted when deletion
|
15471
|
-
# protection is enabled. By default, deletion protection
|
15472
|
-
# For more information, see [ Deleting a DB Instance][1].
|
16257
|
+
# protection is enabled. By default, deletion protection isn't
|
16258
|
+
# enabled. For more information, see [ Deleting a DB Instance][1].
|
15473
16259
|
#
|
15474
16260
|
#
|
15475
16261
|
#
|
@@ -15645,8 +16431,13 @@ module Aws::RDS
|
|
15645
16431
|
# @!attribute [rw] db_instance
|
15646
16432
|
# Contains the details of an Amazon RDS DB instance.
|
15647
16433
|
#
|
15648
|
-
# This data type is used as a response element in the
|
15649
|
-
# `
|
16434
|
+
# This data type is used as a response element in the operations
|
16435
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
16436
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
16437
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
16438
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
16439
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
16440
|
+
# `StopDBInstance`.
|
15650
16441
|
# @return [Types::DBInstance]
|
15651
16442
|
#
|
15652
16443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceResult AWS API Documentation
|
@@ -17041,6 +17832,21 @@ module Aws::RDS
|
|
17041
17832
|
# with a specific combination of other DB engine attributes.
|
17042
17833
|
# @return [Boolean]
|
17043
17834
|
#
|
17835
|
+
# @!attribute [rw] supports_clusters
|
17836
|
+
# Whether DB instances can be configured as a Multi-AZ DB cluster.
|
17837
|
+
#
|
17838
|
+
# The Multi-AZ DB clusters feature is in preview and is subject to
|
17839
|
+
# change.
|
17840
|
+
#
|
17841
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
17842
|
+
# deployments with two readable standby DB instances][1] in the
|
17843
|
+
# *Amazon RDS User Guide.*
|
17844
|
+
#
|
17845
|
+
#
|
17846
|
+
#
|
17847
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
17848
|
+
# @return [Boolean]
|
17849
|
+
#
|
17044
17850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/OrderableDBInstanceOption AWS API Documentation
|
17045
17851
|
#
|
17046
17852
|
class OrderableDBInstanceOption < Struct.new(
|
@@ -17071,7 +17877,8 @@ module Aws::RDS
|
|
17071
17877
|
:supports_kerberos_authentication,
|
17072
17878
|
:outpost_capable,
|
17073
17879
|
:supported_activity_stream_modes,
|
17074
|
-
:supports_global_databases
|
17880
|
+
:supports_global_databases,
|
17881
|
+
:supports_clusters)
|
17075
17882
|
SENSITIVE = []
|
17076
17883
|
include Aws::Structure
|
17077
17884
|
end
|
@@ -17537,10 +18344,39 @@ module Aws::RDS
|
|
17537
18344
|
end
|
17538
18345
|
|
17539
18346
|
# @!attribute [rw] db_cluster
|
17540
|
-
# Contains the details of an Amazon Aurora DB cluster
|
18347
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
18348
|
+
# cluster.
|
17541
18349
|
#
|
17542
|
-
#
|
17543
|
-
#
|
18350
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
18351
|
+
# response element in the operations `CreateDBCluster`,
|
18352
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
18353
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
18354
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
18355
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
18356
|
+
# `StopDBCluster`.
|
18357
|
+
#
|
18358
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
18359
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
18360
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
18361
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
18362
|
+
# `RestoreDBClusterToPointInTime`.
|
18363
|
+
#
|
18364
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
18365
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
18366
|
+
#
|
18367
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
18368
|
+
# deployments with two readable standby DB instances][2] in the
|
18369
|
+
# *Amazon RDS User Guide.*
|
18370
|
+
#
|
18371
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
18372
|
+
# change.
|
18373
|
+
#
|
18374
|
+
# </note>
|
18375
|
+
#
|
18376
|
+
#
|
18377
|
+
#
|
18378
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
18379
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
17544
18380
|
# @return [Types::DBCluster]
|
17545
18381
|
#
|
17546
18382
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaDBClusterResult AWS API Documentation
|
@@ -17626,8 +18462,13 @@ module Aws::RDS
|
|
17626
18462
|
# @!attribute [rw] db_instance
|
17627
18463
|
# Contains the details of an Amazon RDS DB instance.
|
17628
18464
|
#
|
17629
|
-
# This data type is used as a response element in the
|
17630
|
-
# `
|
18465
|
+
# This data type is used as a response element in the operations
|
18466
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
18467
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
18468
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
18469
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
18470
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
18471
|
+
# `StopDBInstance`.
|
17631
18472
|
# @return [Types::DBInstance]
|
17632
18473
|
#
|
17633
18474
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaResult AWS API Documentation
|
@@ -17739,6 +18580,76 @@ module Aws::RDS
|
|
17739
18580
|
include Aws::Structure
|
17740
18581
|
end
|
17741
18582
|
|
18583
|
+
# @note When making an API call, you may pass RebootDBClusterMessage
|
18584
|
+
# data as a hash:
|
18585
|
+
#
|
18586
|
+
# {
|
18587
|
+
# db_cluster_identifier: "String", # required
|
18588
|
+
# }
|
18589
|
+
#
|
18590
|
+
# @!attribute [rw] db_cluster_identifier
|
18591
|
+
# The DB cluster identifier. This parameter is stored as a lowercase
|
18592
|
+
# string.
|
18593
|
+
#
|
18594
|
+
# Constraints:
|
18595
|
+
#
|
18596
|
+
# * Must match the identifier of an existing DBCluster.
|
18597
|
+
#
|
18598
|
+
# ^
|
18599
|
+
# @return [String]
|
18600
|
+
#
|
18601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBClusterMessage AWS API Documentation
|
18602
|
+
#
|
18603
|
+
class RebootDBClusterMessage < Struct.new(
|
18604
|
+
:db_cluster_identifier)
|
18605
|
+
SENSITIVE = []
|
18606
|
+
include Aws::Structure
|
18607
|
+
end
|
18608
|
+
|
18609
|
+
# @!attribute [rw] db_cluster
|
18610
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
18611
|
+
# cluster.
|
18612
|
+
#
|
18613
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
18614
|
+
# response element in the operations `CreateDBCluster`,
|
18615
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
18616
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
18617
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
18618
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
18619
|
+
# `StopDBCluster`.
|
18620
|
+
#
|
18621
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
18622
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
18623
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
18624
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
18625
|
+
# `RestoreDBClusterToPointInTime`.
|
18626
|
+
#
|
18627
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
18628
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
18629
|
+
#
|
18630
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
18631
|
+
# deployments with two readable standby DB instances][2] in the
|
18632
|
+
# *Amazon RDS User Guide.*
|
18633
|
+
#
|
18634
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
18635
|
+
# change.
|
18636
|
+
#
|
18637
|
+
# </note>
|
18638
|
+
#
|
18639
|
+
#
|
18640
|
+
#
|
18641
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
18642
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
18643
|
+
# @return [Types::DBCluster]
|
18644
|
+
#
|
18645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBClusterResult AWS API Documentation
|
18646
|
+
#
|
18647
|
+
class RebootDBClusterResult < Struct.new(
|
18648
|
+
:db_cluster)
|
18649
|
+
SENSITIVE = []
|
18650
|
+
include Aws::Structure
|
18651
|
+
end
|
18652
|
+
|
17742
18653
|
# @note When making an API call, you may pass RebootDBInstanceMessage
|
17743
18654
|
# data as a hash:
|
17744
18655
|
#
|
@@ -17778,8 +18689,13 @@ module Aws::RDS
|
|
17778
18689
|
# @!attribute [rw] db_instance
|
17779
18690
|
# Contains the details of an Amazon RDS DB instance.
|
17780
18691
|
#
|
17781
|
-
# This data type is used as a response element in the
|
17782
|
-
# `
|
18692
|
+
# This data type is used as a response element in the operations
|
18693
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
18694
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
18695
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
18696
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
18697
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
18698
|
+
# `StopDBInstance`.
|
17783
18699
|
# @return [Types::DBInstance]
|
17784
18700
|
#
|
17785
18701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstanceResult AWS API Documentation
|
@@ -18685,7 +19601,7 @@ module Aws::RDS
|
|
18685
19601
|
# @!attribute [rw] enable_iam_database_authentication
|
18686
19602
|
# A value that indicates whether to enable mapping of Amazon Web
|
18687
19603
|
# Services Identity and Access Management (IAM) accounts to database
|
18688
|
-
# accounts. By default, mapping
|
19604
|
+
# accounts. By default, mapping isn't enabled.
|
18689
19605
|
#
|
18690
19606
|
# For more information, see [ IAM Database Authentication][1] in the
|
18691
19607
|
# *Amazon Aurora User Guide.*
|
@@ -18760,7 +19676,8 @@ module Aws::RDS
|
|
18760
19676
|
# @!attribute [rw] deletion_protection
|
18761
19677
|
# A value that indicates whether the DB cluster has deletion
|
18762
19678
|
# protection enabled. The database can't be deleted when deletion
|
18763
|
-
# protection is enabled. By default, deletion protection
|
19679
|
+
# protection is enabled. By default, deletion protection isn't
|
19680
|
+
# enabled.
|
18764
19681
|
# @return [Boolean]
|
18765
19682
|
#
|
18766
19683
|
# @!attribute [rw] copy_tags_to_snapshot
|
@@ -18827,10 +19744,39 @@ module Aws::RDS
|
|
18827
19744
|
end
|
18828
19745
|
|
18829
19746
|
# @!attribute [rw] db_cluster
|
18830
|
-
# Contains the details of an Amazon Aurora DB cluster
|
19747
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
19748
|
+
# cluster.
|
18831
19749
|
#
|
18832
|
-
#
|
18833
|
-
#
|
19750
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
19751
|
+
# response element in the operations `CreateDBCluster`,
|
19752
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
19753
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
19754
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
19755
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
19756
|
+
# `StopDBCluster`.
|
19757
|
+
#
|
19758
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
19759
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
19760
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
19761
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
19762
|
+
# `RestoreDBClusterToPointInTime`.
|
19763
|
+
#
|
19764
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
19765
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
19766
|
+
#
|
19767
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
19768
|
+
# deployments with two readable standby DB instances][2] in the
|
19769
|
+
# *Amazon RDS User Guide.*
|
19770
|
+
#
|
19771
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
19772
|
+
# change.
|
19773
|
+
#
|
19774
|
+
# </note>
|
19775
|
+
#
|
19776
|
+
#
|
19777
|
+
#
|
19778
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
19779
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
18834
19780
|
# @return [Types::DBCluster]
|
18835
19781
|
#
|
18836
19782
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3Result AWS API Documentation
|
@@ -18879,11 +19825,17 @@ module Aws::RDS
|
|
18879
19825
|
# copy_tags_to_snapshot: false,
|
18880
19826
|
# domain: "String",
|
18881
19827
|
# domain_iam_role_name: "String",
|
19828
|
+
# db_cluster_instance_class: "String",
|
19829
|
+
# storage_type: "String",
|
19830
|
+
# iops: 1,
|
19831
|
+
# publicly_accessible: false,
|
18882
19832
|
# }
|
18883
19833
|
#
|
18884
19834
|
# @!attribute [rw] availability_zones
|
18885
19835
|
# Provides the list of Availability Zones (AZs) where instances in the
|
18886
19836
|
# restored DB cluster can be created.
|
19837
|
+
#
|
19838
|
+
# Valid for: Aurora DB clusters only
|
18887
19839
|
# @return [Array<String>]
|
18888
19840
|
#
|
18889
19841
|
# @!attribute [rw] db_cluster_identifier
|
@@ -18899,6 +19851,8 @@ module Aws::RDS
|
|
18899
19851
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
18900
19852
|
#
|
18901
19853
|
# Example: `my-snapshot-id`
|
19854
|
+
#
|
19855
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18902
19856
|
# @return [String]
|
18903
19857
|
#
|
18904
19858
|
# @!attribute [rw] snapshot_identifier
|
@@ -18914,6 +19868,8 @@ module Aws::RDS
|
|
18914
19868
|
# * Must match the identifier of an existing Snapshot.
|
18915
19869
|
#
|
18916
19870
|
# ^
|
19871
|
+
#
|
19872
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18917
19873
|
# @return [String]
|
18918
19874
|
#
|
18919
19875
|
# @!attribute [rw] engine
|
@@ -18922,42 +19878,71 @@ module Aws::RDS
|
|
18922
19878
|
# Default: The same as source
|
18923
19879
|
#
|
18924
19880
|
# Constraint: Must be compatible with the engine of the source
|
19881
|
+
#
|
19882
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18925
19883
|
# @return [String]
|
18926
19884
|
#
|
18927
19885
|
# @!attribute [rw] engine_version
|
18928
19886
|
# The version of the database engine to use for the new DB cluster.
|
18929
19887
|
#
|
18930
|
-
# To list all of the available engine versions for
|
18931
|
-
# 5.6-compatible Aurora
|
19888
|
+
# To list all of the available engine versions for MySQL
|
19889
|
+
# 5.6-compatible Aurora, use the following command:
|
18932
19890
|
#
|
18933
19891
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
18934
19892
|
# "DBEngineVersions[].EngineVersion"`
|
18935
19893
|
#
|
18936
|
-
# To list all of the available engine versions for
|
18937
|
-
#
|
19894
|
+
# To list all of the available engine versions for MySQL
|
19895
|
+
# 5.7-compatible Aurora, use the following command:
|
18938
19896
|
#
|
18939
19897
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
18940
19898
|
# "DBEngineVersions[].EngineVersion"`
|
18941
19899
|
#
|
18942
|
-
# To list all of the available engine versions for
|
18943
|
-
#
|
19900
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
19901
|
+
# use the following command:
|
18944
19902
|
#
|
18945
19903
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
18946
19904
|
# --query "DBEngineVersions[].EngineVersion"`
|
18947
19905
|
#
|
18948
|
-
#
|
18949
|
-
#
|
19906
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
19907
|
+
# the following command:
|
18950
19908
|
#
|
18951
|
-
#
|
19909
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
19910
|
+
# "DBEngineVersions[].EngineVersion"`
|
19911
|
+
#
|
19912
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
19913
|
+
# use the following command:
|
19914
|
+
#
|
19915
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
19916
|
+
# "DBEngineVersions[].EngineVersion"`
|
18952
19917
|
#
|
18953
19918
|
# **Aurora MySQL**
|
18954
19919
|
#
|
18955
|
-
#
|
18956
|
-
#
|
19920
|
+
# See [MySQL on Amazon RDS Versions][1] in the *Amazon Aurora User
|
19921
|
+
# Guide.*
|
18957
19922
|
#
|
18958
19923
|
# **Aurora PostgreSQL**
|
18959
19924
|
#
|
18960
|
-
#
|
19925
|
+
# See [Amazon Aurora PostgreSQL releases and engine versions][2] in
|
19926
|
+
# the *Amazon Aurora User Guide.*
|
19927
|
+
#
|
19928
|
+
# **MySQL**
|
19929
|
+
#
|
19930
|
+
# See [MySQL on Amazon RDS Versions][3] in the *Amazon RDS User
|
19931
|
+
# Guide.*
|
19932
|
+
#
|
19933
|
+
# **PostgreSQL**
|
19934
|
+
#
|
19935
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][4] in the
|
19936
|
+
# *Amazon RDS User Guide.*
|
19937
|
+
#
|
19938
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19939
|
+
#
|
19940
|
+
#
|
19941
|
+
#
|
19942
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
|
19943
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
|
19944
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
19945
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
18961
19946
|
# @return [String]
|
18962
19947
|
#
|
18963
19948
|
# @!attribute [rw] port
|
@@ -18966,6 +19951,8 @@ module Aws::RDS
|
|
18966
19951
|
# Constraints: This value must be `1150-65535`
|
18967
19952
|
#
|
18968
19953
|
# Default: The same port as the original DB cluster.
|
19954
|
+
#
|
19955
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18969
19956
|
# @return [Integer]
|
18970
19957
|
#
|
18971
19958
|
# @!attribute [rw] db_subnet_group_name
|
@@ -18975,23 +19962,34 @@ module Aws::RDS
|
|
18975
19962
|
# subnet group.
|
18976
19963
|
#
|
18977
19964
|
# Example: `mySubnetgroup`
|
19965
|
+
#
|
19966
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18978
19967
|
# @return [String]
|
18979
19968
|
#
|
18980
19969
|
# @!attribute [rw] database_name
|
18981
19970
|
# The database name for the restored DB cluster.
|
19971
|
+
#
|
19972
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18982
19973
|
# @return [String]
|
18983
19974
|
#
|
18984
19975
|
# @!attribute [rw] option_group_name
|
18985
19976
|
# The name of the option group to use for the restored DB cluster.
|
19977
|
+
#
|
19978
|
+
# DB clusters are associated with a default option group that can't
|
19979
|
+
# be modified.
|
18986
19980
|
# @return [String]
|
18987
19981
|
#
|
18988
19982
|
# @!attribute [rw] vpc_security_group_ids
|
18989
19983
|
# A list of VPC security groups that the new DB cluster will belong
|
18990
19984
|
# to.
|
19985
|
+
#
|
19986
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18991
19987
|
# @return [Array<String>]
|
18992
19988
|
#
|
18993
19989
|
# @!attribute [rw] tags
|
18994
19990
|
# The tags to be assigned to the restored DB cluster.
|
19991
|
+
#
|
19992
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18995
19993
|
# @return [Array<Types::Tag>]
|
18996
19994
|
#
|
18997
19995
|
# @!attribute [rw] kms_key_id
|
@@ -19013,16 +20011,20 @@ module Aws::RDS
|
|
19013
20011
|
#
|
19014
20012
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
19015
20013
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
20014
|
+
#
|
20015
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19016
20016
|
# @return [String]
|
19017
20017
|
#
|
19018
20018
|
# @!attribute [rw] enable_iam_database_authentication
|
19019
20019
|
# A value that indicates whether to enable mapping of Amazon Web
|
19020
20020
|
# Services Identity and Access Management (IAM) accounts to database
|
19021
|
-
# accounts. By default, mapping
|
20021
|
+
# accounts. By default, mapping isn't enabled.
|
19022
20022
|
#
|
19023
20023
|
# For more information, see [ IAM Database Authentication][1] in the
|
19024
20024
|
# *Amazon Aurora User Guide.*
|
19025
20025
|
#
|
20026
|
+
# Valid for: Aurora DB clusters only
|
20027
|
+
#
|
19026
20028
|
#
|
19027
20029
|
#
|
19028
20030
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -19044,13 +20046,19 @@ module Aws::RDS
|
|
19044
20046
|
# (72 hours).
|
19045
20047
|
#
|
19046
20048
|
# ^
|
20049
|
+
#
|
20050
|
+
# Valid for: Aurora DB clusters only
|
19047
20051
|
# @return [Integer]
|
19048
20052
|
#
|
19049
20053
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
19050
20054
|
# The list of logs that the restored DB cluster is to export to Amazon
|
19051
20055
|
# CloudWatch Logs. The values in the list depend on the DB engine
|
19052
|
-
# being used.
|
19053
|
-
#
|
20056
|
+
# being used.
|
20057
|
+
#
|
20058
|
+
# For more information, see [Publishing Database Logs to Amazon
|
20059
|
+
# CloudWatch Logs ][1] in the *Amazon Aurora User Guide*.
|
20060
|
+
#
|
20061
|
+
# Valid for: Aurora DB clusters only
|
19054
20062
|
#
|
19055
20063
|
#
|
19056
20064
|
#
|
@@ -19063,6 +20071,8 @@ module Aws::RDS
|
|
19063
20071
|
#
|
19064
20072
|
# For more information, see [ CreateDBCluster][1].
|
19065
20073
|
#
|
20074
|
+
# Valid for: Aurora DB clusters only
|
20075
|
+
#
|
19066
20076
|
#
|
19067
20077
|
#
|
19068
20078
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
|
@@ -19071,6 +20081,8 @@ module Aws::RDS
|
|
19071
20081
|
# @!attribute [rw] scaling_configuration
|
19072
20082
|
# For DB clusters in `serverless` DB engine mode, the scaling
|
19073
20083
|
# properties of the DB cluster.
|
20084
|
+
#
|
20085
|
+
# Valid for: Aurora DB clusters only
|
19074
20086
|
# @return [Types::ScalingConfiguration]
|
19075
20087
|
#
|
19076
20088
|
# @!attribute [rw] db_cluster_parameter_group_name
|
@@ -19088,18 +20100,25 @@ module Aws::RDS
|
|
19088
20100
|
# * First character must be a letter.
|
19089
20101
|
#
|
19090
20102
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
20103
|
+
#
|
20104
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19091
20105
|
# @return [String]
|
19092
20106
|
#
|
19093
20107
|
# @!attribute [rw] deletion_protection
|
19094
20108
|
# A value that indicates whether the DB cluster has deletion
|
19095
20109
|
# protection enabled. The database can't be deleted when deletion
|
19096
|
-
# protection is enabled. By default, deletion protection
|
20110
|
+
# protection is enabled. By default, deletion protection isn't
|
20111
|
+
# enabled.
|
20112
|
+
#
|
20113
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19097
20114
|
# @return [Boolean]
|
19098
20115
|
#
|
19099
20116
|
# @!attribute [rw] copy_tags_to_snapshot
|
19100
20117
|
# A value that indicates whether to copy all tags from the restored DB
|
19101
20118
|
# cluster to snapshots of the restored DB cluster. The default is not
|
19102
20119
|
# to copy them.
|
20120
|
+
#
|
20121
|
+
# Valid for: Aurora DB clusters only
|
19103
20122
|
# @return [Boolean]
|
19104
20123
|
#
|
19105
20124
|
# @!attribute [rw] domain
|
@@ -19111,6 +20130,8 @@ module Aws::RDS
|
|
19111
20130
|
# For more information, see [ Kerberos Authentication][1] in the
|
19112
20131
|
# *Amazon RDS User Guide*.
|
19113
20132
|
#
|
20133
|
+
# Valid for: Aurora DB clusters only
|
20134
|
+
#
|
19114
20135
|
#
|
19115
20136
|
#
|
19116
20137
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -19119,8 +20140,98 @@ module Aws::RDS
|
|
19119
20140
|
# @!attribute [rw] domain_iam_role_name
|
19120
20141
|
# Specify the name of the IAM role to be used when making API calls to
|
19121
20142
|
# the Directory Service.
|
20143
|
+
#
|
20144
|
+
# Valid for: Aurora DB clusters only
|
20145
|
+
# @return [String]
|
20146
|
+
#
|
20147
|
+
# @!attribute [rw] db_cluster_instance_class
|
20148
|
+
# The compute and memory capacity of the each DB instance in the
|
20149
|
+
# Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance
|
20150
|
+
# classes are available in all Amazon Web Services Regions, or for all
|
20151
|
+
# database engines.
|
20152
|
+
#
|
20153
|
+
# For the full list of DB instance classes, and availability for your
|
20154
|
+
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
20155
|
+
#
|
20156
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20157
|
+
#
|
20158
|
+
#
|
20159
|
+
#
|
20160
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
19122
20161
|
# @return [String]
|
19123
20162
|
#
|
20163
|
+
# @!attribute [rw] storage_type
|
20164
|
+
# Specifies the storage type to be associated with the each DB
|
20165
|
+
# instance in the Multi-AZ DB cluster.
|
20166
|
+
#
|
20167
|
+
# Valid values: `standard | gp2 | io1`
|
20168
|
+
#
|
20169
|
+
# If you specify `io1`, you must also include a value for the `Iops`
|
20170
|
+
# parameter.
|
20171
|
+
#
|
20172
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
20173
|
+
#
|
20174
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20175
|
+
# @return [String]
|
20176
|
+
#
|
20177
|
+
# @!attribute [rw] iops
|
20178
|
+
# The amount of Provisioned IOPS (input/output operations per second)
|
20179
|
+
# to be initially allocated for each DB instance in the Multi-AZ DB
|
20180
|
+
# cluster.
|
20181
|
+
#
|
20182
|
+
# For information about valid Iops values, see [Amazon RDS Provisioned
|
20183
|
+
# IOPS Storage to Improve Performance][1] in the *Amazon RDS User
|
20184
|
+
# Guide*.
|
20185
|
+
#
|
20186
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
20187
|
+
# amount for the DB instance.
|
20188
|
+
#
|
20189
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20190
|
+
#
|
20191
|
+
#
|
20192
|
+
#
|
20193
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
20194
|
+
# @return [Integer]
|
20195
|
+
#
|
20196
|
+
# @!attribute [rw] publicly_accessible
|
20197
|
+
# A value that indicates whether the DB cluster is publicly
|
20198
|
+
# accessible.
|
20199
|
+
#
|
20200
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
20201
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
20202
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
20203
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
20204
|
+
# cluster is ultimately controlled by the security group it uses. That
|
20205
|
+
# public access is not permitted if the security group assigned to the
|
20206
|
+
# DB cluster doesn't permit it.
|
20207
|
+
#
|
20208
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
20209
|
+
# cluster with a DNS name that resolves to a private IP address.
|
20210
|
+
#
|
20211
|
+
# Default: The default behavior varies depending on whether
|
20212
|
+
# `DBSubnetGroupName` is specified.
|
20213
|
+
#
|
20214
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
20215
|
+
# isn't specified, the following applies:
|
20216
|
+
#
|
20217
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
20218
|
+
# gateway attached to it, the DB cluster is private.
|
20219
|
+
#
|
20220
|
+
# * If the default VPC in the target Region has an internet gateway
|
20221
|
+
# attached to it, the DB cluster is public.
|
20222
|
+
#
|
20223
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
20224
|
+
# specified, the following applies:
|
20225
|
+
#
|
20226
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
20227
|
+
# gateway attached to it, the DB cluster is private.
|
20228
|
+
#
|
20229
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
20230
|
+
# attached to it, the DB cluster is public.
|
20231
|
+
#
|
20232
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20233
|
+
# @return [Boolean]
|
20234
|
+
#
|
19124
20235
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshotMessage AWS API Documentation
|
19125
20236
|
#
|
19126
20237
|
class RestoreDBClusterFromSnapshotMessage < Struct.new(
|
@@ -19145,16 +20256,49 @@ module Aws::RDS
|
|
19145
20256
|
:deletion_protection,
|
19146
20257
|
:copy_tags_to_snapshot,
|
19147
20258
|
:domain,
|
19148
|
-
:domain_iam_role_name
|
20259
|
+
:domain_iam_role_name,
|
20260
|
+
:db_cluster_instance_class,
|
20261
|
+
:storage_type,
|
20262
|
+
:iops,
|
20263
|
+
:publicly_accessible)
|
19149
20264
|
SENSITIVE = []
|
19150
20265
|
include Aws::Structure
|
19151
20266
|
end
|
19152
20267
|
|
19153
20268
|
# @!attribute [rw] db_cluster
|
19154
|
-
# Contains the details of an Amazon Aurora DB cluster
|
20269
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
20270
|
+
# cluster.
|
19155
20271
|
#
|
19156
|
-
#
|
19157
|
-
#
|
20272
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
20273
|
+
# response element in the operations `CreateDBCluster`,
|
20274
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
20275
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
20276
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
20277
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
20278
|
+
# `StopDBCluster`.
|
20279
|
+
#
|
20280
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
20281
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
20282
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
20283
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
20284
|
+
# `RestoreDBClusterToPointInTime`.
|
20285
|
+
#
|
20286
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
20287
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
20288
|
+
#
|
20289
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
20290
|
+
# deployments with two readable standby DB instances][2] in the
|
20291
|
+
# *Amazon RDS User Guide.*
|
20292
|
+
#
|
20293
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
20294
|
+
# change.
|
20295
|
+
#
|
20296
|
+
# </note>
|
20297
|
+
#
|
20298
|
+
#
|
20299
|
+
#
|
20300
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
20301
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
19158
20302
|
# @return [Types::DBCluster]
|
19159
20303
|
#
|
19160
20304
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshotResult AWS API Documentation
|
@@ -19202,6 +20346,10 @@ module Aws::RDS
|
|
19202
20346
|
# seconds_before_timeout: 1,
|
19203
20347
|
# },
|
19204
20348
|
# engine_mode: "String",
|
20349
|
+
# db_cluster_instance_class: "String",
|
20350
|
+
# storage_type: "String",
|
20351
|
+
# publicly_accessible: false,
|
20352
|
+
# iops: 1,
|
19205
20353
|
# }
|
19206
20354
|
#
|
19207
20355
|
# @!attribute [rw] db_cluster_identifier
|
@@ -19214,6 +20362,8 @@ module Aws::RDS
|
|
19214
20362
|
# * First character must be a letter
|
19215
20363
|
#
|
19216
20364
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
20365
|
+
#
|
20366
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19217
20367
|
# @return [String]
|
19218
20368
|
#
|
19219
20369
|
# @!attribute [rw] restore_type
|
@@ -19231,6 +20381,8 @@ module Aws::RDS
|
|
19231
20381
|
#
|
19232
20382
|
# If you don't specify a `RestoreType` value, then the new DB cluster
|
19233
20383
|
# is restored as a full copy of the source DB cluster.
|
20384
|
+
#
|
20385
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19234
20386
|
# @return [String]
|
19235
20387
|
#
|
19236
20388
|
# @!attribute [rw] source_db_cluster_identifier
|
@@ -19241,6 +20393,8 @@ module Aws::RDS
|
|
19241
20393
|
# * Must match the identifier of an existing DBCluster.
|
19242
20394
|
#
|
19243
20395
|
# ^
|
20396
|
+
#
|
20397
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19244
20398
|
# @return [String]
|
19245
20399
|
#
|
19246
20400
|
# @!attribute [rw] restore_to_time
|
@@ -19263,6 +20417,8 @@ module Aws::RDS
|
|
19263
20417
|
# `copy-on-write`
|
19264
20418
|
#
|
19265
20419
|
# Example: `2015-03-07T23:45:00Z`
|
20420
|
+
#
|
20421
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19266
20422
|
# @return [Time]
|
19267
20423
|
#
|
19268
20424
|
# @!attribute [rw] use_latest_restorable_time
|
@@ -19272,6 +20428,8 @@ module Aws::RDS
|
|
19272
20428
|
#
|
19273
20429
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
19274
20430
|
# provided.
|
20431
|
+
#
|
20432
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19275
20433
|
# @return [Boolean]
|
19276
20434
|
#
|
19277
20435
|
# @!attribute [rw] port
|
@@ -19280,6 +20438,8 @@ module Aws::RDS
|
|
19280
20438
|
# Constraints: A value from `1150-65535`.
|
19281
20439
|
#
|
19282
20440
|
# Default: The default port for the engine.
|
20441
|
+
#
|
20442
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19283
20443
|
# @return [Integer]
|
19284
20444
|
#
|
19285
20445
|
# @!attribute [rw] db_subnet_group_name
|
@@ -19289,14 +20449,21 @@ module Aws::RDS
|
|
19289
20449
|
# DBSubnetGroup.
|
19290
20450
|
#
|
19291
20451
|
# Example: `mySubnetgroup`
|
20452
|
+
#
|
20453
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19292
20454
|
# @return [String]
|
19293
20455
|
#
|
19294
20456
|
# @!attribute [rw] option_group_name
|
19295
20457
|
# The name of the option group for the new DB cluster.
|
20458
|
+
#
|
20459
|
+
# DB clusters are associated with a default option group that can't
|
20460
|
+
# be modified.
|
19296
20461
|
# @return [String]
|
19297
20462
|
#
|
19298
20463
|
# @!attribute [rw] vpc_security_group_ids
|
19299
20464
|
# A list of VPC security groups that the new DB cluster belongs to.
|
20465
|
+
#
|
20466
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19300
20467
|
# @return [Array<String>]
|
19301
20468
|
#
|
19302
20469
|
# @!attribute [rw] tags
|
@@ -19334,16 +20501,20 @@ module Aws::RDS
|
|
19334
20501
|
#
|
19335
20502
|
# If `DBClusterIdentifier` refers to a DB cluster that isn't
|
19336
20503
|
# encrypted, then the restore request is rejected.
|
20504
|
+
#
|
20505
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19337
20506
|
# @return [String]
|
19338
20507
|
#
|
19339
20508
|
# @!attribute [rw] enable_iam_database_authentication
|
19340
20509
|
# A value that indicates whether to enable mapping of Amazon Web
|
19341
20510
|
# Services Identity and Access Management (IAM) accounts to database
|
19342
|
-
# accounts. By default, mapping
|
20511
|
+
# accounts. By default, mapping isn't enabled.
|
19343
20512
|
#
|
19344
20513
|
# For more information, see [ IAM Database Authentication][1] in the
|
19345
20514
|
# *Amazon Aurora User Guide.*
|
19346
20515
|
#
|
20516
|
+
# Valid for: Aurora DB clusters only
|
20517
|
+
#
|
19347
20518
|
#
|
19348
20519
|
#
|
19349
20520
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -19353,10 +20524,6 @@ module Aws::RDS
|
|
19353
20524
|
# The target backtrack window, in seconds. To disable backtracking,
|
19354
20525
|
# set this value to 0.
|
19355
20526
|
#
|
19356
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
19357
|
-
#
|
19358
|
-
# </note>
|
19359
|
-
#
|
19360
20527
|
# Default: 0
|
19361
20528
|
#
|
19362
20529
|
# Constraints:
|
@@ -19365,13 +20532,19 @@ module Aws::RDS
|
|
19365
20532
|
# (72 hours).
|
19366
20533
|
#
|
19367
20534
|
# ^
|
20535
|
+
#
|
20536
|
+
# Valid for: Aurora MySQL DB clusters only
|
19368
20537
|
# @return [Integer]
|
19369
20538
|
#
|
19370
20539
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
19371
20540
|
# The list of logs that the restored DB cluster is to export to
|
19372
20541
|
# CloudWatch Logs. The values in the list depend on the DB engine
|
19373
|
-
# being used.
|
19374
|
-
#
|
20542
|
+
# being used.
|
20543
|
+
#
|
20544
|
+
# For more information, see [Publishing Database Logs to Amazon
|
20545
|
+
# CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
|
20546
|
+
#
|
20547
|
+
# Valid for: Aurora DB clusters only
|
19375
20548
|
#
|
19376
20549
|
#
|
19377
20550
|
#
|
@@ -19393,18 +20566,25 @@ module Aws::RDS
|
|
19393
20566
|
# * First character must be a letter.
|
19394
20567
|
#
|
19395
20568
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
20569
|
+
#
|
20570
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19396
20571
|
# @return [String]
|
19397
20572
|
#
|
19398
20573
|
# @!attribute [rw] deletion_protection
|
19399
20574
|
# A value that indicates whether the DB cluster has deletion
|
19400
20575
|
# protection enabled. The database can't be deleted when deletion
|
19401
|
-
# protection is enabled. By default, deletion protection
|
20576
|
+
# protection is enabled. By default, deletion protection isn't
|
20577
|
+
# enabled.
|
20578
|
+
#
|
20579
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
19402
20580
|
# @return [Boolean]
|
19403
20581
|
#
|
19404
20582
|
# @!attribute [rw] copy_tags_to_snapshot
|
19405
20583
|
# A value that indicates whether to copy all tags from the restored DB
|
19406
20584
|
# cluster to snapshots of the restored DB cluster. The default is not
|
19407
20585
|
# to copy them.
|
20586
|
+
#
|
20587
|
+
# Valid for: Aurora DB clusters only
|
19408
20588
|
# @return [Boolean]
|
19409
20589
|
#
|
19410
20590
|
# @!attribute [rw] domain
|
@@ -19416,6 +20596,8 @@ module Aws::RDS
|
|
19416
20596
|
# For more information, see [Kerberos Authentication][1] in the
|
19417
20597
|
# *Amazon Aurora User Guide*.
|
19418
20598
|
#
|
20599
|
+
# Valid for: Aurora DB clusters only
|
20600
|
+
#
|
19419
20601
|
#
|
19420
20602
|
#
|
19421
20603
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
@@ -19424,11 +20606,15 @@ module Aws::RDS
|
|
19424
20606
|
# @!attribute [rw] domain_iam_role_name
|
19425
20607
|
# Specify the name of the IAM role to be used when making API calls to
|
19426
20608
|
# the Directory Service.
|
20609
|
+
#
|
20610
|
+
# Valid for: Aurora DB clusters only
|
19427
20611
|
# @return [String]
|
19428
20612
|
#
|
19429
20613
|
# @!attribute [rw] scaling_configuration
|
19430
20614
|
# For DB clusters in `serverless` DB engine mode, the scaling
|
19431
20615
|
# properties of the DB cluster.
|
20616
|
+
#
|
20617
|
+
# Valid for: Aurora DB clusters only
|
19432
20618
|
# @return [Types::ScalingConfiguration]
|
19433
20619
|
#
|
19434
20620
|
# @!attribute [rw] engine_mode
|
@@ -19439,8 +20625,97 @@ module Aws::RDS
|
|
19439
20625
|
# To create a clone that is an Aurora Serverless cluster, the original
|
19440
20626
|
# cluster must be an Aurora Serverless cluster or an encrypted
|
19441
20627
|
# provisioned cluster.
|
20628
|
+
#
|
20629
|
+
# Valid for: Aurora DB clusters only
|
20630
|
+
# @return [String]
|
20631
|
+
#
|
20632
|
+
# @!attribute [rw] db_cluster_instance_class
|
20633
|
+
# The compute and memory capacity of the each DB instance in the
|
20634
|
+
# Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance
|
20635
|
+
# classes are available in all Amazon Web Services Regions, or for all
|
20636
|
+
# database engines.
|
20637
|
+
#
|
20638
|
+
# For the full list of DB instance classes, and availability for your
|
20639
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide.*
|
20640
|
+
#
|
20641
|
+
# Valid for: Multi-AZ DB clusters only
|
20642
|
+
#
|
20643
|
+
#
|
20644
|
+
#
|
20645
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
20646
|
+
# @return [String]
|
20647
|
+
#
|
20648
|
+
# @!attribute [rw] storage_type
|
20649
|
+
# Specifies the storage type to be associated with the each DB
|
20650
|
+
# instance in the Multi-AZ DB cluster.
|
20651
|
+
#
|
20652
|
+
# Valid values: `standard | gp2 | io1`
|
20653
|
+
#
|
20654
|
+
# If you specify `io1`, also include a value for the `Iops` parameter.
|
20655
|
+
#
|
20656
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
20657
|
+
#
|
20658
|
+
# Valid for: Multi-AZ DB clusters only
|
19442
20659
|
# @return [String]
|
19443
20660
|
#
|
20661
|
+
# @!attribute [rw] publicly_accessible
|
20662
|
+
# A value that indicates whether the DB cluster is publicly
|
20663
|
+
# accessible.
|
20664
|
+
#
|
20665
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
20666
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
20667
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
20668
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
20669
|
+
# cluster is ultimately controlled by the security group it uses. That
|
20670
|
+
# public access is not permitted if the security group assigned to the
|
20671
|
+
# DB cluster doesn't permit it.
|
20672
|
+
#
|
20673
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
20674
|
+
# cluster with a DNS name that resolves to a private IP address.
|
20675
|
+
#
|
20676
|
+
# Default: The default behavior varies depending on whether
|
20677
|
+
# `DBSubnetGroupName` is specified.
|
20678
|
+
#
|
20679
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
20680
|
+
# isn't specified, the following applies:
|
20681
|
+
#
|
20682
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
20683
|
+
# gateway attached to it, the DB cluster is private.
|
20684
|
+
#
|
20685
|
+
# * If the default VPC in the target Region has an internet gateway
|
20686
|
+
# attached to it, the DB cluster is public.
|
20687
|
+
#
|
20688
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
20689
|
+
# specified, the following applies:
|
20690
|
+
#
|
20691
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
20692
|
+
# gateway attached to it, the DB cluster is private.
|
20693
|
+
#
|
20694
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
20695
|
+
# attached to it, the DB cluster is public.
|
20696
|
+
#
|
20697
|
+
# Valid for: Multi-AZ DB clusters only
|
20698
|
+
# @return [Boolean]
|
20699
|
+
#
|
20700
|
+
# @!attribute [rw] iops
|
20701
|
+
# The amount of Provisioned IOPS (input/output operations per second)
|
20702
|
+
# to be initially allocated for each DB instance in the Multi-AZ DB
|
20703
|
+
# cluster.
|
20704
|
+
#
|
20705
|
+
# For information about valid `Iops` values, see [Amazon RDS
|
20706
|
+
# Provisioned IOPS storage to improve performance][1] in the *Amazon
|
20707
|
+
# RDS User Guide*.
|
20708
|
+
#
|
20709
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
20710
|
+
# amount for the DB instance.
|
20711
|
+
#
|
20712
|
+
# Valid for: Multi-AZ DB clusters only
|
20713
|
+
#
|
20714
|
+
#
|
20715
|
+
#
|
20716
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
20717
|
+
# @return [Integer]
|
20718
|
+
#
|
19444
20719
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTimeMessage AWS API Documentation
|
19445
20720
|
#
|
19446
20721
|
class RestoreDBClusterToPointInTimeMessage < Struct.new(
|
@@ -19464,16 +20739,49 @@ module Aws::RDS
|
|
19464
20739
|
:domain,
|
19465
20740
|
:domain_iam_role_name,
|
19466
20741
|
:scaling_configuration,
|
19467
|
-
:engine_mode
|
20742
|
+
:engine_mode,
|
20743
|
+
:db_cluster_instance_class,
|
20744
|
+
:storage_type,
|
20745
|
+
:publicly_accessible,
|
20746
|
+
:iops)
|
19468
20747
|
SENSITIVE = []
|
19469
20748
|
include Aws::Structure
|
19470
20749
|
end
|
19471
20750
|
|
19472
20751
|
# @!attribute [rw] db_cluster
|
19473
|
-
# Contains the details of an Amazon Aurora DB cluster
|
20752
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
20753
|
+
# cluster.
|
19474
20754
|
#
|
19475
|
-
#
|
19476
|
-
#
|
20755
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
20756
|
+
# response element in the operations `CreateDBCluster`,
|
20757
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
20758
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
20759
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
20760
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
20761
|
+
# `StopDBCluster`.
|
20762
|
+
#
|
20763
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
20764
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
20765
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
20766
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
20767
|
+
# `RestoreDBClusterToPointInTime`.
|
20768
|
+
#
|
20769
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
20770
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
20771
|
+
#
|
20772
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
20773
|
+
# deployments with two readable standby DB instances][2] in the
|
20774
|
+
# *Amazon RDS User Guide.*
|
20775
|
+
#
|
20776
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
20777
|
+
# change.
|
20778
|
+
#
|
20779
|
+
# </note>
|
20780
|
+
#
|
20781
|
+
#
|
20782
|
+
#
|
20783
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
20784
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
19477
20785
|
# @return [Types::DBCluster]
|
19478
20786
|
#
|
19479
20787
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTimeResult AWS API Documentation
|
@@ -19559,7 +20867,7 @@ module Aws::RDS
|
|
19559
20867
|
#
|
19560
20868
|
# @!attribute [rw] db_instance_class
|
19561
20869
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
19562
|
-
# example
|
20870
|
+
# example db.m4.large. Not all DB instance classes are available in
|
19563
20871
|
# all Amazon Web Services Regions, or for all database engines. For
|
19564
20872
|
# the full list of DB instance classes, and availability for your
|
19565
20873
|
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -19613,12 +20921,13 @@ module Aws::RDS
|
|
19613
20921
|
# A value that indicates whether the DB instance is publicly
|
19614
20922
|
# accessible.
|
19615
20923
|
#
|
19616
|
-
# When the DB instance is publicly accessible, its
|
19617
|
-
# resolves to the private IP address from within the DB
|
19618
|
-
#
|
19619
|
-
#
|
19620
|
-
#
|
19621
|
-
#
|
20924
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
20925
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
20926
|
+
# instance's virtual private cloud (VPC). It resolves to the public
|
20927
|
+
# IP address from outside of the DB instance's VPC. Access to the DB
|
20928
|
+
# instance is ultimately controlled by the security group it uses.
|
20929
|
+
# That public access is not permitted if the security group assigned
|
20930
|
+
# to the DB instance doesn't permit it.
|
19622
20931
|
#
|
19623
20932
|
# When the DB instance isn't publicly accessible, it is an internal
|
19624
20933
|
# DB instance with a DNS name that resolves to a private IP address.
|
@@ -19857,8 +21166,8 @@ module Aws::RDS
|
|
19857
21166
|
# @!attribute [rw] deletion_protection
|
19858
21167
|
# A value that indicates whether the DB instance has deletion
|
19859
21168
|
# protection enabled. The database can't be deleted when deletion
|
19860
|
-
# protection is enabled. By default, deletion protection
|
19861
|
-
# For more information, see [ Deleting a DB Instance][1].
|
21169
|
+
# protection is enabled. By default, deletion protection isn't
|
21170
|
+
# enabled. For more information, see [ Deleting a DB Instance][1].
|
19862
21171
|
#
|
19863
21172
|
#
|
19864
21173
|
#
|
@@ -19970,8 +21279,13 @@ module Aws::RDS
|
|
19970
21279
|
# @!attribute [rw] db_instance
|
19971
21280
|
# Contains the details of an Amazon RDS DB instance.
|
19972
21281
|
#
|
19973
|
-
# This data type is used as a response element in the
|
19974
|
-
# `
|
21282
|
+
# This data type is used as a response element in the operations
|
21283
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
21284
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
21285
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
21286
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
21287
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
21288
|
+
# `StopDBInstance`.
|
19975
21289
|
# @return [Types::DBInstance]
|
19976
21290
|
#
|
19977
21291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshotResult AWS API Documentation
|
@@ -20075,11 +21389,11 @@ module Aws::RDS
|
|
20075
21389
|
# @return [Integer]
|
20076
21390
|
#
|
20077
21391
|
# @!attribute [rw] db_instance_class
|
20078
|
-
# The compute and memory capacity of the DB instance, for example
|
20079
|
-
#
|
20080
|
-
#
|
20081
|
-
#
|
20082
|
-
#
|
21392
|
+
# The compute and memory capacity of the DB instance, for example
|
21393
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
21394
|
+
# Web Services Regions, or for all database engines. For the full list
|
21395
|
+
# of DB instance classes, and availability for your engine, see [DB
|
21396
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
20083
21397
|
#
|
20084
21398
|
# Importing from Amazon S3 isn't supported on the db.t2.micro DB
|
20085
21399
|
# instance class.
|
@@ -20260,12 +21574,13 @@ module Aws::RDS
|
|
20260
21574
|
# A value that indicates whether the DB instance is publicly
|
20261
21575
|
# accessible.
|
20262
21576
|
#
|
20263
|
-
# When the DB instance is publicly accessible, its
|
20264
|
-
# resolves to the private IP address from within the DB
|
20265
|
-
#
|
20266
|
-
#
|
20267
|
-
#
|
20268
|
-
#
|
21577
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
21578
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
21579
|
+
# instance's virtual private cloud (VPC). It resolves to the public
|
21580
|
+
# IP address from outside of the DB instance's VPC. Access to the DB
|
21581
|
+
# instance is ultimately controlled by the security group it uses.
|
21582
|
+
# That public access is not permitted if the security group assigned
|
21583
|
+
# to the DB instance doesn't permit it.
|
20269
21584
|
#
|
20270
21585
|
# When the DB instance isn't publicly accessible, it is an internal
|
20271
21586
|
# DB instance with a DNS name that resolves to a private IP address.
|
@@ -20351,7 +21666,7 @@ module Aws::RDS
|
|
20351
21666
|
# @!attribute [rw] enable_iam_database_authentication
|
20352
21667
|
# A value that indicates whether to enable mapping of Amazon Web
|
20353
21668
|
# Services Identity and Access Management (IAM) accounts to database
|
20354
|
-
# accounts. By default, mapping
|
21669
|
+
# accounts. By default, mapping isn't enabled.
|
20355
21670
|
#
|
20356
21671
|
# For more information about IAM database authentication, see [ IAM
|
20357
21672
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -20445,8 +21760,8 @@ module Aws::RDS
|
|
20445
21760
|
# @!attribute [rw] deletion_protection
|
20446
21761
|
# A value that indicates whether the DB instance has deletion
|
20447
21762
|
# protection enabled. The database can't be deleted when deletion
|
20448
|
-
# protection is enabled. By default, deletion protection
|
20449
|
-
# For more information, see [ Deleting a DB Instance][1].
|
21763
|
+
# protection is enabled. By default, deletion protection isn't
|
21764
|
+
# enabled. For more information, see [ Deleting a DB Instance][1].
|
20450
21765
|
#
|
20451
21766
|
#
|
20452
21767
|
#
|
@@ -20520,8 +21835,13 @@ module Aws::RDS
|
|
20520
21835
|
# @!attribute [rw] db_instance
|
20521
21836
|
# Contains the details of an Amazon RDS DB instance.
|
20522
21837
|
#
|
20523
|
-
# This data type is used as a response element in the
|
20524
|
-
# `
|
21838
|
+
# This data type is used as a response element in the operations
|
21839
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
21840
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
21841
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
21842
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
21843
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
21844
|
+
# `StopDBInstance`.
|
20525
21845
|
# @return [Types::DBInstance]
|
20526
21846
|
#
|
20527
21847
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3Result AWS API Documentation
|
@@ -20633,7 +21953,7 @@ module Aws::RDS
|
|
20633
21953
|
#
|
20634
21954
|
# @!attribute [rw] db_instance_class
|
20635
21955
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
20636
|
-
# example
|
21956
|
+
# example db.m4.large. Not all DB instance classes are available in
|
20637
21957
|
# all Amazon Web Services Regions, or for all database engines. For
|
20638
21958
|
# the full list of DB instance classes, and availability for your
|
20639
21959
|
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -20687,12 +22007,13 @@ module Aws::RDS
|
|
20687
22007
|
# A value that indicates whether the DB instance is publicly
|
20688
22008
|
# accessible.
|
20689
22009
|
#
|
20690
|
-
# When the DB
|
20691
|
-
# resolves to the private IP address from within the DB
|
20692
|
-
#
|
20693
|
-
#
|
20694
|
-
#
|
20695
|
-
# the security group assigned to the
|
22010
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
22011
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
22012
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
22013
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
22014
|
+
# cluster is ultimately controlled by the security group it uses. That
|
22015
|
+
# public access isn't permitted if the security group assigned to the
|
22016
|
+
# DB cluster doesn't permit it.
|
20696
22017
|
#
|
20697
22018
|
# When the DB instance isn't publicly accessible, it is an internal
|
20698
22019
|
# DB instance with a DNS name that resolves to a private IP address.
|
@@ -20859,7 +22180,7 @@ module Aws::RDS
|
|
20859
22180
|
# @!attribute [rw] enable_iam_database_authentication
|
20860
22181
|
# A value that indicates whether to enable mapping of Amazon Web
|
20861
22182
|
# Services Identity and Access Management (IAM) accounts to database
|
20862
|
-
# accounts. By default, mapping
|
22183
|
+
# accounts. By default, mapping isn't enabled.
|
20863
22184
|
#
|
20864
22185
|
# This setting doesn't apply to RDS Custom.
|
20865
22186
|
#
|
@@ -20922,8 +22243,8 @@ module Aws::RDS
|
|
20922
22243
|
# @!attribute [rw] deletion_protection
|
20923
22244
|
# A value that indicates whether the DB instance has deletion
|
20924
22245
|
# protection enabled. The database can't be deleted when deletion
|
20925
|
-
# protection is enabled. By default, deletion protection
|
20926
|
-
# For more information, see [ Deleting a DB Instance][1].
|
22246
|
+
# protection is enabled. By default, deletion protection isn't
|
22247
|
+
# enabled. For more information, see [ Deleting a DB Instance][1].
|
20927
22248
|
#
|
20928
22249
|
#
|
20929
22250
|
#
|
@@ -21067,8 +22388,13 @@ module Aws::RDS
|
|
21067
22388
|
# @!attribute [rw] db_instance
|
21068
22389
|
# Contains the details of an Amazon RDS DB instance.
|
21069
22390
|
#
|
21070
|
-
# This data type is used as a response element in the
|
21071
|
-
# `
|
22391
|
+
# This data type is used as a response element in the operations
|
22392
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
22393
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
22394
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
22395
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
22396
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
22397
|
+
# `StopDBInstance`.
|
21072
22398
|
# @return [Types::DBInstance]
|
21073
22399
|
#
|
21074
22400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTimeResult AWS API Documentation
|
@@ -21555,10 +22881,39 @@ module Aws::RDS
|
|
21555
22881
|
end
|
21556
22882
|
|
21557
22883
|
# @!attribute [rw] db_cluster
|
21558
|
-
# Contains the details of an Amazon Aurora DB cluster
|
22884
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
22885
|
+
# cluster.
|
21559
22886
|
#
|
21560
|
-
#
|
21561
|
-
#
|
22887
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
22888
|
+
# response element in the operations `CreateDBCluster`,
|
22889
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
22890
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
22891
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
22892
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
22893
|
+
# `StopDBCluster`.
|
22894
|
+
#
|
22895
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
22896
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
22897
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
22898
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
22899
|
+
# `RestoreDBClusterToPointInTime`.
|
22900
|
+
#
|
22901
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
22902
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
22903
|
+
#
|
22904
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
22905
|
+
# deployments with two readable standby DB instances][2] in the
|
22906
|
+
# *Amazon RDS User Guide.*
|
22907
|
+
#
|
22908
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
22909
|
+
# change.
|
22910
|
+
#
|
22911
|
+
# </note>
|
22912
|
+
#
|
22913
|
+
#
|
22914
|
+
#
|
22915
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
22916
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
21562
22917
|
# @return [Types::DBCluster]
|
21563
22918
|
#
|
21564
22919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBClusterResult AWS API Documentation
|
@@ -21661,8 +23016,13 @@ module Aws::RDS
|
|
21661
23016
|
# @!attribute [rw] db_instance
|
21662
23017
|
# Contains the details of an Amazon RDS DB instance.
|
21663
23018
|
#
|
21664
|
-
# This data type is used as a response element in the
|
21665
|
-
# `
|
23019
|
+
# This data type is used as a response element in the operations
|
23020
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
23021
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
23022
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
23023
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
23024
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
23025
|
+
# `StopDBInstance`.
|
21666
23026
|
# @return [Types::DBInstance]
|
21667
23027
|
#
|
21668
23028
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceResult AWS API Documentation
|
@@ -21849,10 +23209,39 @@ module Aws::RDS
|
|
21849
23209
|
end
|
21850
23210
|
|
21851
23211
|
# @!attribute [rw] db_cluster
|
21852
|
-
# Contains the details of an Amazon Aurora DB cluster
|
23212
|
+
# Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB
|
23213
|
+
# cluster.
|
21853
23214
|
#
|
21854
|
-
#
|
21855
|
-
#
|
23215
|
+
# For an Amazon Aurora DB cluster, this data type is used as a
|
23216
|
+
# response element in the operations `CreateDBCluster`,
|
23217
|
+
# `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`,
|
23218
|
+
# `ModifyDBCluster`, `PromoteReadReplicaDBCluster`,
|
23219
|
+
# `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`,
|
23220
|
+
# `RestoreDBClusterToPointInTime`, `StartDBCluster`, and
|
23221
|
+
# `StopDBCluster`.
|
23222
|
+
#
|
23223
|
+
# For a Multi-AZ DB cluster, this data type is used as a response
|
23224
|
+
# element in the operations `CreateDBCluster`, `DeleteDBCluster`,
|
23225
|
+
# `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`,
|
23226
|
+
# `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and
|
23227
|
+
# `RestoreDBClusterToPointInTime`.
|
23228
|
+
#
|
23229
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
23230
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
23231
|
+
#
|
23232
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
23233
|
+
# deployments with two readable standby DB instances][2] in the
|
23234
|
+
# *Amazon RDS User Guide.*
|
23235
|
+
#
|
23236
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
23237
|
+
# change.
|
23238
|
+
#
|
23239
|
+
# </note>
|
23240
|
+
#
|
23241
|
+
#
|
23242
|
+
#
|
23243
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
23244
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
21856
23245
|
# @return [Types::DBCluster]
|
21857
23246
|
#
|
21858
23247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBClusterResult AWS API Documentation
|
@@ -21927,8 +23316,13 @@ module Aws::RDS
|
|
21927
23316
|
# @!attribute [rw] db_instance
|
21928
23317
|
# Contains the details of an Amazon RDS DB instance.
|
21929
23318
|
#
|
21930
|
-
# This data type is used as a response element in the
|
21931
|
-
# `
|
23319
|
+
# This data type is used as a response element in the operations
|
23320
|
+
# `CreateDBInstance`, `CreateDBInstanceReadReplica`,
|
23321
|
+
# `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`,
|
23322
|
+
# `PromoteReadReplica`, `RebootDBInstance`,
|
23323
|
+
# `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`,
|
23324
|
+
# `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and
|
23325
|
+
# `StopDBInstance`.
|
21932
23326
|
# @return [Types::DBInstance]
|
21933
23327
|
#
|
21934
23328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceResult AWS API Documentation
|