aws-sdk-rds 1.127.0 → 1.131.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1354 -307
- data/lib/aws-sdk-rds/client_api.rb +99 -0
- data/lib/aws-sdk-rds/db_cluster.rb +30 -34
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +20 -24
- data/lib/aws-sdk-rds/db_engine.rb +8 -0
- data/lib/aws-sdk-rds/db_engine_version.rb +66 -4
- data/lib/aws-sdk-rds/db_instance.rb +551 -188
- data/lib/aws-sdk-rds/db_snapshot.rb +99 -30
- data/lib/aws-sdk-rds/errors.rb +44 -0
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +5 -1
- data/lib/aws-sdk-rds/resource.rb +202 -108
- data/lib/aws-sdk-rds/types.rb +1133 -336
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -164,8 +164,8 @@ module Aws::RDS
|
|
164
164
|
#
|
165
165
|
# @!attribute [rw] feature_name
|
166
166
|
# The name of the feature for the DB cluster that the IAM role is to
|
167
|
-
# be associated with. For
|
168
|
-
# DBEngineVersion.
|
167
|
+
# be associated with. For information about supported feature names,
|
168
|
+
# see DBEngineVersion.
|
169
169
|
# @return [String]
|
170
170
|
#
|
171
171
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddRoleToDBClusterMessage AWS API Documentation
|
@@ -199,8 +199,8 @@ module Aws::RDS
|
|
199
199
|
#
|
200
200
|
# @!attribute [rw] feature_name
|
201
201
|
# The name of the feature for the DB instance that the IAM role is to
|
202
|
-
# be associated with. For
|
203
|
-
# DBEngineVersion.
|
202
|
+
# be associated with. For information about supported feature names,
|
203
|
+
# see DBEngineVersion.
|
204
204
|
# @return [String]
|
205
205
|
#
|
206
206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddRoleToDBInstanceMessage AWS API Documentation
|
@@ -1088,14 +1088,13 @@ module Aws::RDS
|
|
1088
1088
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
1089
1089
|
# cluster snapshot. The Amazon Web Services KMS key identifier is the
|
1090
1090
|
# key ARN, key ID, alias ARN, or alias name for the Amazon Web
|
1091
|
-
# Services KMS
|
1091
|
+
# Services KMS key.
|
1092
1092
|
#
|
1093
1093
|
# If you copy an encrypted DB cluster snapshot from your Amazon Web
|
1094
1094
|
# Services account, you can specify a value for `KmsKeyId` to encrypt
|
1095
|
-
# the copy with a new
|
1096
|
-
#
|
1097
|
-
#
|
1098
|
-
# the source DB cluster snapshot.
|
1095
|
+
# the copy with a new KMS key. If you don't specify a value for
|
1096
|
+
# `KmsKeyId`, then the copy of the DB cluster snapshot is encrypted
|
1097
|
+
# with the same KMS key as the source DB cluster snapshot.
|
1099
1098
|
#
|
1100
1099
|
# If you copy an encrypted DB cluster snapshot that is shared from
|
1101
1100
|
# another Amazon Web Services account, then you must specify a value
|
@@ -1104,10 +1103,10 @@ module Aws::RDS
|
|
1104
1103
|
# To copy an encrypted DB cluster snapshot to another Amazon Web
|
1105
1104
|
# Services Region, you must set `KmsKeyId` to the Amazon Web Services
|
1106
1105
|
# KMS key identifier you want to use to encrypt the copy of the DB
|
1107
|
-
# cluster snapshot in the destination Amazon Web Services Region.
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
#
|
1106
|
+
# cluster snapshot in the destination Amazon Web Services Region. KMS
|
1107
|
+
# keys are specific to the Amazon Web Services Region that they are
|
1108
|
+
# created in, and you can't use KMS keys from one Amazon Web Services
|
1109
|
+
# Region in another Amazon Web Services Region.
|
1111
1110
|
#
|
1112
1111
|
# If you copy an unencrypted DB cluster snapshot and specify a value
|
1113
1112
|
# for the `KmsKeyId` parameter, an error is returned.
|
@@ -1129,11 +1128,11 @@ module Aws::RDS
|
|
1129
1128
|
# contain the following parameter values:
|
1130
1129
|
#
|
1131
1130
|
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
#
|
1135
|
-
#
|
1136
|
-
#
|
1131
|
+
# KMS key to use to encrypt the copy of the DB cluster snapshot in
|
1132
|
+
# the destination Amazon Web Services Region. This is the same
|
1133
|
+
# identifier for both the `CopyDBClusterSnapshot` action that is
|
1134
|
+
# called in the destination Amazon Web Services Region, and the
|
1135
|
+
# action contained in the pre-signed URL.
|
1137
1136
|
#
|
1138
1137
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
1139
1138
|
# that the DB cluster snapshot is to be created in.
|
@@ -1373,15 +1372,13 @@ module Aws::RDS
|
|
1373
1372
|
# @!attribute [rw] kms_key_id
|
1374
1373
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
1375
1374
|
# snapshot. The Amazon Web Services KMS key identifier is the key ARN,
|
1376
|
-
# key ID, alias ARN, or alias name for the
|
1377
|
-
# customer master key (CMK).
|
1375
|
+
# key ID, alias ARN, or alias name for the KMS key.
|
1378
1376
|
#
|
1379
1377
|
# If you copy an encrypted DB snapshot from your Amazon Web Services
|
1380
1378
|
# account, you can specify a value for this parameter to encrypt the
|
1381
|
-
# copy with a new
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
# snapshot.
|
1379
|
+
# copy with a new KMS key. If you don't specify a value for this
|
1380
|
+
# parameter, then the copy of the DB snapshot is encrypted with the
|
1381
|
+
# same Amazon Web Services KMS key as the source DB snapshot.
|
1385
1382
|
#
|
1386
1383
|
# If you copy an encrypted DB snapshot that is shared from another
|
1387
1384
|
# Amazon Web Services account, then you must specify a value for this
|
@@ -1391,11 +1388,11 @@ module Aws::RDS
|
|
1391
1388
|
# the copy is encrypted.
|
1392
1389
|
#
|
1393
1390
|
# If you copy an encrypted snapshot to a different Amazon Web Services
|
1394
|
-
# Region, then you must specify
|
1395
|
-
# identifier for the destination Amazon Web Services Region.
|
1396
|
-
#
|
1397
|
-
#
|
1398
|
-
#
|
1391
|
+
# Region, then you must specify an Amazon Web Services KMS key
|
1392
|
+
# identifier for the destination Amazon Web Services Region. KMS keys
|
1393
|
+
# are specific to the Amazon Web Services Region that they are created
|
1394
|
+
# in, and you can't use KMS keys from one Amazon Web Services Region
|
1395
|
+
# in another Amazon Web Services Region.
|
1399
1396
|
# @return [String]
|
1400
1397
|
#
|
1401
1398
|
# @!attribute [rw] tags
|
@@ -1442,11 +1439,11 @@ module Aws::RDS
|
|
1442
1439
|
# us-east-1 Amazon Web Services Region.
|
1443
1440
|
#
|
1444
1441
|
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
1445
|
-
#
|
1446
|
-
#
|
1447
|
-
#
|
1448
|
-
#
|
1449
|
-
#
|
1442
|
+
# KMS key to use to encrypt the copy of the DB snapshot in the
|
1443
|
+
# destination Amazon Web Services Region. This is the same
|
1444
|
+
# identifier for both the `CopyDBSnapshot` action that is called in
|
1445
|
+
# the destination Amazon Web Services Region, and the action
|
1446
|
+
# contained in the presigned URL.
|
1450
1447
|
#
|
1451
1448
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
1452
1449
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -1676,6 +1673,135 @@ module Aws::RDS
|
|
1676
1673
|
include Aws::Structure
|
1677
1674
|
end
|
1678
1675
|
|
1676
|
+
# @note When making an API call, you may pass CreateCustomDBEngineVersionMessage
|
1677
|
+
# data as a hash:
|
1678
|
+
#
|
1679
|
+
# {
|
1680
|
+
# engine: "CustomEngineName", # required
|
1681
|
+
# engine_version: "CustomEngineVersion", # required
|
1682
|
+
# database_installation_files_s3_bucket_name: "BucketName", # required
|
1683
|
+
# database_installation_files_s3_prefix: "String255",
|
1684
|
+
# kms_key_id: "KmsKeyIdOrArn", # required
|
1685
|
+
# description: "Description",
|
1686
|
+
# manifest: "CustomDBEngineVersionManifest", # required
|
1687
|
+
# tags: [
|
1688
|
+
# {
|
1689
|
+
# key: "String",
|
1690
|
+
# value: "String",
|
1691
|
+
# },
|
1692
|
+
# ],
|
1693
|
+
# }
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] engine
|
1696
|
+
# The database engine to use for your custom engine version (CEV). The
|
1697
|
+
# only supported value is `custom-oracle-ee`.
|
1698
|
+
# @return [String]
|
1699
|
+
#
|
1700
|
+
# @!attribute [rw] engine_version
|
1701
|
+
# The name of your CEV. The name format is `19.customized_string `.
|
1702
|
+
# For example, a valid name is `19.my_cev1`. This setting is required
|
1703
|
+
# for RDS Custom, but optional for Amazon RDS. The combination of
|
1704
|
+
# `Engine` and `EngineVersion` is unique per customer per Region.
|
1705
|
+
# @return [String]
|
1706
|
+
#
|
1707
|
+
# @!attribute [rw] database_installation_files_s3_bucket_name
|
1708
|
+
# The name of an Amazon S3 bucket that contains database installation
|
1709
|
+
# files for your CEV. For example, a valid bucket name is
|
1710
|
+
# `my-custom-installation-files`.
|
1711
|
+
# @return [String]
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] database_installation_files_s3_prefix
|
1714
|
+
# The Amazon S3 directory that contains the database installation
|
1715
|
+
# files for your CEV. For example, a valid bucket name is
|
1716
|
+
# `123456789012/cev1`. If this setting isn't specified, no prefix is
|
1717
|
+
# assumed.
|
1718
|
+
# @return [String]
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] kms_key_id
|
1721
|
+
# The Amazon Web Services KMS key identifier for an encrypted CEV. A
|
1722
|
+
# symmetric KMS key is required for RDS Custom, but optional for
|
1723
|
+
# Amazon RDS.
|
1724
|
+
#
|
1725
|
+
# If you have an existing symmetric KMS key in your account, you can
|
1726
|
+
# use it with RDS Custom. No further action is necessary. If you
|
1727
|
+
# don't already have a symmetric KMS key in your account, follow the
|
1728
|
+
# instructions in [ Creating symmetric KMS keys][1] in the *Amazon Web
|
1729
|
+
# Services Key Management Service Developer Guide*.
|
1730
|
+
#
|
1731
|
+
# You can choose the same symmetric key when you create a CEV and a DB
|
1732
|
+
# instance, or choose different keys.
|
1733
|
+
#
|
1734
|
+
#
|
1735
|
+
#
|
1736
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk
|
1737
|
+
# @return [String]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] description
|
1740
|
+
# An optional description of your CEV.
|
1741
|
+
# @return [String]
|
1742
|
+
#
|
1743
|
+
# @!attribute [rw] manifest
|
1744
|
+
# The CEV manifest, which is a JSON document that describes the
|
1745
|
+
# installation .zip files stored in Amazon S3. Specify the name/value
|
1746
|
+
# pairs in a file or a quoted string. RDS Custom applies the patches
|
1747
|
+
# in the order in which they are listed.
|
1748
|
+
#
|
1749
|
+
# The following JSON fields are valid:
|
1750
|
+
#
|
1751
|
+
# MediaImportTemplateVersion
|
1752
|
+
#
|
1753
|
+
# : Version of the CEV manifest. The date is in the format
|
1754
|
+
# `YYYY-MM-DD`.
|
1755
|
+
#
|
1756
|
+
# databaseInstallationFileNames
|
1757
|
+
#
|
1758
|
+
# : Ordered list of installation files for the CEV.
|
1759
|
+
#
|
1760
|
+
# opatchFileNames
|
1761
|
+
#
|
1762
|
+
# : Ordered list of OPatch installers used for the Oracle DB engine.
|
1763
|
+
#
|
1764
|
+
# psuRuPatchFileNames
|
1765
|
+
#
|
1766
|
+
# : The PSU and RU patches for this CEV.
|
1767
|
+
#
|
1768
|
+
# OtherPatchFileNames
|
1769
|
+
#
|
1770
|
+
# : The patches that are not in the list of PSU and RU patches. Amazon
|
1771
|
+
# RDS applies these patches after applying the PSU and RU patches.
|
1772
|
+
#
|
1773
|
+
# For more information, see [ Creating the CEV manifest][1] in the
|
1774
|
+
# *Amazon RDS User Guide*.
|
1775
|
+
#
|
1776
|
+
#
|
1777
|
+
#
|
1778
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest
|
1779
|
+
# @return [String]
|
1780
|
+
#
|
1781
|
+
# @!attribute [rw] tags
|
1782
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1783
|
+
# Resources][1] in the *Amazon RDS User Guide.*
|
1784
|
+
#
|
1785
|
+
#
|
1786
|
+
#
|
1787
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1788
|
+
# @return [Array<Types::Tag>]
|
1789
|
+
#
|
1790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateCustomDBEngineVersionMessage AWS API Documentation
|
1791
|
+
#
|
1792
|
+
class CreateCustomDBEngineVersionMessage < Struct.new(
|
1793
|
+
:engine,
|
1794
|
+
:engine_version,
|
1795
|
+
:database_installation_files_s3_bucket_name,
|
1796
|
+
:database_installation_files_s3_prefix,
|
1797
|
+
:kms_key_id,
|
1798
|
+
:description,
|
1799
|
+
:manifest,
|
1800
|
+
:tags)
|
1801
|
+
SENSITIVE = []
|
1802
|
+
include Aws::Structure
|
1803
|
+
end
|
1804
|
+
|
1679
1805
|
# @note When making an API call, you may pass CreateDBClusterEndpointMessage
|
1680
1806
|
# data as a hash:
|
1681
1807
|
#
|
@@ -2002,29 +2128,29 @@ module Aws::RDS
|
|
2002
2128
|
# cluster.
|
2003
2129
|
#
|
2004
2130
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2005
|
-
# alias ARN, or alias name for the
|
2006
|
-
#
|
2007
|
-
#
|
2131
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
2132
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
2133
|
+
# ARN.
|
2008
2134
|
#
|
2009
|
-
# When a
|
2135
|
+
# When a KMS key isn't specified in `KmsKeyId`\:
|
2010
2136
|
#
|
2011
2137
|
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
2012
|
-
# then Amazon RDS will use the
|
2013
|
-
# Otherwise, Amazon RDS will use your default
|
2138
|
+
# then Amazon RDS will use the KMS key used to encrypt the source.
|
2139
|
+
# Otherwise, Amazon RDS will use your default KMS key.
|
2014
2140
|
#
|
2015
2141
|
# * If the `StorageEncrypted` parameter is enabled and
|
2016
2142
|
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS
|
2017
|
-
# will use your default
|
2143
|
+
# will use your default KMS key.
|
2018
2144
|
#
|
2019
|
-
# There is a default
|
2020
|
-
# Amazon Web Services account has a different default
|
2021
|
-
# Amazon Web Services Region.
|
2145
|
+
# There is a default KMS key for your Amazon Web Services account.
|
2146
|
+
# Your Amazon Web Services account has a different default KMS key for
|
2147
|
+
# each Amazon Web Services Region.
|
2022
2148
|
#
|
2023
2149
|
# If you create a read replica of an encrypted DB cluster in another
|
2024
|
-
# Amazon Web Services Region, you must set `KmsKeyId` to a
|
2025
|
-
#
|
2026
|
-
#
|
2027
|
-
#
|
2150
|
+
# Amazon Web Services Region, you must set `KmsKeyId` to a KMS key
|
2151
|
+
# identifier that is valid in the destination Amazon Web Services
|
2152
|
+
# Region. This KMS key is used to encrypt the read replica in that
|
2153
|
+
# Amazon Web Services Region.
|
2028
2154
|
# @return [String]
|
2029
2155
|
#
|
2030
2156
|
# @!attribute [rw] pre_signed_url
|
@@ -2042,11 +2168,11 @@ module Aws::RDS
|
|
2042
2168
|
# values:
|
2043
2169
|
#
|
2044
2170
|
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
2045
|
-
# key to use to encrypt the copy of the DB cluster in the
|
2171
|
+
# KMS key to use to encrypt the copy of the DB cluster in the
|
2046
2172
|
# destination Amazon Web Services Region. This should refer to the
|
2047
|
-
# same
|
2048
|
-
#
|
2049
|
-
#
|
2173
|
+
# same KMS key for both the `CreateDBCluster` action that is called
|
2174
|
+
# in the destination Amazon Web Services Region, and the action
|
2175
|
+
# contained in the pre-signed URL.
|
2050
2176
|
#
|
2051
2177
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
2052
2178
|
# that Aurora read replica will be created in.
|
@@ -2539,6 +2665,8 @@ module Aws::RDS
|
|
2539
2665
|
# deletion_protection: false,
|
2540
2666
|
# max_allocated_storage: 1,
|
2541
2667
|
# enable_customer_owned_ip: false,
|
2668
|
+
# custom_iam_instance_profile: "String",
|
2669
|
+
# backup_target: "String",
|
2542
2670
|
# }
|
2543
2671
|
#
|
2544
2672
|
# @!attribute [rw] db_name
|
@@ -2604,6 +2732,21 @@ module Aws::RDS
|
|
2604
2732
|
#
|
2605
2733
|
# ^
|
2606
2734
|
#
|
2735
|
+
# **Amazon RDS Custom**
|
2736
|
+
#
|
2737
|
+
# The Oracle System ID (SID) of the created RDS Custom DB instance. If
|
2738
|
+
# you don't specify a value, the default value is `ORCL`.
|
2739
|
+
#
|
2740
|
+
# Default: `ORCL`
|
2741
|
+
#
|
2742
|
+
# Constraints:
|
2743
|
+
#
|
2744
|
+
# * It must contain 1 to 8 alphanumeric characters.
|
2745
|
+
#
|
2746
|
+
# * It must contain a letter.
|
2747
|
+
#
|
2748
|
+
# * It can't be a word reserved by the database engine.
|
2749
|
+
#
|
2607
2750
|
# **SQL Server**
|
2608
2751
|
#
|
2609
2752
|
# Not applicable. Must be null.
|
@@ -2665,6 +2808,17 @@ module Aws::RDS
|
|
2665
2808
|
# amount of data in your database increases, though you are only
|
2666
2809
|
# charged for the space that you use in an Aurora cluster volume.
|
2667
2810
|
#
|
2811
|
+
# **Amazon RDS Custom**
|
2812
|
+
#
|
2813
|
+
# Constraints to the amount of storage for each storage type are the
|
2814
|
+
# following:
|
2815
|
+
#
|
2816
|
+
# * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
|
2817
|
+
# 65536.
|
2818
|
+
#
|
2819
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to
|
2820
|
+
# 65536.
|
2821
|
+
#
|
2668
2822
|
# **MySQL**
|
2669
2823
|
#
|
2670
2824
|
# Constraints to the amount of storage for each storage type are the
|
@@ -2770,6 +2924,8 @@ module Aws::RDS
|
|
2770
2924
|
#
|
2771
2925
|
# * `aurora-postgresql`
|
2772
2926
|
#
|
2927
|
+
# * `custom-oracle-ee (for RDS Custom instances)`
|
2928
|
+
#
|
2773
2929
|
# * `mariadb`
|
2774
2930
|
#
|
2775
2931
|
# * `mysql`
|
@@ -2801,59 +2957,13 @@ module Aws::RDS
|
|
2801
2957
|
# Not applicable. The name for the master user is managed by the DB
|
2802
2958
|
# cluster.
|
2803
2959
|
#
|
2804
|
-
# **
|
2960
|
+
# **Amazon RDS**
|
2805
2961
|
#
|
2806
2962
|
# Constraints:
|
2807
2963
|
#
|
2808
|
-
# * Required
|
2809
|
-
#
|
2810
|
-
# * Must be 1 to 16 letters or numbers.
|
2964
|
+
# * Required.
|
2811
2965
|
#
|
2812
|
-
# *
|
2813
|
-
#
|
2814
|
-
# **Microsoft SQL Server**
|
2815
|
-
#
|
2816
|
-
# Constraints:
|
2817
|
-
#
|
2818
|
-
# * Required for SQL Server.
|
2819
|
-
#
|
2820
|
-
# * Must be 1 to 128 letters or numbers.
|
2821
|
-
#
|
2822
|
-
# * The first character must be a letter.
|
2823
|
-
#
|
2824
|
-
# * Can't be a reserved word for the chosen database engine.
|
2825
|
-
#
|
2826
|
-
# **MySQL**
|
2827
|
-
#
|
2828
|
-
# Constraints:
|
2829
|
-
#
|
2830
|
-
# * Required for MySQL.
|
2831
|
-
#
|
2832
|
-
# * Must be 1 to 16 letters or numbers.
|
2833
|
-
#
|
2834
|
-
# * First character must be a letter.
|
2835
|
-
#
|
2836
|
-
# * Can't be a reserved word for the chosen database engine.
|
2837
|
-
#
|
2838
|
-
# **Oracle**
|
2839
|
-
#
|
2840
|
-
# Constraints:
|
2841
|
-
#
|
2842
|
-
# * Required for Oracle.
|
2843
|
-
#
|
2844
|
-
# * Must be 1 to 30 letters or numbers.
|
2845
|
-
#
|
2846
|
-
# * First character must be a letter.
|
2847
|
-
#
|
2848
|
-
# * Can't be a reserved word for the chosen database engine.
|
2849
|
-
#
|
2850
|
-
# **PostgreSQL**
|
2851
|
-
#
|
2852
|
-
# Constraints:
|
2853
|
-
#
|
2854
|
-
# * Required for PostgreSQL.
|
2855
|
-
#
|
2856
|
-
# * Must be 1 to 63 letters or numbers.
|
2966
|
+
# * Must be 1 to 16 letters, numbers, or underscores.
|
2857
2967
|
#
|
2858
2968
|
# * First character must be a letter.
|
2859
2969
|
#
|
@@ -2970,6 +3080,8 @@ module Aws::RDS
|
|
2970
3080
|
# instance. If you do not specify a value, then the default DB
|
2971
3081
|
# parameter group for the specified DB engine and version is used.
|
2972
3082
|
#
|
3083
|
+
# This setting doesn't apply to RDS Custom.
|
3084
|
+
#
|
2973
3085
|
# Constraints:
|
2974
3086
|
#
|
2975
3087
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
@@ -2996,6 +3108,8 @@ module Aws::RDS
|
|
2996
3108
|
# * Must be a value from 0 to 35
|
2997
3109
|
#
|
2998
3110
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
3111
|
+
#
|
3112
|
+
# * Can't be set to 0 or 35 for an RDS Custom DB instance
|
2999
3113
|
# @return [Integer]
|
3000
3114
|
#
|
3001
3115
|
# @!attribute [rw] preferred_backup_window
|
@@ -3079,6 +3193,8 @@ module Aws::RDS
|
|
3079
3193
|
# A value that indicates whether the DB instance is a Multi-AZ
|
3080
3194
|
# deployment. You can't set the `AvailabilityZone` parameter if the
|
3081
3195
|
# DB instance is a Multi-AZ deployment.
|
3196
|
+
#
|
3197
|
+
# This setting doesn't apply to RDS Custom.
|
3082
3198
|
# @return [Boolean]
|
3083
3199
|
#
|
3084
3200
|
# @!attribute [rw] engine_version
|
@@ -3097,44 +3213,56 @@ module Aws::RDS
|
|
3097
3213
|
# Not applicable. The version number of the database engine to be used
|
3098
3214
|
# by the DB instance is managed by the DB cluster.
|
3099
3215
|
#
|
3216
|
+
# **Amazon RDS Custom**
|
3217
|
+
#
|
3218
|
+
# A custom engine version (CEV) that you have previously created. This
|
3219
|
+
# setting is required for RDS Custom. The CEV name has the following
|
3220
|
+
# format: `19.customized_string `. An example identifier is
|
3221
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom DB
|
3222
|
+
# instance][1] in the *Amazon RDS User Guide.*.
|
3223
|
+
#
|
3100
3224
|
# **MariaDB**
|
3101
3225
|
#
|
3102
|
-
# See [MariaDB on Amazon RDS Versions][
|
3226
|
+
# See [MariaDB on Amazon RDS Versions][2] in the *Amazon RDS User
|
3103
3227
|
# Guide.*
|
3104
3228
|
#
|
3105
3229
|
# **Microsoft SQL Server**
|
3106
3230
|
#
|
3107
|
-
# See [Microsoft SQL Server Versions on Amazon RDS][
|
3231
|
+
# See [Microsoft SQL Server Versions on Amazon RDS][3] in the *Amazon
|
3108
3232
|
# RDS User Guide.*
|
3109
3233
|
#
|
3110
3234
|
# **MySQL**
|
3111
3235
|
#
|
3112
|
-
# See [MySQL on Amazon RDS Versions][
|
3236
|
+
# See [MySQL on Amazon RDS Versions][4] in the *Amazon RDS User
|
3113
3237
|
# Guide.*
|
3114
3238
|
#
|
3115
3239
|
# **Oracle**
|
3116
3240
|
#
|
3117
|
-
# See [Oracle Database Engine Release Notes][
|
3241
|
+
# See [Oracle Database Engine Release Notes][5] in the *Amazon RDS
|
3118
3242
|
# User Guide.*
|
3119
3243
|
#
|
3120
3244
|
# **PostgreSQL**
|
3121
3245
|
#
|
3122
|
-
# See [Amazon RDS for PostgreSQL versions and extensions][
|
3246
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][6] in the
|
3123
3247
|
# *Amazon RDS User Guide.*
|
3124
3248
|
#
|
3125
3249
|
#
|
3126
3250
|
#
|
3127
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
3128
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
3129
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
3130
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
3131
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
3251
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
|
3252
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
|
3253
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
3254
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
3255
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
3256
|
+
# [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
3132
3257
|
# @return [String]
|
3133
3258
|
#
|
3134
3259
|
# @!attribute [rw] auto_minor_version_upgrade
|
3135
3260
|
# A value that indicates whether minor engine upgrades are applied
|
3136
3261
|
# automatically to the DB instance during the maintenance window. By
|
3137
3262
|
# default, minor engine upgrades are applied automatically.
|
3263
|
+
#
|
3264
|
+
# If you create an RDS Custom DB instance, you must set
|
3265
|
+
# `AutoMinorVersionUpgrade` to `false`.
|
3138
3266
|
# @return [Boolean]
|
3139
3267
|
#
|
3140
3268
|
# @!attribute [rw] license_model
|
@@ -3142,6 +3270,8 @@ module Aws::RDS
|
|
3142
3270
|
#
|
3143
3271
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
3144
3272
|
# `general-public-license`
|
3273
|
+
#
|
3274
|
+
# This setting doesn't apply to RDS Custom.
|
3145
3275
|
# @return [String]
|
3146
3276
|
#
|
3147
3277
|
# @!attribute [rw] iops
|
@@ -3166,13 +3296,18 @@ module Aws::RDS
|
|
3166
3296
|
#
|
3167
3297
|
# Permanent options, such as the TDE option for Oracle Advanced
|
3168
3298
|
# Security TDE, can't be removed from an option group. Also, that
|
3169
|
-
# option group can't be removed from a DB instance
|
3170
|
-
# associated with a DB instance
|
3299
|
+
# option group can't be removed from a DB instance after it is
|
3300
|
+
# associated with a DB instance.
|
3301
|
+
#
|
3302
|
+
# This setting doesn't apply to RDS Custom.
|
3171
3303
|
# @return [String]
|
3172
3304
|
#
|
3173
3305
|
# @!attribute [rw] character_set_name
|
3174
|
-
# For supported engines, indicates that the DB instance
|
3175
|
-
# associated with the specified CharacterSet
|
3306
|
+
# For supported engines, this value indicates that the DB instance
|
3307
|
+
# should be associated with the specified `CharacterSet`.
|
3308
|
+
#
|
3309
|
+
# This setting doesn't apply to RDS Custom. However, if you need to
|
3310
|
+
# change the character set, you can change it on the database itself.
|
3176
3311
|
#
|
3177
3312
|
# **Amazon Aurora**
|
3178
3313
|
#
|
@@ -3182,6 +3317,8 @@ module Aws::RDS
|
|
3182
3317
|
#
|
3183
3318
|
# @!attribute [rw] nchar_character_set_name
|
3184
3319
|
# The name of the NCHAR character set for the Oracle DB instance.
|
3320
|
+
#
|
3321
|
+
# This parameter doesn't apply to RDS Custom.
|
3185
3322
|
# @return [String]
|
3186
3323
|
#
|
3187
3324
|
# @!attribute [rw] publicly_accessible
|
@@ -3226,6 +3363,8 @@ module Aws::RDS
|
|
3226
3363
|
#
|
3227
3364
|
# @!attribute [rw] db_cluster_identifier
|
3228
3365
|
# The identifier of the DB cluster that the instance will belong to.
|
3366
|
+
#
|
3367
|
+
# This setting doesn't apply to RDS Custom.
|
3229
3368
|
# @return [String]
|
3230
3369
|
#
|
3231
3370
|
# @!attribute [rw] storage_type
|
@@ -3242,17 +3381,25 @@ module Aws::RDS
|
|
3242
3381
|
# @!attribute [rw] tde_credential_arn
|
3243
3382
|
# The ARN from the key store with which to associate the instance for
|
3244
3383
|
# TDE encryption.
|
3384
|
+
#
|
3385
|
+
# This setting doesn't apply to RDS Custom.
|
3245
3386
|
# @return [String]
|
3246
3387
|
#
|
3247
3388
|
# @!attribute [rw] tde_credential_password
|
3248
3389
|
# The password for the given ARN from the key store in order to access
|
3249
3390
|
# the device.
|
3391
|
+
#
|
3392
|
+
# This setting doesn't apply to RDS Custom.
|
3250
3393
|
# @return [String]
|
3251
3394
|
#
|
3252
3395
|
# @!attribute [rw] storage_encrypted
|
3253
3396
|
# A value that indicates whether the DB instance is encrypted. By
|
3254
3397
|
# default, it isn't encrypted.
|
3255
3398
|
#
|
3399
|
+
# For RDS Custom Oracle instances, either set this parameter to `true`
|
3400
|
+
# or leave it unset. If you set this parameter to `false`, RDS reports
|
3401
|
+
# an error.
|
3402
|
+
#
|
3256
3403
|
# **Amazon Aurora**
|
3257
3404
|
#
|
3258
3405
|
# Not applicable. The encryption for DB instances is managed by the DB
|
@@ -3264,9 +3411,9 @@ module Aws::RDS
|
|
3264
3411
|
# instance.
|
3265
3412
|
#
|
3266
3413
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3267
|
-
# alias ARN, or alias name for the
|
3268
|
-
#
|
3269
|
-
#
|
3414
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
3415
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
3416
|
+
# ARN.
|
3270
3417
|
#
|
3271
3418
|
# **Amazon Aurora**
|
3272
3419
|
#
|
@@ -3275,10 +3422,18 @@ module Aws::RDS
|
|
3275
3422
|
# `CreateDBCluster`.
|
3276
3423
|
#
|
3277
3424
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
3278
|
-
# the `KmsKeyId` parameter, then Amazon RDS uses your default
|
3279
|
-
# There is a default
|
3280
|
-
# Amazon Web Services account has a different default
|
3281
|
-
# Amazon Web Services Region.
|
3425
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
|
3426
|
+
# There is a default KMS key for your Amazon Web Services account.
|
3427
|
+
# Your Amazon Web Services account has a different default KMS key for
|
3428
|
+
# each Amazon Web Services Region.
|
3429
|
+
#
|
3430
|
+
# **Amazon RDS Custom**
|
3431
|
+
#
|
3432
|
+
# A KMS key is required for RDS Custom Oracle instances. For most RDS
|
3433
|
+
# engines, if you leave this parameter empty while enabling
|
3434
|
+
# `StorageEncrypted`, the engine uses the default KMS key. However,
|
3435
|
+
# RDS Custom for Oracle doesn't use the default key when this
|
3436
|
+
# parameter is empty. You must explicitly specify a key.
|
3282
3437
|
# @return [String]
|
3283
3438
|
#
|
3284
3439
|
# @!attribute [rw] domain
|
@@ -3289,6 +3444,8 @@ module Aws::RDS
|
|
3289
3444
|
# For more information, see [ Kerberos Authentication][1] in the
|
3290
3445
|
# *Amazon RDS User Guide*.
|
3291
3446
|
#
|
3447
|
+
# This setting doesn't apply to RDS Custom.
|
3448
|
+
#
|
3292
3449
|
#
|
3293
3450
|
#
|
3294
3451
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -3307,12 +3464,14 @@ module Aws::RDS
|
|
3307
3464
|
#
|
3308
3465
|
# @!attribute [rw] monitoring_interval
|
3309
3466
|
# The interval, in seconds, between points when Enhanced Monitoring
|
3310
|
-
# metrics are collected for the DB instance. To disable
|
3467
|
+
# metrics are collected for the DB instance. To disable collection of
|
3311
3468
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
3312
3469
|
#
|
3313
|
-
# If `MonitoringRoleArn` is specified, then you must
|
3470
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
3314
3471
|
# `MonitoringInterval` to a value other than 0.
|
3315
3472
|
#
|
3473
|
+
# This setting doesn't apply to RDS Custom.
|
3474
|
+
#
|
3316
3475
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
3317
3476
|
# @return [Integer]
|
3318
3477
|
#
|
@@ -3320,12 +3479,14 @@ module Aws::RDS
|
|
3320
3479
|
# The ARN for the IAM role that permits RDS to send enhanced
|
3321
3480
|
# monitoring metrics to Amazon CloudWatch Logs. For example,
|
3322
3481
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on
|
3323
|
-
# creating a monitoring role,
|
3482
|
+
# creating a monitoring role, see [Setting Up and Enabling Enhanced
|
3324
3483
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
3325
3484
|
#
|
3326
3485
|
# If `MonitoringInterval` is set to a value other than 0, then you
|
3327
3486
|
# must supply a `MonitoringRoleArn` value.
|
3328
3487
|
#
|
3488
|
+
# This setting doesn't apply to RDS Custom.
|
3489
|
+
#
|
3329
3490
|
#
|
3330
3491
|
#
|
3331
3492
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
@@ -3334,6 +3495,8 @@ module Aws::RDS
|
|
3334
3495
|
# @!attribute [rw] domain_iam_role_name
|
3335
3496
|
# Specify the name of the IAM role to be used when making API calls to
|
3336
3497
|
# the Directory Service.
|
3498
|
+
#
|
3499
|
+
# This setting doesn't apply to RDS Custom.
|
3337
3500
|
# @return [String]
|
3338
3501
|
#
|
3339
3502
|
# @!attribute [rw] promotion_tier
|
@@ -3342,6 +3505,8 @@ module Aws::RDS
|
|
3342
3505
|
# primary instance. For more information, see [ Fault Tolerance for an
|
3343
3506
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
3344
3507
|
#
|
3508
|
+
# This setting doesn't apply to RDS Custom.
|
3509
|
+
#
|
3345
3510
|
# Default: 1
|
3346
3511
|
#
|
3347
3512
|
# Valid Values: 0 - 15
|
@@ -3365,9 +3530,9 @@ module Aws::RDS
|
|
3365
3530
|
# Services Identity and Access Management (IAM) accounts to database
|
3366
3531
|
# accounts. By default, mapping is disabled.
|
3367
3532
|
#
|
3368
|
-
# This setting doesn't apply to Amazon Aurora.
|
3369
|
-
# Services IAM accounts to database
|
3370
|
-
# cluster.
|
3533
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora. In
|
3534
|
+
# Aurora, mapping Amazon Web Services IAM accounts to database
|
3535
|
+
# accounts is managed by the DB cluster.
|
3371
3536
|
#
|
3372
3537
|
# For more information, see [ IAM Database Authentication for MySQL
|
3373
3538
|
# and PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -3379,10 +3544,10 @@ module Aws::RDS
|
|
3379
3544
|
#
|
3380
3545
|
# @!attribute [rw] enable_performance_insights
|
3381
3546
|
# A value that indicates whether to enable Performance Insights for
|
3382
|
-
# the DB instance.
|
3547
|
+
# the DB instance. For more information, see [Using Amazon Performance
|
3548
|
+
# Insights][1] in the *Amazon Relational Database Service User Guide*.
|
3383
3549
|
#
|
3384
|
-
#
|
3385
|
-
# the *Amazon Relational Database Service User Guide*.
|
3550
|
+
# This setting doesn't apply to RDS Custom.
|
3386
3551
|
#
|
3387
3552
|
#
|
3388
3553
|
#
|
@@ -3394,32 +3559,39 @@ module Aws::RDS
|
|
3394
3559
|
# Performance Insights data.
|
3395
3560
|
#
|
3396
3561
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3397
|
-
# alias ARN, or alias name for the
|
3398
|
-
# master key (CMK).
|
3562
|
+
# alias ARN, or alias name for the KMS key.
|
3399
3563
|
#
|
3400
3564
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
3401
|
-
# then Amazon RDS uses your default
|
3402
|
-
# your Amazon Web Services account. Your Amazon Web Services
|
3403
|
-
# has a different default
|
3565
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
3566
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
3567
|
+
# account has a different default KMS key for each Amazon Web Services
|
3568
|
+
# Region.
|
3569
|
+
#
|
3570
|
+
# This setting doesn't apply to RDS Custom.
|
3404
3571
|
# @return [String]
|
3405
3572
|
#
|
3406
3573
|
# @!attribute [rw] performance_insights_retention_period
|
3407
3574
|
# The amount of time, in days, to retain Performance Insights data.
|
3408
3575
|
# Valid values are 7 or 731 (2 years).
|
3576
|
+
#
|
3577
|
+
# This setting doesn't apply to RDS Custom.
|
3409
3578
|
# @return [Integer]
|
3410
3579
|
#
|
3411
3580
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
3412
3581
|
# The list of log types that need to be enabled for exporting to
|
3413
|
-
# CloudWatch Logs. The values in the list depend on the DB engine
|
3414
|
-
#
|
3415
|
-
#
|
3416
|
-
# Service User Guide*.
|
3582
|
+
# CloudWatch Logs. The values in the list depend on the DB engine. For
|
3583
|
+
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
3584
|
+
# Logs][1] in the *Amazon Relational Database Service User Guide*.
|
3417
3585
|
#
|
3418
3586
|
# **Amazon Aurora**
|
3419
3587
|
#
|
3420
3588
|
# Not applicable. CloudWatch Logs exports are managed by the DB
|
3421
3589
|
# cluster.
|
3422
3590
|
#
|
3591
|
+
# **RDS Custom**
|
3592
|
+
#
|
3593
|
+
# Not applicable.
|
3594
|
+
#
|
3423
3595
|
# **MariaDB**
|
3424
3596
|
#
|
3425
3597
|
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
@@ -3449,6 +3621,8 @@ module Aws::RDS
|
|
3449
3621
|
# @!attribute [rw] processor_features
|
3450
3622
|
# The number of CPU cores and the number of threads per core for the
|
3451
3623
|
# DB instance class of the DB instance.
|
3624
|
+
#
|
3625
|
+
# This setting doesn't apply to RDS Custom.
|
3452
3626
|
# @return [Array<Types::ProcessorFeature>]
|
3453
3627
|
#
|
3454
3628
|
# @!attribute [rw] deletion_protection
|
@@ -3477,6 +3651,8 @@ module Aws::RDS
|
|
3477
3651
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3478
3652
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3479
3653
|
#
|
3654
|
+
# This setting doesn't apply to RDS Custom.
|
3655
|
+
#
|
3480
3656
|
#
|
3481
3657
|
#
|
3482
3658
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -3505,6 +3681,44 @@ module Aws::RDS
|
|
3505
3681
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
3506
3682
|
# @return [Boolean]
|
3507
3683
|
#
|
3684
|
+
# @!attribute [rw] custom_iam_instance_profile
|
3685
|
+
# The instance profile associated with the underlying Amazon EC2
|
3686
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
3687
|
+
# meet the following requirements:
|
3688
|
+
#
|
3689
|
+
# * The profile must exist in your account.
|
3690
|
+
#
|
3691
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
3692
|
+
# to assume.
|
3693
|
+
#
|
3694
|
+
# * The instance profile name and the associated IAM role name must
|
3695
|
+
# start with the prefix `AWSRDSCustom`.
|
3696
|
+
#
|
3697
|
+
# For the list of permissions required for the IAM role, see [
|
3698
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
3699
|
+
# Service User Guide*.
|
3700
|
+
#
|
3701
|
+
# This setting is required for RDS Custom.
|
3702
|
+
#
|
3703
|
+
#
|
3704
|
+
#
|
3705
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
3706
|
+
# @return [String]
|
3707
|
+
#
|
3708
|
+
# @!attribute [rw] backup_target
|
3709
|
+
# Specifies where automated backups and manual snapshots are stored.
|
3710
|
+
#
|
3711
|
+
# Possible values are `outposts` (Amazon Web Services Outposts) and
|
3712
|
+
# `region` (Amazon Web Services Region). The default is `region`.
|
3713
|
+
#
|
3714
|
+
# For more information, see [Working with Amazon RDS on Amazon Web
|
3715
|
+
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
3716
|
+
#
|
3717
|
+
#
|
3718
|
+
#
|
3719
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
3720
|
+
# @return [String]
|
3721
|
+
#
|
3508
3722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
3509
3723
|
#
|
3510
3724
|
class CreateDBInstanceMessage < Struct.new(
|
@@ -3555,7 +3769,9 @@ module Aws::RDS
|
|
3555
3769
|
:processor_features,
|
3556
3770
|
:deletion_protection,
|
3557
3771
|
:max_allocated_storage,
|
3558
|
-
:enable_customer_owned_ip
|
3772
|
+
:enable_customer_owned_ip,
|
3773
|
+
:custom_iam_instance_profile,
|
3774
|
+
:backup_target)
|
3559
3775
|
SENSITIVE = []
|
3560
3776
|
include Aws::Structure
|
3561
3777
|
end
|
@@ -3606,6 +3822,7 @@ module Aws::RDS
|
|
3606
3822
|
# domain_iam_role_name: "String",
|
3607
3823
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
3608
3824
|
# max_allocated_storage: 1,
|
3825
|
+
# custom_iam_instance_profile: "String",
|
3609
3826
|
# source_region: "String",
|
3610
3827
|
# }
|
3611
3828
|
#
|
@@ -3649,8 +3866,8 @@ module Aws::RDS
|
|
3649
3866
|
# * If the source DB instance is in a different Amazon Web Services
|
3650
3867
|
# Region from the read replica, specify a valid DB instance ARN. For
|
3651
3868
|
# more information, see [Constructing an ARN for Amazon RDS][3] in
|
3652
|
-
# the *Amazon RDS User Guide*. This doesn't apply to SQL Server
|
3653
|
-
# which
|
3869
|
+
# the *Amazon RDS User Guide*. This doesn't apply to SQL Server or
|
3870
|
+
# RDS Custom, which don't support cross-Region replicas.
|
3654
3871
|
#
|
3655
3872
|
#
|
3656
3873
|
#
|
@@ -3699,12 +3916,16 @@ module Aws::RDS
|
|
3699
3916
|
# support for the replica. Creating your read replica as a Multi-AZ DB
|
3700
3917
|
# instance is independent of whether the source database is a Multi-AZ
|
3701
3918
|
# DB instance.
|
3919
|
+
#
|
3920
|
+
# This setting doesn't apply to RDS Custom.
|
3702
3921
|
# @return [Boolean]
|
3703
3922
|
#
|
3704
3923
|
# @!attribute [rw] auto_minor_version_upgrade
|
3705
3924
|
# A value that indicates whether minor engine upgrades are applied
|
3706
3925
|
# automatically to the read replica during the maintenance window.
|
3707
3926
|
#
|
3927
|
+
# This setting doesn't apply to RDS Custom.
|
3928
|
+
#
|
3708
3929
|
# Default: Inherits from the source DB instance
|
3709
3930
|
# @return [Boolean]
|
3710
3931
|
#
|
@@ -3721,6 +3942,8 @@ module Aws::RDS
|
|
3721
3942
|
# source instance.
|
3722
3943
|
#
|
3723
3944
|
# </note>
|
3945
|
+
#
|
3946
|
+
# This setting doesn't apply to RDS Custom.
|
3724
3947
|
# @return [String]
|
3725
3948
|
#
|
3726
3949
|
# @!attribute [rw] db_parameter_group_name
|
@@ -3732,10 +3955,8 @@ module Aws::RDS
|
|
3732
3955
|
# same region read replica, or the default `DBParameterGroup` for the
|
3733
3956
|
# specified DB engine for a cross region read replica.
|
3734
3957
|
#
|
3735
|
-
#
|
3736
|
-
#
|
3737
|
-
#
|
3738
|
-
# </note>
|
3958
|
+
# Specifying a parameter group for this operation is only supported
|
3959
|
+
# for Oracle DB instances. It isn't supported for RDS Custom.
|
3739
3960
|
#
|
3740
3961
|
# Constraints:
|
3741
3962
|
#
|
@@ -3801,9 +4022,11 @@ module Aws::RDS
|
|
3801
4022
|
# @return [String]
|
3802
4023
|
#
|
3803
4024
|
# @!attribute [rw] vpc_security_group_ids
|
3804
|
-
# A list of EC2 VPC security groups to associate with the read
|
4025
|
+
# A list of Amazon EC2 VPC security groups to associate with the read
|
3805
4026
|
# replica.
|
3806
4027
|
#
|
4028
|
+
# This setting doesn't apply to RDS Custom.
|
4029
|
+
#
|
3807
4030
|
# Default: The default EC2 VPC security group for the DB subnet
|
3808
4031
|
# group's VPC.
|
3809
4032
|
# @return [Array<String>]
|
@@ -3833,6 +4056,8 @@ module Aws::RDS
|
|
3833
4056
|
# If `MonitoringRoleArn` is specified, then you must also set
|
3834
4057
|
# `MonitoringInterval` to a value other than 0.
|
3835
4058
|
#
|
4059
|
+
# This setting doesn't apply to RDS Custom.
|
4060
|
+
#
|
3836
4061
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
3837
4062
|
# @return [Integer]
|
3838
4063
|
#
|
@@ -3846,6 +4071,8 @@ module Aws::RDS
|
|
3846
4071
|
# If `MonitoringInterval` is set to a value other than 0, then you
|
3847
4072
|
# must supply a `MonitoringRoleArn` value.
|
3848
4073
|
#
|
4074
|
+
# This setting doesn't apply to RDS Custom.
|
4075
|
+
#
|
3849
4076
|
#
|
3850
4077
|
#
|
3851
4078
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
@@ -3856,23 +4083,26 @@ module Aws::RDS
|
|
3856
4083
|
# replica.
|
3857
4084
|
#
|
3858
4085
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3859
|
-
# alias ARN, or alias name for the
|
4086
|
+
# alias ARN, or alias name for the KMS key.
|
3860
4087
|
#
|
3861
4088
|
# If you create an encrypted read replica in the same Amazon Web
|
3862
4089
|
# Services Region as the source DB instance, then do not specify a
|
3863
|
-
# value for this parameter. A read replica in the same
|
3864
|
-
# always encrypted with the same
|
4090
|
+
# value for this parameter. A read replica in the same Amazon Web
|
4091
|
+
# Services Region is always encrypted with the same KMS key as the
|
3865
4092
|
# source DB instance.
|
3866
4093
|
#
|
3867
4094
|
# If you create an encrypted read replica in a different Amazon Web
|
3868
|
-
# Services Region, then you must specify a
|
3869
|
-
#
|
3870
|
-
# Web Services
|
3871
|
-
#
|
3872
|
-
# Web Services Region
|
4095
|
+
# Services Region, then you must specify a KMS key identifier for the
|
4096
|
+
# destination Amazon Web Services Region. KMS keys are specific to the
|
4097
|
+
# Amazon Web Services Region that they are created in, and you can't
|
4098
|
+
# use KMS keys from one Amazon Web Services Region in another Amazon
|
4099
|
+
# Web Services Region.
|
3873
4100
|
#
|
3874
4101
|
# You can't create an encrypted read replica from an unencrypted DB
|
3875
4102
|
# instance.
|
4103
|
+
#
|
4104
|
+
# This setting doesn't apply to RDS Custom, which uses the same KMS
|
4105
|
+
# key as the primary replica.
|
3876
4106
|
# @return [String]
|
3877
4107
|
#
|
3878
4108
|
# @!attribute [rw] pre_signed_url
|
@@ -3939,6 +4169,8 @@ module Aws::RDS
|
|
3939
4169
|
#
|
3940
4170
|
# </note>
|
3941
4171
|
#
|
4172
|
+
# This setting doesn't apply to RDS Custom.
|
4173
|
+
#
|
3942
4174
|
#
|
3943
4175
|
#
|
3944
4176
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -3954,6 +4186,8 @@ module Aws::RDS
|
|
3954
4186
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
3955
4187
|
# RDS User Guide.*
|
3956
4188
|
#
|
4189
|
+
# This setting doesn't apply to RDS Custom.
|
4190
|
+
#
|
3957
4191
|
#
|
3958
4192
|
#
|
3959
4193
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -3966,6 +4200,8 @@ module Aws::RDS
|
|
3966
4200
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3967
4201
|
# the *Amazon RDS User Guide*.
|
3968
4202
|
#
|
4203
|
+
# This setting doesn't apply to RDS Custom.
|
4204
|
+
#
|
3969
4205
|
#
|
3970
4206
|
#
|
3971
4207
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -3976,18 +4212,22 @@ module Aws::RDS
|
|
3976
4212
|
# Performance Insights data.
|
3977
4213
|
#
|
3978
4214
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3979
|
-
# alias ARN, or alias name for the
|
3980
|
-
# master key (CMK).
|
4215
|
+
# alias ARN, or alias name for the KMS key.
|
3981
4216
|
#
|
3982
4217
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
3983
|
-
# then Amazon RDS uses your default
|
3984
|
-
# your Amazon Web Services account. Your Amazon Web Services
|
3985
|
-
# has a different default
|
4218
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
4219
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
4220
|
+
# account has a different default KMS key for each Amazon Web Services
|
4221
|
+
# Region.
|
4222
|
+
#
|
4223
|
+
# This setting doesn't apply to RDS Custom.
|
3986
4224
|
# @return [String]
|
3987
4225
|
#
|
3988
4226
|
# @!attribute [rw] performance_insights_retention_period
|
3989
4227
|
# The amount of time, in days, to retain Performance Insights data.
|
3990
4228
|
# Valid values are 7 or 731 (2 years).
|
4229
|
+
#
|
4230
|
+
# This setting doesn't apply to RDS Custom.
|
3991
4231
|
# @return [Integer]
|
3992
4232
|
#
|
3993
4233
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -3996,6 +4236,8 @@ module Aws::RDS
|
|
3996
4236
|
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
3997
4237
|
# Logs ][1] in the *Amazon RDS User Guide*.
|
3998
4238
|
#
|
4239
|
+
# This setting doesn't apply to RDS Custom.
|
4240
|
+
#
|
3999
4241
|
#
|
4000
4242
|
#
|
4001
4243
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -4004,11 +4246,15 @@ module Aws::RDS
|
|
4004
4246
|
# @!attribute [rw] processor_features
|
4005
4247
|
# The number of CPU cores and the number of threads per core for the
|
4006
4248
|
# DB instance class of the DB instance.
|
4249
|
+
#
|
4250
|
+
# This setting doesn't apply to RDS Custom.
|
4007
4251
|
# @return [Array<Types::ProcessorFeature>]
|
4008
4252
|
#
|
4009
4253
|
# @!attribute [rw] use_default_processor_features
|
4010
4254
|
# A value that indicates whether the DB instance class of the DB
|
4011
4255
|
# instance uses its default processor features.
|
4256
|
+
#
|
4257
|
+
# This setting doesn't apply to RDS Custom.
|
4012
4258
|
# @return [Boolean]
|
4013
4259
|
#
|
4014
4260
|
# @!attribute [rw] deletion_protection
|
@@ -4030,6 +4276,8 @@ module Aws::RDS
|
|
4030
4276
|
# For more information, see [ Kerberos Authentication][1] in the
|
4031
4277
|
# *Amazon RDS User Guide*.
|
4032
4278
|
#
|
4279
|
+
# This setting doesn't apply to RDS Custom.
|
4280
|
+
#
|
4033
4281
|
#
|
4034
4282
|
#
|
4035
4283
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -4038,6 +4286,8 @@ module Aws::RDS
|
|
4038
4286
|
# @!attribute [rw] domain_iam_role_name
|
4039
4287
|
# Specify the name of the IAM role to be used when making API calls to
|
4040
4288
|
# the Directory Service.
|
4289
|
+
#
|
4290
|
+
# This setting doesn't apply to RDS Custom.
|
4041
4291
|
# @return [String]
|
4042
4292
|
#
|
4043
4293
|
# @!attribute [rw] replica_mode
|
@@ -4047,18 +4297,22 @@ module Aws::RDS
|
|
4047
4297
|
#
|
4048
4298
|
# </note>
|
4049
4299
|
#
|
4050
|
-
# Mounted DB replicas are included in Oracle Enterprise
|
4051
|
-
# main use case for mounted replicas is cross-Region
|
4052
|
-
# recovery. The primary database doesn't use Active Data
|
4053
|
-
# transmit information to the mounted replica. Because it
|
4054
|
-
# accept user connections, a mounted replica can't serve a
|
4055
|
-
# workload.
|
4300
|
+
# Mounted DB replicas are included in Oracle Database Enterprise
|
4301
|
+
# Edition. The main use case for mounted replicas is cross-Region
|
4302
|
+
# disaster recovery. The primary database doesn't use Active Data
|
4303
|
+
# Guard to transmit information to the mounted replica. Because it
|
4304
|
+
# doesn't accept user connections, a mounted replica can't serve a
|
4305
|
+
# read-only workload.
|
4056
4306
|
#
|
4057
4307
|
# You can create a combination of mounted and read-only DB replicas
|
4058
4308
|
# for the same primary DB instance. For more information, see [Working
|
4059
4309
|
# with Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
|
4060
4310
|
# Guide*.
|
4061
4311
|
#
|
4312
|
+
# For RDS Custom, you must specify this parameter and set it to
|
4313
|
+
# `mounted`. The value won't be set by default. After replica
|
4314
|
+
# creation, you can manage the open mode manually.
|
4315
|
+
#
|
4062
4316
|
#
|
4063
4317
|
#
|
4064
4318
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -4077,6 +4331,30 @@ module Aws::RDS
|
|
4077
4331
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
4078
4332
|
# @return [Integer]
|
4079
4333
|
#
|
4334
|
+
# @!attribute [rw] custom_iam_instance_profile
|
4335
|
+
# The instance profile associated with the underlying Amazon EC2
|
4336
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
4337
|
+
# meet the following requirements:
|
4338
|
+
#
|
4339
|
+
# * The profile must exist in your account.
|
4340
|
+
#
|
4341
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
4342
|
+
# to assume.
|
4343
|
+
#
|
4344
|
+
# * The instance profile name and the associated IAM role name must
|
4345
|
+
# start with the prefix `AWSRDSCustom`.
|
4346
|
+
#
|
4347
|
+
# For the list of permissions required for the IAM role, see [
|
4348
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
4349
|
+
# Service User Guide*.
|
4350
|
+
#
|
4351
|
+
# This setting is required for RDS Custom.
|
4352
|
+
#
|
4353
|
+
#
|
4354
|
+
#
|
4355
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
4356
|
+
# @return [String]
|
4357
|
+
#
|
4080
4358
|
# @!attribute [rw] source_region
|
4081
4359
|
# The source region of the snapshot. This is only needed when the
|
4082
4360
|
# shapshot is encrypted and in a different region.
|
@@ -4117,6 +4395,7 @@ module Aws::RDS
|
|
4117
4395
|
:domain_iam_role_name,
|
4118
4396
|
:replica_mode,
|
4119
4397
|
:max_allocated_storage,
|
4398
|
+
:custom_iam_instance_profile,
|
4120
4399
|
:source_region)
|
4121
4400
|
SENSITIVE = []
|
4122
4401
|
include Aws::Structure
|
@@ -5044,6 +5323,24 @@ module Aws::RDS
|
|
5044
5323
|
#
|
5045
5324
|
class CustomAvailabilityZoneQuotaExceededFault < Aws::EmptyStructure; end
|
5046
5325
|
|
5326
|
+
# A CEV with the specified name already exists.
|
5327
|
+
#
|
5328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionAlreadyExistsFault AWS API Documentation
|
5329
|
+
#
|
5330
|
+
class CustomDBEngineVersionAlreadyExistsFault < Aws::EmptyStructure; end
|
5331
|
+
|
5332
|
+
# The specified CEV was not found.
|
5333
|
+
#
|
5334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionNotFoundFault AWS API Documentation
|
5335
|
+
#
|
5336
|
+
class CustomDBEngineVersionNotFoundFault < Aws::EmptyStructure; end
|
5337
|
+
|
5338
|
+
# You have exceeded your CEV quota.
|
5339
|
+
#
|
5340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionQuotaExceededFault AWS API Documentation
|
5341
|
+
#
|
5342
|
+
class CustomDBEngineVersionQuotaExceededFault < Aws::EmptyStructure; end
|
5343
|
+
|
5047
5344
|
# Contains the details of an Amazon Aurora DB cluster.
|
5048
5345
|
#
|
5049
5346
|
# This data type is used as a response element in the
|
@@ -5211,15 +5508,14 @@ module Aws::RDS
|
|
5211
5508
|
# identifier for the encrypted DB cluster.
|
5212
5509
|
#
|
5213
5510
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
5214
|
-
# alias ARN, or alias name for the
|
5215
|
-
# master key (CMK).
|
5511
|
+
# alias ARN, or alias name for the KMS key.
|
5216
5512
|
# @return [String]
|
5217
5513
|
#
|
5218
5514
|
# @!attribute [rw] db_cluster_resource_id
|
5219
5515
|
# The Amazon Web Services Region-unique, immutable identifier for the
|
5220
5516
|
# DB cluster. This identifier is found in Amazon Web Services
|
5221
|
-
# CloudTrail log entries whenever the
|
5222
|
-
#
|
5517
|
+
# CloudTrail log entries whenever the KMS key for the DB cluster is
|
5518
|
+
# accessed.
|
5223
5519
|
# @return [String]
|
5224
5520
|
#
|
5225
5521
|
# @!attribute [rw] db_cluster_arn
|
@@ -5348,8 +5644,7 @@ module Aws::RDS
|
|
5348
5644
|
# messages in the database activity stream.
|
5349
5645
|
#
|
5350
5646
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
5351
|
-
# alias ARN, or alias name for the
|
5352
|
-
# master key (CMK).
|
5647
|
+
# alias ARN, or alias name for the KMS key.
|
5353
5648
|
# @return [String]
|
5354
5649
|
#
|
5355
5650
|
# @!attribute [rw] activity_stream_kinesis_stream_name
|
@@ -5937,8 +6232,8 @@ module Aws::RDS
|
|
5937
6232
|
#
|
5938
6233
|
# @!attribute [rw] feature_name
|
5939
6234
|
# The name of the feature associated with the Amazon Web Services
|
5940
|
-
# Identity and Access Management (IAM) role. For
|
5941
|
-
# feature names, see DBEngineVersion.
|
6235
|
+
# Identity and Access Management (IAM) role. For information about
|
6236
|
+
# supported feature names, see DBEngineVersion.
|
5942
6237
|
# @return [String]
|
5943
6238
|
#
|
5944
6239
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBClusterRole AWS API Documentation
|
@@ -6059,8 +6354,7 @@ module Aws::RDS
|
|
6059
6354
|
# identifier for the encrypted DB cluster snapshot.
|
6060
6355
|
#
|
6061
6356
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
6062
|
-
# alias ARN, or alias name for the
|
6063
|
-
# master key (CMK).
|
6357
|
+
# alias ARN, or alias name for the KMS key.
|
6064
6358
|
# @return [String]
|
6065
6359
|
#
|
6066
6360
|
# @!attribute [rw] db_cluster_snapshot_arn
|
@@ -6287,12 +6581,24 @@ module Aws::RDS
|
|
6287
6581
|
# @return [Array<String>]
|
6288
6582
|
#
|
6289
6583
|
# @!attribute [rw] supported_feature_names
|
6290
|
-
# A list of features supported by the DB engine.
|
6291
|
-
# names include the following.
|
6584
|
+
# A list of features supported by the DB engine.
|
6292
6585
|
#
|
6293
|
-
#
|
6586
|
+
# The supported features vary by DB engine and DB engine version.
|
6294
6587
|
#
|
6295
|
-
#
|
6588
|
+
# To determine the supported features for a specific DB engine and DB
|
6589
|
+
# engine version using the CLI, use the following command:
|
6590
|
+
#
|
6591
|
+
# `aws rds describe-db-engine-versions --engine <engine_name>
|
6592
|
+
# --engine-version <engine_version>`
|
6593
|
+
#
|
6594
|
+
# For example, to determine the supported features for RDS for
|
6595
|
+
# PostgreSQL version 13.3 using the CLI, use the following command:
|
6596
|
+
#
|
6597
|
+
# `aws rds describe-db-engine-versions --engine postgres
|
6598
|
+
# --engine-version 13.3`
|
6599
|
+
#
|
6600
|
+
# The supported features are listed under `SupportedFeatureNames` in
|
6601
|
+
# the output.
|
6296
6602
|
# @return [Array<String>]
|
6297
6603
|
#
|
6298
6604
|
# @!attribute [rw] status
|
@@ -6310,6 +6616,43 @@ module Aws::RDS
|
|
6310
6616
|
# with a specific DB engine version.
|
6311
6617
|
# @return [Boolean]
|
6312
6618
|
#
|
6619
|
+
# @!attribute [rw] major_engine_version
|
6620
|
+
# The major engine version of the CEV.
|
6621
|
+
# @return [String]
|
6622
|
+
#
|
6623
|
+
# @!attribute [rw] database_installation_files_s3_bucket_name
|
6624
|
+
# The name of the Amazon S3 bucket that contains your database
|
6625
|
+
# installation files.
|
6626
|
+
# @return [String]
|
6627
|
+
#
|
6628
|
+
# @!attribute [rw] database_installation_files_s3_prefix
|
6629
|
+
# The Amazon S3 directory that contains the database installation
|
6630
|
+
# files. If not specified, then no prefix is assumed.
|
6631
|
+
# @return [String]
|
6632
|
+
#
|
6633
|
+
# @!attribute [rw] db_engine_version_arn
|
6634
|
+
# The ARN of the custom engine version.
|
6635
|
+
# @return [String]
|
6636
|
+
#
|
6637
|
+
# @!attribute [rw] kms_key_id
|
6638
|
+
# The Amazon Web Services KMS key identifier for an encrypted CEV.
|
6639
|
+
# This parameter is required for RDS Custom, but optional for Amazon
|
6640
|
+
# RDS.
|
6641
|
+
# @return [String]
|
6642
|
+
#
|
6643
|
+
# @!attribute [rw] create_time
|
6644
|
+
# The creation time of the DB engine version.
|
6645
|
+
# @return [Time]
|
6646
|
+
#
|
6647
|
+
# @!attribute [rw] tag_list
|
6648
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
6649
|
+
# Resources][1] in the *Amazon RDS User Guide.*
|
6650
|
+
#
|
6651
|
+
#
|
6652
|
+
#
|
6653
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
6654
|
+
# @return [Array<Types::Tag>]
|
6655
|
+
#
|
6313
6656
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBEngineVersion AWS API Documentation
|
6314
6657
|
#
|
6315
6658
|
class DBEngineVersion < Struct.new(
|
@@ -6330,7 +6673,14 @@ module Aws::RDS
|
|
6330
6673
|
:supported_feature_names,
|
6331
6674
|
:status,
|
6332
6675
|
:supports_parallel_query,
|
6333
|
-
:supports_global_databases
|
6676
|
+
:supports_global_databases,
|
6677
|
+
:major_engine_version,
|
6678
|
+
:database_installation_files_s3_bucket_name,
|
6679
|
+
:database_installation_files_s3_prefix,
|
6680
|
+
:db_engine_version_arn,
|
6681
|
+
:kms_key_id,
|
6682
|
+
:create_time,
|
6683
|
+
:tag_list)
|
6334
6684
|
SENSITIVE = []
|
6335
6685
|
include Aws::Structure
|
6336
6686
|
end
|
@@ -6486,7 +6836,8 @@ module Aws::RDS
|
|
6486
6836
|
# @return [Time]
|
6487
6837
|
#
|
6488
6838
|
# @!attribute [rw] multi_az
|
6489
|
-
# Specifies if the DB instance is a Multi-AZ deployment.
|
6839
|
+
# Specifies if the DB instance is a Multi-AZ deployment. This setting
|
6840
|
+
# doesn't apply to RDS Custom.
|
6490
6841
|
# @return [Boolean]
|
6491
6842
|
#
|
6492
6843
|
# @!attribute [rw] engine_version
|
@@ -6537,7 +6888,8 @@ module Aws::RDS
|
|
6537
6888
|
# @return [String]
|
6538
6889
|
#
|
6539
6890
|
# @!attribute [rw] license_model
|
6540
|
-
# License model information for this DB instance.
|
6891
|
+
# License model information for this DB instance. This setting
|
6892
|
+
# doesn't apply to RDS Custom.
|
6541
6893
|
# @return [String]
|
6542
6894
|
#
|
6543
6895
|
# @!attribute [rw] iops
|
@@ -6614,15 +6966,14 @@ module Aws::RDS
|
|
6614
6966
|
# identifier for the encrypted DB instance.
|
6615
6967
|
#
|
6616
6968
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
6617
|
-
# alias ARN, or alias name for the
|
6618
|
-
# master key (CMK).
|
6969
|
+
# alias ARN, or alias name for the KMS key.
|
6619
6970
|
# @return [String]
|
6620
6971
|
#
|
6621
6972
|
# @!attribute [rw] dbi_resource_id
|
6622
6973
|
# The Amazon Web Services Region-unique, immutable identifier for the
|
6623
6974
|
# DB instance. This identifier is found in Amazon Web Services
|
6624
|
-
# CloudTrail log entries whenever the Amazon Web Services KMS
|
6625
|
-
#
|
6975
|
+
# CloudTrail log entries whenever the Amazon Web Services KMS key for
|
6976
|
+
# the DB instance is accessed.
|
6626
6977
|
# @return [String]
|
6627
6978
|
#
|
6628
6979
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -6708,8 +7059,7 @@ module Aws::RDS
|
|
6708
7059
|
# Performance Insights data.
|
6709
7060
|
#
|
6710
7061
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
6711
|
-
# alias ARN, or alias name for the
|
6712
|
-
# master key (CMK).
|
7062
|
+
# alias ARN, or alias name for the KMS key.
|
6713
7063
|
# @return [String]
|
6714
7064
|
#
|
6715
7065
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -6809,7 +7159,7 @@ module Aws::RDS
|
|
6809
7159
|
# The Amazon Web Services KMS key identifier used for encrypting
|
6810
7160
|
# messages in the database activity stream. The Amazon Web Services
|
6811
7161
|
# KMS key identifier is the key ARN, key ID, alias ARN, or alias name
|
6812
|
-
# for the
|
7162
|
+
# for the KMS key.
|
6813
7163
|
# @return [String]
|
6814
7164
|
#
|
6815
7165
|
# @!attribute [rw] activity_stream_kinesis_stream_name
|
@@ -6828,6 +7178,46 @@ module Aws::RDS
|
|
6828
7178
|
# database activity stream.
|
6829
7179
|
# @return [Boolean]
|
6830
7180
|
#
|
7181
|
+
# @!attribute [rw] automation_mode
|
7182
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
7183
|
+
# paused`. If `full`, the DB instance automates monitoring and
|
7184
|
+
# instance recovery. If `all paused`, the instance pauses automation
|
7185
|
+
# for the duration set by `--resume-full-automation-mode-minutes`.
|
7186
|
+
# @return [String]
|
7187
|
+
#
|
7188
|
+
# @!attribute [rw] resume_full_automation_mode_time
|
7189
|
+
# The number of minutes to pause the automation. When the time period
|
7190
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
7191
|
+
# (default). The maximum value is 1,440.
|
7192
|
+
# @return [Time]
|
7193
|
+
#
|
7194
|
+
# @!attribute [rw] custom_iam_instance_profile
|
7195
|
+
# The instance profile associated with the underlying Amazon EC2
|
7196
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
7197
|
+
# meet the following requirements:
|
7198
|
+
#
|
7199
|
+
# * The profile must exist in your account.
|
7200
|
+
#
|
7201
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
7202
|
+
# to assume.
|
7203
|
+
#
|
7204
|
+
# * The instance profile name and the associated IAM role name must
|
7205
|
+
# start with the prefix `AWSRDSCustom`.
|
7206
|
+
#
|
7207
|
+
# For the list of permissions required for the IAM role, see [
|
7208
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
7209
|
+
# Service User Guide*.
|
7210
|
+
#
|
7211
|
+
#
|
7212
|
+
#
|
7213
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
7214
|
+
# @return [String]
|
7215
|
+
#
|
7216
|
+
# @!attribute [rw] backup_target
|
7217
|
+
# Specifies where automated backups and manual snapshots are stored:
|
7218
|
+
# Amazon Web Services Outposts or the Amazon Web Services Region.
|
7219
|
+
# @return [String]
|
7220
|
+
#
|
6831
7221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
|
6832
7222
|
#
|
6833
7223
|
class DBInstance < Struct.new(
|
@@ -6900,7 +7290,11 @@ module Aws::RDS
|
|
6900
7290
|
:activity_stream_kms_key_id,
|
6901
7291
|
:activity_stream_kinesis_stream_name,
|
6902
7292
|
:activity_stream_mode,
|
6903
|
-
:activity_stream_engine_native_audit_fields_included
|
7293
|
+
:activity_stream_engine_native_audit_fields_included,
|
7294
|
+
:automation_mode,
|
7295
|
+
:resume_full_automation_mode_time,
|
7296
|
+
:custom_iam_instance_profile,
|
7297
|
+
:backup_target)
|
6904
7298
|
SENSITIVE = []
|
6905
7299
|
include Aws::Structure
|
6906
7300
|
end
|
@@ -7020,8 +7414,7 @@ module Aws::RDS
|
|
7020
7414
|
# The Amazon Web Services KMS key ID for an automated backup.
|
7021
7415
|
#
|
7022
7416
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
7023
|
-
# alias ARN, or alias name for the
|
7024
|
-
# master key (CMK).
|
7417
|
+
# alias ARN, or alias name for the KMS key.
|
7025
7418
|
# @return [String]
|
7026
7419
|
#
|
7027
7420
|
# @!attribute [rw] timezone
|
@@ -7049,6 +7442,11 @@ module Aws::RDS
|
|
7049
7442
|
# associated with the automated backup.
|
7050
7443
|
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
7051
7444
|
#
|
7445
|
+
# @!attribute [rw] backup_target
|
7446
|
+
# Specifies where automated backups are stored: Amazon Web Services
|
7447
|
+
# Outposts or the Amazon Web Services Region.
|
7448
|
+
# @return [String]
|
7449
|
+
#
|
7052
7450
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceAutomatedBackup AWS API Documentation
|
7053
7451
|
#
|
7054
7452
|
class DBInstanceAutomatedBackup < Struct.new(
|
@@ -7077,7 +7475,8 @@ module Aws::RDS
|
|
7077
7475
|
:iam_database_authentication_enabled,
|
7078
7476
|
:backup_retention_period,
|
7079
7477
|
:db_instance_automated_backups_arn,
|
7080
|
-
:db_instance_automated_backups_replications
|
7478
|
+
:db_instance_automated_backups_replications,
|
7479
|
+
:backup_target)
|
7081
7480
|
SENSITIVE = []
|
7082
7481
|
include Aws::Structure
|
7083
7482
|
end
|
@@ -7172,8 +7571,8 @@ module Aws::RDS
|
|
7172
7571
|
#
|
7173
7572
|
# @!attribute [rw] feature_name
|
7174
7573
|
# The name of the feature associated with the Amazon Web Services
|
7175
|
-
# Identity and Access Management (IAM) role. For
|
7176
|
-
# feature names, see `DBEngineVersion`.
|
7574
|
+
# Identity and Access Management (IAM) role. For information about
|
7575
|
+
# supported feature names, see `DBEngineVersion`.
|
7177
7576
|
# @return [String]
|
7178
7577
|
#
|
7179
7578
|
# @!attribute [rw] status
|
@@ -8027,8 +8426,7 @@ module Aws::RDS
|
|
8027
8426
|
# for the encrypted DB snapshot.
|
8028
8427
|
#
|
8029
8428
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
8030
|
-
# alias ARN, or alias name for the
|
8031
|
-
# master key (CMK).
|
8429
|
+
# alias ARN, or alias name for the KMS key.
|
8032
8430
|
# @return [String]
|
8033
8431
|
#
|
8034
8432
|
# @!attribute [rw] db_snapshot_arn
|
@@ -8073,6 +8471,11 @@ module Aws::RDS
|
|
8073
8471
|
# Universal Time (UTC). Doesn't change when the snapshot is copied.
|
8074
8472
|
# @return [Time]
|
8075
8473
|
#
|
8474
|
+
# @!attribute [rw] snapshot_target
|
8475
|
+
# Specifies where manual snapshots are stored: Amazon Web Services
|
8476
|
+
# Outposts or the Amazon Web Services Region.
|
8477
|
+
# @return [String]
|
8478
|
+
#
|
8076
8479
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSnapshot AWS API Documentation
|
8077
8480
|
#
|
8078
8481
|
class DBSnapshot < Struct.new(
|
@@ -8105,7 +8508,8 @@ module Aws::RDS
|
|
8105
8508
|
:processor_features,
|
8106
8509
|
:dbi_resource_id,
|
8107
8510
|
:tag_list,
|
8108
|
-
:original_snapshot_create_time
|
8511
|
+
:original_snapshot_create_time,
|
8512
|
+
:snapshot_target)
|
8109
8513
|
SENSITIVE = []
|
8110
8514
|
include Aws::Structure
|
8111
8515
|
end
|
@@ -8353,6 +8757,35 @@ module Aws::RDS
|
|
8353
8757
|
include Aws::Structure
|
8354
8758
|
end
|
8355
8759
|
|
8760
|
+
# @note When making an API call, you may pass DeleteCustomDBEngineVersionMessage
|
8761
|
+
# data as a hash:
|
8762
|
+
#
|
8763
|
+
# {
|
8764
|
+
# engine: "CustomEngineName", # required
|
8765
|
+
# engine_version: "CustomEngineVersion", # required
|
8766
|
+
# }
|
8767
|
+
#
|
8768
|
+
# @!attribute [rw] engine
|
8769
|
+
# The database engine. The only supported engine is
|
8770
|
+
# `custom-oracle-ee`.
|
8771
|
+
# @return [String]
|
8772
|
+
#
|
8773
|
+
# @!attribute [rw] engine_version
|
8774
|
+
# The custom engine version (CEV) for your DB instance. This option is
|
8775
|
+
# required for RDS Custom, but optional for Amazon RDS. The
|
8776
|
+
# combination of `Engine` and `EngineVersion` is unique per customer
|
8777
|
+
# per Amazon Web Services Region.
|
8778
|
+
# @return [String]
|
8779
|
+
#
|
8780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteCustomDBEngineVersionMessage AWS API Documentation
|
8781
|
+
#
|
8782
|
+
class DeleteCustomDBEngineVersionMessage < Struct.new(
|
8783
|
+
:engine,
|
8784
|
+
:engine_version)
|
8785
|
+
SENSITIVE = []
|
8786
|
+
include Aws::Structure
|
8787
|
+
end
|
8788
|
+
|
8356
8789
|
# @note When making an API call, you may pass DeleteDBClusterEndpointMessage
|
8357
8790
|
# data as a hash:
|
8358
8791
|
#
|
@@ -8534,6 +8967,8 @@ module Aws::RDS
|
|
8534
8967
|
# The Amazon Resource Name (ARN) of the automated backups to delete,
|
8535
8968
|
# for example,
|
8536
8969
|
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
8970
|
+
#
|
8971
|
+
# This setting doesn't apply to RDS Custom.
|
8537
8972
|
# @return [String]
|
8538
8973
|
#
|
8539
8974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackupMessage AWS API Documentation
|
@@ -8582,32 +9017,38 @@ module Aws::RDS
|
|
8582
9017
|
#
|
8583
9018
|
# @!attribute [rw] skip_final_snapshot
|
8584
9019
|
# A value that indicates whether to skip the creation of a final DB
|
8585
|
-
# snapshot before the
|
8586
|
-
# DB snapshot
|
8587
|
-
#
|
8588
|
-
#
|
9020
|
+
# snapshot before deleting the instance. If you enable this parameter,
|
9021
|
+
# RDS doesn't create a DB snapshot. If you don't enable this
|
9022
|
+
# parameter, RDS creates a DB snapshot before the DB instance is
|
9023
|
+
# deleted. By default, skip isn't enabled, and the DB snapshot is
|
9024
|
+
# created.
|
8589
9025
|
#
|
8590
|
-
#
|
8591
|
-
#
|
8592
|
-
# it can only be deleted when skip is specified.
|
9026
|
+
# <note markdown="1"> If you don't enable this parameter, you must specify the
|
9027
|
+
# `FinalDBSnapshotIdentifier` parameter.
|
8593
9028
|
#
|
8594
|
-
#
|
9029
|
+
# </note>
|
8595
9030
|
#
|
8596
|
-
#
|
8597
|
-
#
|
9031
|
+
# When a DB instance is in a failure state and has a status of
|
9032
|
+
# `failed`, `incompatible-restore`, or `incompatible-network`, RDS can
|
9033
|
+
# delete the instance only if you enable this parameter.
|
8598
9034
|
#
|
8599
|
-
#
|
9035
|
+
# If you delete a read replica or an RDS Custom instance, you must
|
9036
|
+
# enable this setting.
|
9037
|
+
#
|
9038
|
+
# This setting is required for RDS Custom.
|
8600
9039
|
# @return [Boolean]
|
8601
9040
|
#
|
8602
9041
|
# @!attribute [rw] final_db_snapshot_identifier
|
8603
9042
|
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
8604
9043
|
# `SkipFinalSnapshot` parameter is disabled.
|
8605
9044
|
#
|
8606
|
-
# <note markdown="1">
|
8607
|
-
#
|
9045
|
+
# <note markdown="1"> If you enable this parameter and also enable SkipFinalShapshot, the
|
9046
|
+
# command results in an error.
|
8608
9047
|
#
|
8609
9048
|
# </note>
|
8610
9049
|
#
|
9050
|
+
# This setting doesn't apply to RDS Custom.
|
9051
|
+
#
|
8611
9052
|
# Constraints:
|
8612
9053
|
#
|
8613
9054
|
# * Must be 1 to 255 letters or numbers.
|
@@ -9790,6 +10231,10 @@ module Aws::RDS
|
|
9790
10231
|
# If this parameter is enabled and the requested engine supports the
|
9791
10232
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
9792
10233
|
# includes a list of supported character sets for each engine version.
|
10234
|
+
#
|
10235
|
+
# For RDS Custom, the default is not to list supported character sets.
|
10236
|
+
# If you set `ListSupportedCharacterSets` to `true`, RDS Custom
|
10237
|
+
# returns no results.
|
9793
10238
|
# @return [Boolean]
|
9794
10239
|
#
|
9795
10240
|
# @!attribute [rw] list_supported_timezones
|
@@ -9799,6 +10244,10 @@ module Aws::RDS
|
|
9799
10244
|
# If this parameter is enabled and the requested engine supports the
|
9800
10245
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
9801
10246
|
# list of supported time zones for each engine version.
|
10247
|
+
#
|
10248
|
+
# For RDS Custom, the default is not to list supported time zones. If
|
10249
|
+
# you set `ListSupportedTimezones` to `true`, RDS Custom returns no
|
10250
|
+
# results.
|
9802
10251
|
# @return [Boolean]
|
9803
10252
|
#
|
9804
10253
|
# @!attribute [rw] include_all
|
@@ -9899,6 +10348,8 @@ module Aws::RDS
|
|
9899
10348
|
# The Amazon Resource Name (ARN) of the replicated automated backups,
|
9900
10349
|
# for example,
|
9901
10350
|
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
10351
|
+
#
|
10352
|
+
# This setting doesn't apply to RDS Custom.
|
9902
10353
|
# @return [String]
|
9903
10354
|
#
|
9904
10355
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstanceAutomatedBackupsMessage AWS API Documentation
|
@@ -10768,6 +11219,8 @@ module Aws::RDS
|
|
10768
11219
|
# You can give an Amazon Web Services account permission to restore a
|
10769
11220
|
# manual DB snapshot from another Amazon Web Services account by using
|
10770
11221
|
# the `ModifyDBSnapshotAttribute` API action.
|
11222
|
+
#
|
11223
|
+
# This setting doesn't apply to RDS Custom.
|
10771
11224
|
# @return [Boolean]
|
10772
11225
|
#
|
10773
11226
|
# @!attribute [rw] include_public
|
@@ -10778,6 +11231,8 @@ module Aws::RDS
|
|
10778
11231
|
#
|
10779
11232
|
# You can share a manual DB snapshot as public by using the
|
10780
11233
|
# ModifyDBSnapshotAttribute API.
|
11234
|
+
#
|
11235
|
+
# This setting doesn't apply to RDS Custom.
|
10781
11236
|
# @return [Boolean]
|
10782
11237
|
#
|
10783
11238
|
# @!attribute [rw] dbi_resource_id
|
@@ -11074,7 +11529,7 @@ module Aws::RDS
|
|
11074
11529
|
#
|
11075
11530
|
# {
|
11076
11531
|
# source_identifier: "String",
|
11077
|
-
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
|
11532
|
+
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version
|
11078
11533
|
# start_time: Time.now,
|
11079
11534
|
# end_time: Time.now,
|
11080
11535
|
# duration: 1,
|
@@ -11237,8 +11692,20 @@ module Aws::RDS
|
|
11237
11692
|
# * `source-arn` - The Amazon Resource Name (ARN) of the snapshot
|
11238
11693
|
# exported to Amazon S3
|
11239
11694
|
#
|
11240
|
-
# * `status` - The status of the export task. Must be lowercase
|
11241
|
-
#
|
11695
|
+
# * `status` - The status of the export task. Must be lowercase. Valid
|
11696
|
+
# statuses are the following:
|
11697
|
+
#
|
11698
|
+
# * `canceled`
|
11699
|
+
#
|
11700
|
+
# * `canceling`
|
11701
|
+
#
|
11702
|
+
# * `complete`
|
11703
|
+
#
|
11704
|
+
# * `failed`
|
11705
|
+
#
|
11706
|
+
# * `in_progress`
|
11707
|
+
#
|
11708
|
+
# * `starting`
|
11242
11709
|
# @return [Array<Types::Filter>]
|
11243
11710
|
#
|
11244
11711
|
# @!attribute [rw] marker
|
@@ -11634,6 +12101,8 @@ module Aws::RDS
|
|
11634
12101
|
# @!attribute [rw] license_model
|
11635
12102
|
# The license model filter value. Specify this parameter to show only
|
11636
12103
|
# the available offerings matching the specified license model.
|
12104
|
+
#
|
12105
|
+
# RDS Custom supports only the BYOL licensing model.
|
11637
12106
|
# @return [String]
|
11638
12107
|
#
|
11639
12108
|
# @!attribute [rw] availability_zone_group
|
@@ -11643,11 +12112,16 @@ module Aws::RDS
|
|
11643
12112
|
#
|
11644
12113
|
# Omit this parameter to show the available offerings in the specified
|
11645
12114
|
# Amazon Web Services Region.
|
12115
|
+
#
|
12116
|
+
# This setting doesn't apply to RDS Custom.
|
11646
12117
|
# @return [String]
|
11647
12118
|
#
|
11648
12119
|
# @!attribute [rw] vpc
|
11649
12120
|
# A value that indicates whether to show only VPC or non-VPC
|
11650
|
-
# offerings.
|
12121
|
+
# offerings. RDS Custom supports only VPC offerings.
|
12122
|
+
#
|
12123
|
+
# RDS Custom supports only VPC offerings. If you describe non-VPC
|
12124
|
+
# offerings for RDS Custom, the output shows VPC offerings.
|
11651
12125
|
# @return [Boolean]
|
11652
12126
|
#
|
11653
12127
|
# @!attribute [rw] filters
|
@@ -12571,12 +13045,11 @@ module Aws::RDS
|
|
12571
13045
|
# @return [String]
|
12572
13046
|
#
|
12573
13047
|
# @!attribute [rw] kms_key_id
|
12574
|
-
# The key identifier of the Amazon Web Services KMS
|
12575
|
-
#
|
12576
|
-
#
|
12577
|
-
#
|
12578
|
-
#
|
12579
|
-
# use this Amazon Web Services KMS CMK.
|
13048
|
+
# The key identifier of the Amazon Web Services KMS key that is used
|
13049
|
+
# to encrypt the snapshot when it's exported to Amazon S3. The KMS
|
13050
|
+
# key identifier is its key ARN, key ID, alias ARN, or alias name. The
|
13051
|
+
# IAM role used for the snapshot export must have encryption and
|
13052
|
+
# decryption permissions to use this KMS key.
|
12580
13053
|
# @return [String]
|
12581
13054
|
#
|
12582
13055
|
# @!attribute [rw] status
|
@@ -12858,7 +13331,7 @@ module Aws::RDS
|
|
12858
13331
|
# The Amazon Web Services Region-unique, immutable identifier for the
|
12859
13332
|
# global database cluster. This identifier is found in Amazon Web
|
12860
13333
|
# Services CloudTrail log entries whenever the Amazon Web Services KMS
|
12861
|
-
#
|
13334
|
+
# key for the DB cluster is accessed.
|
12862
13335
|
# @return [String]
|
12863
13336
|
#
|
12864
13337
|
# @!attribute [rw] global_cluster_arn
|
@@ -13249,6 +13722,12 @@ module Aws::RDS
|
|
13249
13722
|
#
|
13250
13723
|
class InsufficientStorageClusterCapacityFault < Aws::EmptyStructure; end
|
13251
13724
|
|
13725
|
+
# You can't delete the CEV.
|
13726
|
+
#
|
13727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/InvalidCustomDBEngineVersionStateFault AWS API Documentation
|
13728
|
+
#
|
13729
|
+
class InvalidCustomDBEngineVersionStateFault < Aws::EmptyStructure; end
|
13730
|
+
|
13252
13731
|
# `Capacity` isn't a valid Aurora Serverless DB cluster capacity. Valid
|
13253
13732
|
# capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`.
|
13254
13733
|
#
|
@@ -13582,6 +14061,65 @@ module Aws::RDS
|
|
13582
14061
|
include Aws::Structure
|
13583
14062
|
end
|
13584
14063
|
|
14064
|
+
# @note When making an API call, you may pass ModifyCustomDBEngineVersionMessage
|
14065
|
+
# data as a hash:
|
14066
|
+
#
|
14067
|
+
# {
|
14068
|
+
# engine: "CustomEngineName", # required
|
14069
|
+
# engine_version: "CustomEngineVersion", # required
|
14070
|
+
# description: "Description",
|
14071
|
+
# status: "available", # accepts available, inactive, inactive-except-restore
|
14072
|
+
# }
|
14073
|
+
#
|
14074
|
+
# @!attribute [rw] engine
|
14075
|
+
# The DB engine. The only supported value is `custom-oracle-ee`.
|
14076
|
+
# @return [String]
|
14077
|
+
#
|
14078
|
+
# @!attribute [rw] engine_version
|
14079
|
+
# The custom engine version (CEV) that you want to modify. This option
|
14080
|
+
# is required for RDS Custom, but optional for Amazon RDS. The
|
14081
|
+
# combination of `Engine` and `EngineVersion` is unique per customer
|
14082
|
+
# per Amazon Web Services Region.
|
14083
|
+
# @return [String]
|
14084
|
+
#
|
14085
|
+
# @!attribute [rw] description
|
14086
|
+
# An optional description of your CEV.
|
14087
|
+
# @return [String]
|
14088
|
+
#
|
14089
|
+
# @!attribute [rw] status
|
14090
|
+
# The availability status to be assigned to the CEV. Valid values are
|
14091
|
+
# as follows:
|
14092
|
+
#
|
14093
|
+
# available
|
14094
|
+
#
|
14095
|
+
# : You can use this CEV to create a new RDS Custom DB instance.
|
14096
|
+
#
|
14097
|
+
# inactive
|
14098
|
+
#
|
14099
|
+
# : You can create a new RDS Custom instance by restoring a DB
|
14100
|
+
# snapshot with this CEV. You can't patch or create new instances
|
14101
|
+
# with this CEV.
|
14102
|
+
#
|
14103
|
+
# You can change any status to any status. A typical reason to change
|
14104
|
+
# status is to prevent the accidental use of a CEV, or to make a
|
14105
|
+
# deprecated CEV eligible for use again. For example, you might change
|
14106
|
+
# the status of your CEV from `available` to `inactive`, and from
|
14107
|
+
# `inactive` back to `available`. To change the availability status of
|
14108
|
+
# the CEV, it must not currently be in use by an RDS Custom instance,
|
14109
|
+
# snapshot, or automated backup.
|
14110
|
+
# @return [String]
|
14111
|
+
#
|
14112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCustomDBEngineVersionMessage AWS API Documentation
|
14113
|
+
#
|
14114
|
+
class ModifyCustomDBEngineVersionMessage < Struct.new(
|
14115
|
+
:engine,
|
14116
|
+
:engine_version,
|
14117
|
+
:description,
|
14118
|
+
:status)
|
14119
|
+
SENSITIVE = []
|
14120
|
+
include Aws::Structure
|
14121
|
+
end
|
14122
|
+
|
13585
14123
|
# @note When making an API call, you may pass ModifyDBClusterEndpointMessage
|
13586
14124
|
# data as a hash:
|
13587
14125
|
#
|
@@ -14207,6 +14745,8 @@ module Aws::RDS
|
|
14207
14745
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
14208
14746
|
# enable_customer_owned_ip: false,
|
14209
14747
|
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
14748
|
+
# automation_mode: "full", # accepts full, all-paused
|
14749
|
+
# resume_full_automation_mode_minutes: 1,
|
14210
14750
|
# }
|
14211
14751
|
#
|
14212
14752
|
# @!attribute [rw] db_instance_identifier
|
@@ -14238,12 +14778,14 @@ module Aws::RDS
|
|
14238
14778
|
# `db.m4.large`. Not all DB instance classes are available in all
|
14239
14779
|
# Amazon Web Services Regions, or for all database engines. For the
|
14240
14780
|
# full list of DB instance classes, and availability for your engine,
|
14241
|
-
# see [DB Instance Class][1] in the *Amazon RDS User Guide
|
14781
|
+
# see [DB Instance Class][1] in the *Amazon RDS User Guide*.
|
14242
14782
|
#
|
14243
14783
|
# If you modify the DB instance class, an outage occurs during the
|
14244
14784
|
# change. The change is applied during the next maintenance window,
|
14245
14785
|
# unless `ApplyImmediately` is enabled for this request.
|
14246
14786
|
#
|
14787
|
+
# This setting doesn't apply to RDS Custom.
|
14788
|
+
#
|
14247
14789
|
# Default: Uses existing setting
|
14248
14790
|
#
|
14249
14791
|
#
|
@@ -14256,12 +14798,14 @@ module Aws::RDS
|
|
14256
14798
|
# parameter to move your DB instance to a different VPC. If your DB
|
14257
14799
|
# instance isn't in a VPC, you can also use this parameter to move
|
14258
14800
|
# your DB instance into a VPC. For more information, see [Working with
|
14259
|
-
# a DB instance in a VPC][1] in the *Amazon RDS User Guide
|
14801
|
+
# a DB instance in a VPC][1] in the *Amazon RDS User Guide*.
|
14260
14802
|
#
|
14261
14803
|
# Changing the subnet group causes an outage during the change. The
|
14262
14804
|
# change is applied during the next maintenance window, unless you
|
14263
14805
|
# enable `ApplyImmediately`.
|
14264
14806
|
#
|
14807
|
+
# This parameter doesn't apply to RDS Custom.
|
14808
|
+
#
|
14265
14809
|
# Constraints: If supplied, must match the name of an existing
|
14266
14810
|
# DBSubnetGroup.
|
14267
14811
|
#
|
@@ -14277,6 +14821,8 @@ module Aws::RDS
|
|
14277
14821
|
# Changing this setting doesn't result in an outage and the change is
|
14278
14822
|
# asynchronously applied as soon as possible.
|
14279
14823
|
#
|
14824
|
+
# This setting doesn't apply to RDS Custom.
|
14825
|
+
#
|
14280
14826
|
# Constraints:
|
14281
14827
|
#
|
14282
14828
|
# * If supplied, must match existing DBSecurityGroups.
|
@@ -14285,8 +14831,10 @@ module Aws::RDS
|
|
14285
14831
|
# @return [Array<String>]
|
14286
14832
|
#
|
14287
14833
|
# @!attribute [rw] vpc_security_group_ids
|
14288
|
-
# A list of EC2 VPC security groups to authorize on this DB
|
14289
|
-
# This change is asynchronously applied as soon as possible.
|
14834
|
+
# A list of Amazon EC2 VPC security groups to authorize on this DB
|
14835
|
+
# instance. This change is asynchronously applied as soon as possible.
|
14836
|
+
#
|
14837
|
+
# This setting doesn't apply to RDS Custom.
|
14290
14838
|
#
|
14291
14839
|
# **Amazon Aurora**
|
14292
14840
|
#
|
@@ -14331,6 +14879,8 @@ module Aws::RDS
|
|
14331
14879
|
# `MasterUserPassword` element exists in the `PendingModifiedValues`
|
14332
14880
|
# element of the operation response.
|
14333
14881
|
#
|
14882
|
+
# This setting doesn't apply to RDS Custom.
|
14883
|
+
#
|
14334
14884
|
# **Amazon Aurora**
|
14335
14885
|
#
|
14336
14886
|
# Not applicable. The password for the master user is managed by the
|
@@ -14368,17 +14918,22 @@ module Aws::RDS
|
|
14368
14918
|
#
|
14369
14919
|
# @!attribute [rw] db_parameter_group_name
|
14370
14920
|
# The name of the DB parameter group to apply to the DB instance.
|
14921
|
+
#
|
14371
14922
|
# Changing this setting doesn't result in an outage. The parameter
|
14372
14923
|
# group name itself is changed immediately, but the actual parameter
|
14373
14924
|
# changes are not applied until you reboot the instance without
|
14374
14925
|
# failover. In this case, the DB instance isn't rebooted
|
14375
|
-
# automatically and the parameter changes
|
14376
|
-
# next maintenance window.
|
14926
|
+
# automatically, and the parameter changes aren't applied during the
|
14927
|
+
# next maintenance window. However, if you modify dynamic parameters
|
14928
|
+
# in the newly associated DB parameter group, these changes are
|
14929
|
+
# applied immediately without a reboot.
|
14930
|
+
#
|
14931
|
+
# This setting doesn't apply to RDS Custom.
|
14377
14932
|
#
|
14378
14933
|
# Default: Uses existing setting
|
14379
14934
|
#
|
14380
14935
|
# Constraints: The DB parameter group must be in the same DB parameter
|
14381
|
-
# group family as
|
14936
|
+
# group family as the DB instance.
|
14382
14937
|
# @return [String]
|
14383
14938
|
#
|
14384
14939
|
# @!attribute [rw] backup_retention_period
|
@@ -14407,15 +14962,15 @@ module Aws::RDS
|
|
14407
14962
|
#
|
14408
14963
|
# Constraints:
|
14409
14964
|
#
|
14410
|
-
# *
|
14411
|
-
#
|
14412
|
-
#
|
14413
|
-
# running MySQL 5.6 or later
|
14965
|
+
# * It must be a value from 0 to 35. It can't be set to 0 if the DB
|
14966
|
+
# instance is a source to read replicas. It can't be set to 0 or 35
|
14967
|
+
# for an RDS Custom DB instance.
|
14414
14968
|
#
|
14415
|
-
# *
|
14416
|
-
#
|
14969
|
+
# * It can be specified for a MySQL read replica only if the source is
|
14970
|
+
# running MySQL 5.6 or later.
|
14417
14971
|
#
|
14418
|
-
# *
|
14972
|
+
# * It can be specified for a PostgreSQL read replica only if the
|
14973
|
+
# source is running PostgreSQL 9.3.5.
|
14419
14974
|
# @return [Integer]
|
14420
14975
|
#
|
14421
14976
|
# @!attribute [rw] preferred_backup_window
|
@@ -14478,9 +15033,11 @@ module Aws::RDS
|
|
14478
15033
|
#
|
14479
15034
|
# @!attribute [rw] multi_az
|
14480
15035
|
# A value that indicates whether the DB instance is a Multi-AZ
|
14481
|
-
# deployment. Changing this parameter doesn't result in an outage
|
14482
|
-
#
|
15036
|
+
# deployment. Changing this parameter doesn't result in an outage.
|
15037
|
+
# The change is applied during the next maintenance window unless the
|
14483
15038
|
# `ApplyImmediately` parameter is enabled for this request.
|
15039
|
+
#
|
15040
|
+
# This setting doesn't apply to RDS Custom.
|
14484
15041
|
# @return [Boolean]
|
14485
15042
|
#
|
14486
15043
|
# @!attribute [rw] engine_version
|
@@ -14499,6 +15056,9 @@ module Aws::RDS
|
|
14499
15056
|
# instance to the default minor version if the current minor version
|
14500
15057
|
# is lower. For information about valid engine versions, see
|
14501
15058
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
15059
|
+
#
|
15060
|
+
# In RDS Custom, this parameter is supported for read replicas only if
|
15061
|
+
# they are in the `PATCH_DB_FAILURE` lifecycle.
|
14502
15062
|
# @return [String]
|
14503
15063
|
#
|
14504
15064
|
# @!attribute [rw] allow_major_version_upgrade
|
@@ -14506,6 +15066,8 @@ module Aws::RDS
|
|
14506
15066
|
# Changing this parameter doesn't result in an outage and the change
|
14507
15067
|
# is asynchronously applied as soon as possible.
|
14508
15068
|
#
|
15069
|
+
# This setting doesn't apply to RDS Custom.
|
15070
|
+
#
|
14509
15071
|
# Constraints: Major version upgrades must be allowed when specifying
|
14510
15072
|
# a value for the EngineVersion parameter that is a different major
|
14511
15073
|
# version than the DB instance's current version.
|
@@ -14513,17 +15075,27 @@ module Aws::RDS
|
|
14513
15075
|
#
|
14514
15076
|
# @!attribute [rw] auto_minor_version_upgrade
|
14515
15077
|
# A value that indicates whether minor version upgrades are applied
|
14516
|
-
# automatically to the DB instance during the maintenance window.
|
14517
|
-
#
|
14518
|
-
#
|
14519
|
-
#
|
14520
|
-
#
|
14521
|
-
#
|
15078
|
+
# automatically to the DB instance during the maintenance window. An
|
15079
|
+
# outage occurs when all the following conditions are met:
|
15080
|
+
#
|
15081
|
+
# * The automatic upgrade is enabled for the maintenance window.
|
15082
|
+
#
|
15083
|
+
# * A newer minor version is available.
|
15084
|
+
#
|
15085
|
+
# * RDS has enabled automatic patching for the engine version.
|
15086
|
+
#
|
15087
|
+
# If any of the preceding conditions isn't met, RDS applies the
|
15088
|
+
# change as soon as possible and doesn't cause an outage.
|
15089
|
+
#
|
15090
|
+
# For an RDS Custom DB instance, set `AutoMinorVersionUpgrade` to
|
15091
|
+
# `false`. Otherwise, the operation returns an error.
|
14522
15092
|
# @return [Boolean]
|
14523
15093
|
#
|
14524
15094
|
# @!attribute [rw] license_model
|
14525
15095
|
# The license model for the DB instance.
|
14526
15096
|
#
|
15097
|
+
# This setting doesn't apply to RDS Custom.
|
15098
|
+
#
|
14527
15099
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
14528
15100
|
# `general-public-license`
|
14529
15101
|
# @return [String]
|
@@ -14565,18 +15137,23 @@ module Aws::RDS
|
|
14565
15137
|
#
|
14566
15138
|
# @!attribute [rw] option_group_name
|
14567
15139
|
# A value that indicates the DB instance should be associated with the
|
14568
|
-
# specified option group.
|
14569
|
-
#
|
14570
|
-
#
|
14571
|
-
#
|
14572
|
-
#
|
14573
|
-
#
|
14574
|
-
#
|
15140
|
+
# specified option group.
|
15141
|
+
#
|
15142
|
+
# Changing this parameter doesn't result in an outage, with one
|
15143
|
+
# exception. If the parameter change results in an option group that
|
15144
|
+
# enables OEM, it can cause a brief period, lasting less than a
|
15145
|
+
# second, during which new connections are rejected but existing
|
15146
|
+
# connections aren't interrupted.
|
15147
|
+
#
|
15148
|
+
# The change is applied during the next maintenance window unless the
|
15149
|
+
# `ApplyImmediately` parameter is enabled for this request.
|
14575
15150
|
#
|
14576
15151
|
# Permanent options, such as the TDE option for Oracle Advanced
|
14577
15152
|
# Security TDE, can't be removed from an option group, and that
|
14578
|
-
# option group can't be removed from a DB instance
|
14579
|
-
# associated with a DB instance
|
15153
|
+
# option group can't be removed from a DB instance after it is
|
15154
|
+
# associated with a DB instance.
|
15155
|
+
#
|
15156
|
+
# This setting doesn't apply to RDS Custom.
|
14580
15157
|
# @return [String]
|
14581
15158
|
#
|
14582
15159
|
# @!attribute [rw] new_db_instance_identifier
|
@@ -14586,6 +15163,8 @@ module Aws::RDS
|
|
14586
15163
|
# occur during the next maintenance window if you disable Apply
|
14587
15164
|
# Immediately. This value is stored as a lowercase string.
|
14588
15165
|
#
|
15166
|
+
# This setting doesn't apply to RDS Custom.
|
15167
|
+
#
|
14589
15168
|
# Constraints:
|
14590
15169
|
#
|
14591
15170
|
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
@@ -14627,28 +15206,35 @@ module Aws::RDS
|
|
14627
15206
|
# @!attribute [rw] tde_credential_arn
|
14628
15207
|
# The ARN from the key store with which to associate the instance for
|
14629
15208
|
# TDE encryption.
|
15209
|
+
#
|
15210
|
+
# This setting doesn't apply to RDS Custom.
|
14630
15211
|
# @return [String]
|
14631
15212
|
#
|
14632
15213
|
# @!attribute [rw] tde_credential_password
|
14633
15214
|
# The password for the given ARN from the key store in order to access
|
14634
15215
|
# the device.
|
15216
|
+
#
|
15217
|
+
# This setting doesn't apply to RDS Custom.
|
14635
15218
|
# @return [String]
|
14636
15219
|
#
|
14637
15220
|
# @!attribute [rw] ca_certificate_identifier
|
14638
|
-
#
|
14639
|
-
#
|
15221
|
+
# Specifies the certificate to associate with the DB instance.
|
15222
|
+
#
|
15223
|
+
# This setting doesn't apply to RDS Custom.
|
14640
15224
|
# @return [String]
|
14641
15225
|
#
|
14642
15226
|
# @!attribute [rw] domain
|
14643
15227
|
# The Active Directory directory ID to move the DB instance to.
|
14644
|
-
# Specify `none` to remove the instance from its current domain.
|
14645
|
-
#
|
14646
|
-
# MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
14647
|
-
#
|
15228
|
+
# Specify `none` to remove the instance from its current domain. You
|
15229
|
+
# must create the domain before this operation. Currently, you can
|
15230
|
+
# create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
15231
|
+
# instances in an Active Directory Domain.
|
14648
15232
|
#
|
14649
15233
|
# For more information, see [ Kerberos Authentication][1] in the
|
14650
15234
|
# *Amazon RDS User Guide*.
|
14651
15235
|
#
|
15236
|
+
# This setting doesn't apply to RDS Custom.
|
15237
|
+
#
|
14652
15238
|
#
|
14653
15239
|
#
|
14654
15240
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -14669,10 +15255,12 @@ module Aws::RDS
|
|
14669
15255
|
# @!attribute [rw] monitoring_interval
|
14670
15256
|
# The interval, in seconds, between points when Enhanced Monitoring
|
14671
15257
|
# metrics are collected for the DB instance. To disable collecting
|
14672
|
-
# Enhanced Monitoring metrics, specify 0
|
15258
|
+
# Enhanced Monitoring metrics, specify 0, which is the default.
|
14673
15259
|
#
|
14674
|
-
# If `MonitoringRoleArn` is specified,
|
14675
|
-
#
|
15260
|
+
# If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
|
15261
|
+
# value other than 0.
|
15262
|
+
#
|
15263
|
+
# This setting doesn't apply to RDS Custom.
|
14676
15264
|
#
|
14677
15265
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
14678
15266
|
# @return [Integer]
|
@@ -14684,9 +15272,11 @@ module Aws::RDS
|
|
14684
15272
|
# port values specified for options in the option group for the DB
|
14685
15273
|
# instance.
|
14686
15274
|
#
|
14687
|
-
#
|
15275
|
+
# If you change the `DBPortNumber` value, your database restarts
|
14688
15276
|
# regardless of the value of the `ApplyImmediately` parameter.
|
14689
15277
|
#
|
15278
|
+
# This setting doesn't apply to RDS Custom.
|
15279
|
+
#
|
14690
15280
|
# **MySQL**
|
14691
15281
|
#
|
14692
15282
|
# Default: `3306`
|
@@ -14748,17 +15338,21 @@ module Aws::RDS
|
|
14748
15338
|
# Changes to the `PubliclyAccessible` parameter are applied
|
14749
15339
|
# immediately regardless of the value of the `ApplyImmediately`
|
14750
15340
|
# parameter.
|
15341
|
+
#
|
15342
|
+
# This setting doesn't apply to RDS Custom.
|
14751
15343
|
# @return [Boolean]
|
14752
15344
|
#
|
14753
15345
|
# @!attribute [rw] monitoring_role_arn
|
14754
15346
|
# The ARN for the IAM role that permits RDS to send enhanced
|
14755
15347
|
# monitoring metrics to Amazon CloudWatch Logs. For example,
|
14756
15348
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on
|
14757
|
-
# creating a monitoring role,
|
15349
|
+
# creating a monitoring role, see [To create an IAM role for Amazon
|
14758
15350
|
# RDS Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
14759
15351
|
#
|
14760
|
-
# If `MonitoringInterval` is set to a value other than 0,
|
14761
|
-
#
|
15352
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
15353
|
+
# `MonitoringRoleArn` value.
|
15354
|
+
#
|
15355
|
+
# This setting doesn't apply to RDS Custom.
|
14762
15356
|
#
|
14763
15357
|
#
|
14764
15358
|
#
|
@@ -14768,6 +15362,8 @@ module Aws::RDS
|
|
14768
15362
|
# @!attribute [rw] domain_iam_role_name
|
14769
15363
|
# The name of the IAM role to use when making API calls to the
|
14770
15364
|
# Directory Service.
|
15365
|
+
#
|
15366
|
+
# This setting doesn't apply to RDS Custom.
|
14771
15367
|
# @return [String]
|
14772
15368
|
#
|
14773
15369
|
# @!attribute [rw] promotion_tier
|
@@ -14776,6 +15372,8 @@ module Aws::RDS
|
|
14776
15372
|
# primary instance. For more information, see [ Fault Tolerance for an
|
14777
15373
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
14778
15374
|
#
|
15375
|
+
# This setting doesn't apply to RDS Custom.
|
15376
|
+
#
|
14779
15377
|
# Default: 1
|
14780
15378
|
#
|
14781
15379
|
# Valid Values: 0 - 15
|
@@ -14798,6 +15396,8 @@ module Aws::RDS
|
|
14798
15396
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
14799
15397
|
# RDS User Guide.*
|
14800
15398
|
#
|
15399
|
+
# This setting doesn't apply to RDS Custom.
|
15400
|
+
#
|
14801
15401
|
#
|
14802
15402
|
#
|
14803
15403
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -14810,6 +15410,8 @@ module Aws::RDS
|
|
14810
15410
|
# For more information, see [Using Amazon Performance Insights][1] in
|
14811
15411
|
# the *Amazon Relational Database Service User Guide*.
|
14812
15412
|
#
|
15413
|
+
# This setting doesn't apply to RDS Custom.
|
15414
|
+
#
|
14813
15415
|
#
|
14814
15416
|
#
|
14815
15417
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -14820,18 +15422,22 @@ module Aws::RDS
|
|
14820
15422
|
# Performance Insights data.
|
14821
15423
|
#
|
14822
15424
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
14823
|
-
# alias ARN, or alias name for the
|
14824
|
-
# master key (CMK).
|
15425
|
+
# alias ARN, or alias name for the KMS key.
|
14825
15426
|
#
|
14826
15427
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
14827
|
-
# then Amazon RDS uses your default
|
14828
|
-
# your Amazon Web Services account. Your Amazon Web Services
|
14829
|
-
# has a different default
|
15428
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
15429
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
15430
|
+
# account has a different default KMS key for each Amazon Web Services
|
15431
|
+
# Region.
|
15432
|
+
#
|
15433
|
+
# This setting doesn't apply to RDS Custom.
|
14830
15434
|
# @return [String]
|
14831
15435
|
#
|
14832
15436
|
# @!attribute [rw] performance_insights_retention_period
|
14833
15437
|
# The amount of time, in days, to retain Performance Insights data.
|
14834
15438
|
# Valid values are 7 or 731 (2 years).
|
15439
|
+
#
|
15440
|
+
# This setting doesn't apply to RDS Custom.
|
14835
15441
|
# @return [Integer]
|
14836
15442
|
#
|
14837
15443
|
# @!attribute [rw] cloudwatch_logs_export_configuration
|
@@ -14841,16 +15447,22 @@ module Aws::RDS
|
|
14841
15447
|
# A change to the `CloudwatchLogsExportConfiguration` parameter is
|
14842
15448
|
# always applied to the DB instance immediately. Therefore, the
|
14843
15449
|
# `ApplyImmediately` parameter has no effect.
|
15450
|
+
#
|
15451
|
+
# This setting doesn't apply to RDS Custom.
|
14844
15452
|
# @return [Types::CloudwatchLogsExportConfiguration]
|
14845
15453
|
#
|
14846
15454
|
# @!attribute [rw] processor_features
|
14847
15455
|
# The number of CPU cores and the number of threads per core for the
|
14848
15456
|
# DB instance class of the DB instance.
|
15457
|
+
#
|
15458
|
+
# This setting doesn't apply to RDS Custom.
|
14849
15459
|
# @return [Array<Types::ProcessorFeature>]
|
14850
15460
|
#
|
14851
15461
|
# @!attribute [rw] use_default_processor_features
|
14852
15462
|
# A value that indicates whether the DB instance class of the DB
|
14853
15463
|
# instance uses its default processor features.
|
15464
|
+
#
|
15465
|
+
# This setting doesn't apply to RDS Custom.
|
14854
15466
|
# @return [Boolean]
|
14855
15467
|
#
|
14856
15468
|
# @!attribute [rw] deletion_protection
|
@@ -14872,6 +15484,8 @@ module Aws::RDS
|
|
14872
15484
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
14873
15485
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
14874
15486
|
#
|
15487
|
+
# This setting doesn't apply to RDS Custom.
|
15488
|
+
#
|
14875
15489
|
#
|
14876
15490
|
#
|
14877
15491
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -14900,6 +15514,8 @@ module Aws::RDS
|
|
14900
15514
|
# Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
|
14901
15515
|
# the *Amazon Aurora User Guide.*
|
14902
15516
|
#
|
15517
|
+
# This setting doesn't apply to RDS Custom.
|
15518
|
+
#
|
14903
15519
|
#
|
14904
15520
|
#
|
14905
15521
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
@@ -14922,6 +15538,8 @@ module Aws::RDS
|
|
14922
15538
|
# workload. For more information, see [Working with Oracle Read
|
14923
15539
|
# Replicas for Amazon RDS][1] in the *Amazon RDS User Guide*.
|
14924
15540
|
#
|
15541
|
+
# This setting doesn't apply to RDS Custom.
|
15542
|
+
#
|
14925
15543
|
#
|
14926
15544
|
#
|
14927
15545
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -14953,8 +15571,23 @@ module Aws::RDS
|
|
14953
15571
|
# @!attribute [rw] aws_backup_recovery_point_arn
|
14954
15572
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
14955
15573
|
# Services Backup.
|
15574
|
+
#
|
15575
|
+
# This setting doesn't apply to RDS Custom.
|
15576
|
+
# @return [String]
|
15577
|
+
#
|
15578
|
+
# @!attribute [rw] automation_mode
|
15579
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
15580
|
+
# paused`. If `full`, the DB instance automates monitoring and
|
15581
|
+
# instance recovery. If `all paused`, the instance pauses automation
|
15582
|
+
# for the duration set by `ResumeFullAutomationModeMinutes`.
|
14956
15583
|
# @return [String]
|
14957
15584
|
#
|
15585
|
+
# @!attribute [rw] resume_full_automation_mode_minutes
|
15586
|
+
# The number of minutes to pause the automation. When the time period
|
15587
|
+
# ends, RDS Custom resumes full automation. The minimum value is `60`
|
15588
|
+
# (default). The maximum value is `1,440`.
|
15589
|
+
# @return [Integer]
|
15590
|
+
#
|
14958
15591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
14959
15592
|
#
|
14960
15593
|
class ModifyDBInstanceMessage < Struct.new(
|
@@ -15002,7 +15635,9 @@ module Aws::RDS
|
|
15002
15635
|
:certificate_rotation_restart,
|
15003
15636
|
:replica_mode,
|
15004
15637
|
:enable_customer_owned_ip,
|
15005
|
-
:aws_backup_recovery_point_arn
|
15638
|
+
:aws_backup_recovery_point_arn,
|
15639
|
+
:automation_mode,
|
15640
|
+
:resume_full_automation_mode_minutes)
|
15006
15641
|
SENSITIVE = []
|
15007
15642
|
include Aws::Structure
|
15008
15643
|
end
|
@@ -16752,6 +17387,19 @@ module Aws::RDS
|
|
16752
17387
|
# Management (IAM) accounts to database accounts is enabled.
|
16753
17388
|
# @return [Boolean]
|
16754
17389
|
#
|
17390
|
+
# @!attribute [rw] automation_mode
|
17391
|
+
# The automation mode of the RDS Custom DB instance: `full` or
|
17392
|
+
# `all-paused`. If `full`, the DB instance automates monitoring and
|
17393
|
+
# instance recovery. If `all-paused`, the instance pauses automation
|
17394
|
+
# for the duration set by `--resume-full-automation-mode-minutes`.
|
17395
|
+
# @return [String]
|
17396
|
+
#
|
17397
|
+
# @!attribute [rw] resume_full_automation_mode_time
|
17398
|
+
# The number of minutes to pause the automation. When the time period
|
17399
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
17400
|
+
# (default). The maximum value is 1,440.
|
17401
|
+
# @return [Time]
|
17402
|
+
#
|
16755
17403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PendingModifiedValues AWS API Documentation
|
16756
17404
|
#
|
16757
17405
|
class PendingModifiedValues < Struct.new(
|
@@ -16770,7 +17418,9 @@ module Aws::RDS
|
|
16770
17418
|
:db_subnet_group_name,
|
16771
17419
|
:pending_cloudwatch_logs_exports,
|
16772
17420
|
:processor_features,
|
16773
|
-
:iam_database_authentication_enabled
|
17421
|
+
:iam_database_authentication_enabled,
|
17422
|
+
:automation_mode,
|
17423
|
+
:resume_full_automation_mode_time)
|
16774
17424
|
SENSITIVE = []
|
16775
17425
|
include Aws::Structure
|
16776
17426
|
end
|
@@ -17272,8 +17922,8 @@ module Aws::RDS
|
|
17272
17922
|
#
|
17273
17923
|
# @!attribute [rw] feature_name
|
17274
17924
|
# The name of the feature for the DB cluster that the IAM role is to
|
17275
|
-
# be disassociated from. For
|
17276
|
-
# DBEngineVersion.
|
17925
|
+
# be disassociated from. For information about supported feature
|
17926
|
+
# names, see DBEngineVersion.
|
17277
17927
|
# @return [String]
|
17278
17928
|
#
|
17279
17929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBClusterMessage AWS API Documentation
|
@@ -17307,8 +17957,8 @@ module Aws::RDS
|
|
17307
17957
|
#
|
17308
17958
|
# @!attribute [rw] feature_name
|
17309
17959
|
# The name of the feature for the DB instance that the IAM role is to
|
17310
|
-
# be disassociated from. For
|
17311
|
-
# `DBEngineVersion`.
|
17960
|
+
# be disassociated from. For information about supported feature
|
17961
|
+
# names, see `DBEngineVersion`.
|
17312
17962
|
# @return [String]
|
17313
17963
|
#
|
17314
17964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBInstanceMessage AWS API Documentation
|
@@ -18021,15 +18671,15 @@ module Aws::RDS
|
|
18021
18671
|
# cluster.
|
18022
18672
|
#
|
18023
18673
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18024
|
-
# alias ARN, or alias name for the
|
18025
|
-
#
|
18026
|
-
#
|
18674
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
18675
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
18676
|
+
# ARN.
|
18027
18677
|
#
|
18028
18678
|
# If the StorageEncrypted parameter is enabled, and you do not specify
|
18029
18679
|
# a value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
18030
|
-
# default
|
18031
|
-
# account. Your Amazon Web Services account has a different
|
18032
|
-
#
|
18680
|
+
# default KMS key. There is a default KMS key for your Amazon Web
|
18681
|
+
# Services account. Your Amazon Web Services account has a different
|
18682
|
+
# default KMS key for each Amazon Web Services Region.
|
18033
18683
|
# @return [String]
|
18034
18684
|
#
|
18035
18685
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -18349,17 +18999,17 @@ module Aws::RDS
|
|
18349
18999
|
# encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
18350
19000
|
#
|
18351
19001
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18352
|
-
# alias ARN, or alias name for the
|
18353
|
-
#
|
18354
|
-
#
|
19002
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
19003
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
19004
|
+
# ARN.
|
18355
19005
|
#
|
18356
19006
|
# When you don't specify a value for the `KmsKeyId` parameter, then
|
18357
19007
|
# the following occurs:
|
18358
19008
|
#
|
18359
19009
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
18360
19010
|
# is encrypted, then the restored DB cluster is encrypted using the
|
18361
|
-
#
|
18362
|
-
# snapshot
|
19011
|
+
# KMS key that was used to encrypt the DB snapshot or DB cluster
|
19012
|
+
# snapshot.
|
18363
19013
|
#
|
18364
19014
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
18365
19015
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
@@ -18663,22 +19313,21 @@ module Aws::RDS
|
|
18663
19313
|
# encrypted DB cluster from an encrypted DB cluster.
|
18664
19314
|
#
|
18665
19315
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18666
|
-
# alias ARN, or alias name for the
|
18667
|
-
#
|
18668
|
-
#
|
19316
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
19317
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
19318
|
+
# ARN.
|
18669
19319
|
#
|
18670
19320
|
# You can restore to a new DB cluster and encrypt the new DB cluster
|
18671
|
-
# with a
|
18672
|
-
#
|
18673
|
-
#
|
18674
|
-
# identified by the `KmsKeyId` parameter.
|
19321
|
+
# with a KMS key that is different from the KMS key used to encrypt
|
19322
|
+
# the source DB cluster. The new DB cluster is encrypted with the KMS
|
19323
|
+
# key identified by the `KmsKeyId` parameter.
|
18675
19324
|
#
|
18676
19325
|
# If you don't specify a value for the `KmsKeyId` parameter, then the
|
18677
19326
|
# following occurs:
|
18678
19327
|
#
|
18679
19328
|
# * If the DB cluster is encrypted, then the restored DB cluster is
|
18680
|
-
# encrypted using the
|
18681
|
-
#
|
19329
|
+
# encrypted using the KMS key that was used to encrypt the source DB
|
19330
|
+
# cluster.
|
18682
19331
|
#
|
18683
19332
|
# * If the DB cluster isn't encrypted, then the restored DB cluster
|
18684
19333
|
# isn't encrypted.
|
@@ -18878,6 +19527,8 @@ module Aws::RDS
|
|
18878
19527
|
# db_parameter_group_name: "String",
|
18879
19528
|
# deletion_protection: false,
|
18880
19529
|
# enable_customer_owned_ip: false,
|
19530
|
+
# custom_iam_instance_profile: "String",
|
19531
|
+
# backup_target: "String",
|
18881
19532
|
# }
|
18882
19533
|
#
|
18883
19534
|
# @!attribute [rw] db_instance_identifier
|
@@ -18952,6 +19603,8 @@ module Aws::RDS
|
|
18952
19603
|
# A value that indicates whether the DB instance is a Multi-AZ
|
18953
19604
|
# deployment.
|
18954
19605
|
#
|
19606
|
+
# This setting doesn't apply to RDS Custom.
|
19607
|
+
#
|
18955
19608
|
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
18956
19609
|
# the DB instance is a Multi-AZ deployment.
|
18957
19610
|
# @return [Boolean]
|
@@ -18976,11 +19629,16 @@ module Aws::RDS
|
|
18976
19629
|
# @!attribute [rw] auto_minor_version_upgrade
|
18977
19630
|
# A value that indicates whether minor version upgrades are applied
|
18978
19631
|
# automatically to the DB instance during the maintenance window.
|
19632
|
+
#
|
19633
|
+
# If you restore an RDS Custom DB instance, you must disable this
|
19634
|
+
# parameter.
|
18979
19635
|
# @return [Boolean]
|
18980
19636
|
#
|
18981
19637
|
# @!attribute [rw] license_model
|
18982
19638
|
# License model information for the restored DB instance.
|
18983
19639
|
#
|
19640
|
+
# This setting doesn't apply to RDS Custom.
|
19641
|
+
#
|
18984
19642
|
# Default: Same as source.
|
18985
19643
|
#
|
18986
19644
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -18990,15 +19648,15 @@ module Aws::RDS
|
|
18990
19648
|
# @!attribute [rw] db_name
|
18991
19649
|
# The database name for the restored DB instance.
|
18992
19650
|
#
|
18993
|
-
#
|
18994
|
-
# engines.
|
18995
|
-
#
|
18996
|
-
# </note>
|
19651
|
+
# This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
|
19652
|
+
# engines. It also doesn't apply to RDS Custom DB instances.
|
18997
19653
|
# @return [String]
|
18998
19654
|
#
|
18999
19655
|
# @!attribute [rw] engine
|
19000
19656
|
# The database engine to use for the new instance.
|
19001
19657
|
#
|
19658
|
+
# This setting doesn't apply to RDS Custom.
|
19659
|
+
#
|
19002
19660
|
# Default: The same as source
|
19003
19661
|
#
|
19004
19662
|
# Constraint: Must be compatible with the engine of the source. For
|
@@ -19056,8 +19714,10 @@ module Aws::RDS
|
|
19056
19714
|
#
|
19057
19715
|
# Permanent options, such as the TDE option for Oracle Advanced
|
19058
19716
|
# Security TDE, can't be removed from an option group, and that
|
19059
|
-
# option group can't be removed from a DB instance
|
19060
|
-
# associated with a DB instance
|
19717
|
+
# option group can't be removed from a DB instance after it is
|
19718
|
+
# associated with a DB instance.
|
19719
|
+
#
|
19720
|
+
# This setting doesn't apply to RDS Custom.
|
19061
19721
|
# @return [String]
|
19062
19722
|
#
|
19063
19723
|
# @!attribute [rw] tags
|
@@ -19083,11 +19743,15 @@ module Aws::RDS
|
|
19083
19743
|
# @!attribute [rw] tde_credential_arn
|
19084
19744
|
# The ARN from the key store with which to associate the instance for
|
19085
19745
|
# TDE encryption.
|
19746
|
+
#
|
19747
|
+
# This setting doesn't apply to RDS Custom.
|
19086
19748
|
# @return [String]
|
19087
19749
|
#
|
19088
19750
|
# @!attribute [rw] tde_credential_password
|
19089
19751
|
# The password for the given ARN from the key store in order to access
|
19090
19752
|
# the device.
|
19753
|
+
#
|
19754
|
+
# This setting doesn't apply to RDS Custom.
|
19091
19755
|
# @return [String]
|
19092
19756
|
#
|
19093
19757
|
# @!attribute [rw] vpc_security_group_ids
|
@@ -19100,13 +19764,15 @@ module Aws::RDS
|
|
19100
19764
|
#
|
19101
19765
|
# @!attribute [rw] domain
|
19102
19766
|
# Specify the Active Directory directory ID to restore the DB instance
|
19103
|
-
# in. The domain must be created prior to this operation. Currently,
|
19104
|
-
# only MySQL, Microsoft SQL Server, Oracle, and
|
19105
|
-
#
|
19767
|
+
# in. The domain/ must be created prior to this operation. Currently,
|
19768
|
+
# you can create only MySQL, Microsoft SQL Server, Oracle, and
|
19769
|
+
# PostgreSQL DB instances in an Active Directory Domain.
|
19106
19770
|
#
|
19107
19771
|
# For more information, see [ Kerberos Authentication][1] in the
|
19108
19772
|
# *Amazon RDS User Guide*.
|
19109
19773
|
#
|
19774
|
+
# This setting doesn't apply to RDS Custom.
|
19775
|
+
#
|
19110
19776
|
#
|
19111
19777
|
#
|
19112
19778
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -19121,6 +19787,8 @@ module Aws::RDS
|
|
19121
19787
|
# @!attribute [rw] domain_iam_role_name
|
19122
19788
|
# Specify the name of the IAM role to be used when making API calls to
|
19123
19789
|
# the Directory Service.
|
19790
|
+
#
|
19791
|
+
# This setting doesn't apply to RDS Custom.
|
19124
19792
|
# @return [String]
|
19125
19793
|
#
|
19126
19794
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -19132,6 +19800,8 @@ module Aws::RDS
|
|
19132
19800
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
19133
19801
|
# RDS User Guide.*
|
19134
19802
|
#
|
19803
|
+
# This setting doesn't apply to RDS Custom.
|
19804
|
+
#
|
19135
19805
|
#
|
19136
19806
|
#
|
19137
19807
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -19143,6 +19813,8 @@ module Aws::RDS
|
|
19143
19813
|
# being used. For more information, see [Publishing Database Logs to
|
19144
19814
|
# Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
19145
19815
|
#
|
19816
|
+
# This setting doesn't apply to RDS Custom.
|
19817
|
+
#
|
19146
19818
|
#
|
19147
19819
|
#
|
19148
19820
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -19151,19 +19823,25 @@ module Aws::RDS
|
|
19151
19823
|
# @!attribute [rw] processor_features
|
19152
19824
|
# The number of CPU cores and the number of threads per core for the
|
19153
19825
|
# DB instance class of the DB instance.
|
19826
|
+
#
|
19827
|
+
# This setting doesn't apply to RDS Custom.
|
19154
19828
|
# @return [Array<Types::ProcessorFeature>]
|
19155
19829
|
#
|
19156
19830
|
# @!attribute [rw] use_default_processor_features
|
19157
19831
|
# A value that indicates whether the DB instance class of the DB
|
19158
19832
|
# instance uses its default processor features.
|
19833
|
+
#
|
19834
|
+
# This setting doesn't apply to RDS Custom.
|
19159
19835
|
# @return [Boolean]
|
19160
19836
|
#
|
19161
19837
|
# @!attribute [rw] db_parameter_group_name
|
19162
19838
|
# The name of the DB parameter group to associate with this DB
|
19163
19839
|
# instance.
|
19164
19840
|
#
|
19165
|
-
# If you
|
19166
|
-
# default `DBParameterGroup` for the specified DB engine
|
19841
|
+
# If you don't specify a value for `DBParameterGroupName`, then RDS
|
19842
|
+
# uses the default `DBParameterGroup` for the specified DB engine.
|
19843
|
+
#
|
19844
|
+
# This setting doesn't apply to RDS Custom.
|
19167
19845
|
#
|
19168
19846
|
# Constraints:
|
19169
19847
|
#
|
@@ -19197,6 +19875,8 @@ module Aws::RDS
|
|
19197
19875
|
# instance from outside of its virtual private cloud (VPC) on your
|
19198
19876
|
# local network.
|
19199
19877
|
#
|
19878
|
+
# This setting doesn't apply to RDS Custom.
|
19879
|
+
#
|
19200
19880
|
# For more information about RDS on Outposts, see [Working with Amazon
|
19201
19881
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
19202
19882
|
# Guide*.
|
@@ -19210,6 +19890,45 @@ module Aws::RDS
|
|
19210
19890
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
19211
19891
|
# @return [Boolean]
|
19212
19892
|
#
|
19893
|
+
# @!attribute [rw] custom_iam_instance_profile
|
19894
|
+
# The instance profile associated with the underlying Amazon EC2
|
19895
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
19896
|
+
# meet the following requirements:
|
19897
|
+
#
|
19898
|
+
# * The profile must exist in your account.
|
19899
|
+
#
|
19900
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
19901
|
+
# to assume.
|
19902
|
+
#
|
19903
|
+
# * The instance profile name and the associated IAM role name must
|
19904
|
+
# start with the prefix `AWSRDSCustom`.
|
19905
|
+
#
|
19906
|
+
# For the list of permissions required for the IAM role, see [
|
19907
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
19908
|
+
# Service User Guide*.
|
19909
|
+
#
|
19910
|
+
# This setting is required for RDS Custom.
|
19911
|
+
#
|
19912
|
+
#
|
19913
|
+
#
|
19914
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
19915
|
+
# @return [String]
|
19916
|
+
#
|
19917
|
+
# @!attribute [rw] backup_target
|
19918
|
+
# Specifies where automated backups and manual snapshots are stored
|
19919
|
+
# for the restored DB instance.
|
19920
|
+
#
|
19921
|
+
# Possible values are `outposts` (Amazon Web Services Outposts) and
|
19922
|
+
# `region` (Amazon Web Services Region). The default is `region`.
|
19923
|
+
#
|
19924
|
+
# For more information, see [Working with Amazon RDS on Amazon Web
|
19925
|
+
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
19926
|
+
#
|
19927
|
+
#
|
19928
|
+
#
|
19929
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
19930
|
+
# @return [String]
|
19931
|
+
#
|
19213
19932
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshotMessage AWS API Documentation
|
19214
19933
|
#
|
19215
19934
|
class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
|
@@ -19241,7 +19960,9 @@ module Aws::RDS
|
|
19241
19960
|
:use_default_processor_features,
|
19242
19961
|
:db_parameter_group_name,
|
19243
19962
|
:deletion_protection,
|
19244
|
-
:enable_customer_owned_ip
|
19963
|
+
:enable_customer_owned_ip,
|
19964
|
+
:custom_iam_instance_profile,
|
19965
|
+
:backup_target)
|
19245
19966
|
SENSITIVE = []
|
19246
19967
|
include Aws::Structure
|
19247
19968
|
end
|
@@ -19583,15 +20304,15 @@ module Aws::RDS
|
|
19583
20304
|
# instance.
|
19584
20305
|
#
|
19585
20306
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
19586
|
-
# alias ARN, or alias name for the
|
19587
|
-
#
|
19588
|
-
#
|
20307
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
20308
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
20309
|
+
# ARN.
|
19589
20310
|
#
|
19590
20311
|
# If the `StorageEncrypted` parameter is enabled, and you do not
|
19591
20312
|
# specify a value for the `KmsKeyId` parameter, then Amazon RDS will
|
19592
|
-
# use your default
|
19593
|
-
# Services account. Your Amazon Web Services account has a
|
19594
|
-
# default
|
20313
|
+
# use your default KMS key. There is a default KMS key for your Amazon
|
20314
|
+
# Web Services account. Your Amazon Web Services account has a
|
20315
|
+
# different default KMS key for each Amazon Web Services Region.
|
19595
20316
|
# @return [String]
|
19596
20317
|
#
|
19597
20318
|
# @!attribute [rw] copy_tags_to_snapshot
|
@@ -19686,13 +20407,13 @@ module Aws::RDS
|
|
19686
20407
|
# Performance Insights data.
|
19687
20408
|
#
|
19688
20409
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
19689
|
-
# alias ARN, or alias name for the
|
19690
|
-
# master key (CMK).
|
20410
|
+
# alias ARN, or alias name for the KMS key.
|
19691
20411
|
#
|
19692
20412
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
19693
|
-
# then Amazon RDS uses your default
|
19694
|
-
# your Amazon Web Services account. Your Amazon Web Services
|
19695
|
-
# has a different default
|
20413
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
20414
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
20415
|
+
# account has a different default KMS key for each Amazon Web Services
|
20416
|
+
# Region.
|
19696
20417
|
# @return [String]
|
19697
20418
|
#
|
19698
20419
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -19859,6 +20580,8 @@ module Aws::RDS
|
|
19859
20580
|
# max_allocated_storage: 1,
|
19860
20581
|
# source_db_instance_automated_backups_arn: "String",
|
19861
20582
|
# enable_customer_owned_ip: false,
|
20583
|
+
# custom_iam_instance_profile: "String",
|
20584
|
+
# backup_target: "String",
|
19862
20585
|
# }
|
19863
20586
|
#
|
19864
20587
|
# @!attribute [rw] source_db_instance_identifier
|
@@ -19954,6 +20677,8 @@ module Aws::RDS
|
|
19954
20677
|
# A value that indicates whether the DB instance is a Multi-AZ
|
19955
20678
|
# deployment.
|
19956
20679
|
#
|
20680
|
+
# This setting doesn't apply to RDS Custom.
|
20681
|
+
#
|
19957
20682
|
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
19958
20683
|
# the DB instance is a Multi-AZ deployment.
|
19959
20684
|
# @return [Boolean]
|
@@ -19978,11 +20703,15 @@ module Aws::RDS
|
|
19978
20703
|
# @!attribute [rw] auto_minor_version_upgrade
|
19979
20704
|
# A value that indicates whether minor version upgrades are applied
|
19980
20705
|
# automatically to the DB instance during the maintenance window.
|
20706
|
+
#
|
20707
|
+
# This setting doesn't apply to RDS Custom.
|
19981
20708
|
# @return [Boolean]
|
19982
20709
|
#
|
19983
20710
|
# @!attribute [rw] license_model
|
19984
20711
|
# License model information for the restored DB instance.
|
19985
20712
|
#
|
20713
|
+
# This setting doesn't apply to RDS Custom.
|
20714
|
+
#
|
19986
20715
|
# Default: Same as source.
|
19987
20716
|
#
|
19988
20717
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -19992,7 +20721,8 @@ module Aws::RDS
|
|
19992
20721
|
# @!attribute [rw] db_name
|
19993
20722
|
# The database name for the restored DB instance.
|
19994
20723
|
#
|
19995
|
-
# <note markdown="1"> This parameter isn't
|
20724
|
+
# <note markdown="1"> This parameter isn't supported for the MySQL or MariaDB engines. It
|
20725
|
+
# also doesn't apply to RDS Custom.
|
19996
20726
|
#
|
19997
20727
|
# </note>
|
19998
20728
|
# @return [String]
|
@@ -20000,6 +20730,8 @@ module Aws::RDS
|
|
20000
20730
|
# @!attribute [rw] engine
|
20001
20731
|
# The database engine to use for the new instance.
|
20002
20732
|
#
|
20733
|
+
# This setting doesn't apply to RDS Custom.
|
20734
|
+
#
|
20003
20735
|
# Default: The same as source
|
20004
20736
|
#
|
20005
20737
|
# Constraint: Must be compatible with the engine of the source
|
@@ -20047,8 +20779,10 @@ module Aws::RDS
|
|
20047
20779
|
#
|
20048
20780
|
# Permanent options, such as the TDE option for Oracle Advanced
|
20049
20781
|
# Security TDE, can't be removed from an option group, and that
|
20050
|
-
# option group can't be removed from a DB instance
|
20782
|
+
# option group can't be removed from a DB instance after it is
|
20051
20783
|
# associated with a DB instance
|
20784
|
+
#
|
20785
|
+
# This setting doesn't apply to RDS Custom.
|
20052
20786
|
# @return [String]
|
20053
20787
|
#
|
20054
20788
|
# @!attribute [rw] copy_tags_to_snapshot
|
@@ -20080,11 +20814,15 @@ module Aws::RDS
|
|
20080
20814
|
# @!attribute [rw] tde_credential_arn
|
20081
20815
|
# The ARN from the key store with which to associate the instance for
|
20082
20816
|
# TDE encryption.
|
20817
|
+
#
|
20818
|
+
# This setting doesn't apply to RDS Custom.
|
20083
20819
|
# @return [String]
|
20084
20820
|
#
|
20085
20821
|
# @!attribute [rw] tde_credential_password
|
20086
20822
|
# The password for the given ARN from the key store in order to access
|
20087
20823
|
# the device.
|
20824
|
+
#
|
20825
|
+
# This setting doesn't apply to RDS Custom.
|
20088
20826
|
# @return [String]
|
20089
20827
|
#
|
20090
20828
|
# @!attribute [rw] vpc_security_group_ids
|
@@ -20097,9 +20835,11 @@ module Aws::RDS
|
|
20097
20835
|
#
|
20098
20836
|
# @!attribute [rw] domain
|
20099
20837
|
# Specify the Active Directory directory ID to restore the DB instance
|
20100
|
-
# in.
|
20101
|
-
# only MySQL, Microsoft SQL Server, Oracle, and
|
20102
|
-
#
|
20838
|
+
# in. Create the domain before running this command. Currently, you
|
20839
|
+
# can create only the MySQL, Microsoft SQL Server, Oracle, and
|
20840
|
+
# PostgreSQL DB instances in an Active Directory Domain.
|
20841
|
+
#
|
20842
|
+
# This setting doesn't apply to RDS Custom.
|
20103
20843
|
#
|
20104
20844
|
# For more information, see [ Kerberos Authentication][1] in the
|
20105
20845
|
# *Amazon RDS User Guide*.
|
@@ -20112,6 +20852,8 @@ module Aws::RDS
|
|
20112
20852
|
# @!attribute [rw] domain_iam_role_name
|
20113
20853
|
# Specify the name of the IAM role to be used when making API calls to
|
20114
20854
|
# the Directory Service.
|
20855
|
+
#
|
20856
|
+
# This setting doesn't apply to RDS Custom.
|
20115
20857
|
# @return [String]
|
20116
20858
|
#
|
20117
20859
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -20119,6 +20861,8 @@ module Aws::RDS
|
|
20119
20861
|
# Services Identity and Access Management (IAM) accounts to database
|
20120
20862
|
# accounts. By default, mapping is disabled.
|
20121
20863
|
#
|
20864
|
+
# This setting doesn't apply to RDS Custom.
|
20865
|
+
#
|
20122
20866
|
# For more information about IAM database authentication, see [ IAM
|
20123
20867
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
20124
20868
|
# RDS User Guide.*
|
@@ -20134,6 +20878,8 @@ module Aws::RDS
|
|
20134
20878
|
# being used. For more information, see [Publishing Database Logs to
|
20135
20879
|
# Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
20136
20880
|
#
|
20881
|
+
# This setting doesn't apply to RDS Custom.
|
20882
|
+
#
|
20137
20883
|
#
|
20138
20884
|
#
|
20139
20885
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -20142,11 +20888,15 @@ module Aws::RDS
|
|
20142
20888
|
# @!attribute [rw] processor_features
|
20143
20889
|
# The number of CPU cores and the number of threads per core for the
|
20144
20890
|
# DB instance class of the DB instance.
|
20891
|
+
#
|
20892
|
+
# This setting doesn't apply to RDS Custom.
|
20145
20893
|
# @return [Array<Types::ProcessorFeature>]
|
20146
20894
|
#
|
20147
20895
|
# @!attribute [rw] use_default_processor_features
|
20148
20896
|
# A value that indicates whether the DB instance class of the DB
|
20149
20897
|
# instance uses its default processor features.
|
20898
|
+
#
|
20899
|
+
# This setting doesn't apply to RDS Custom.
|
20150
20900
|
# @return [Boolean]
|
20151
20901
|
#
|
20152
20902
|
# @!attribute [rw] db_parameter_group_name
|
@@ -20156,6 +20906,8 @@ module Aws::RDS
|
|
20156
20906
|
# If you do not specify a value for `DBParameterGroupName`, then the
|
20157
20907
|
# default `DBParameterGroup` for the specified DB engine is used.
|
20158
20908
|
#
|
20909
|
+
# This setting doesn't apply to RDS Custom.
|
20910
|
+
#
|
20159
20911
|
# Constraints:
|
20160
20912
|
#
|
20161
20913
|
# * If supplied, must match the name of an existing DBParameterGroup.
|
@@ -20190,6 +20942,8 @@ module Aws::RDS
|
|
20190
20942
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
20191
20943
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
20192
20944
|
#
|
20945
|
+
# This setting doesn't apply to RDS Custom.
|
20946
|
+
#
|
20193
20947
|
#
|
20194
20948
|
#
|
20195
20949
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -20199,6 +20953,8 @@ module Aws::RDS
|
|
20199
20953
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
20200
20954
|
# from which to restore, for example,
|
20201
20955
|
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
20956
|
+
#
|
20957
|
+
# This setting doesn't apply to RDS Custom.
|
20202
20958
|
# @return [String]
|
20203
20959
|
#
|
20204
20960
|
# @!attribute [rw] enable_customer_owned_ip
|
@@ -20211,6 +20967,8 @@ module Aws::RDS
|
|
20211
20967
|
# instance from outside of its virtual private cloud (VPC) on your
|
20212
20968
|
# local network.
|
20213
20969
|
#
|
20970
|
+
# This setting doesn't apply to RDS Custom.
|
20971
|
+
#
|
20214
20972
|
# For more information about RDS on Outposts, see [Working with Amazon
|
20215
20973
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
20216
20974
|
# Guide*.
|
@@ -20224,6 +20982,45 @@ module Aws::RDS
|
|
20224
20982
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
20225
20983
|
# @return [Boolean]
|
20226
20984
|
#
|
20985
|
+
# @!attribute [rw] custom_iam_instance_profile
|
20986
|
+
# The instance profile associated with the underlying Amazon EC2
|
20987
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
20988
|
+
# meet the following requirements:
|
20989
|
+
#
|
20990
|
+
# * The profile must exist in your account.
|
20991
|
+
#
|
20992
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
20993
|
+
# to assume.
|
20994
|
+
#
|
20995
|
+
# * The instance profile name and the associated IAM role name must
|
20996
|
+
# start with the prefix `AWSRDSCustom`.
|
20997
|
+
#
|
20998
|
+
# For the list of permissions required for the IAM role, see [
|
20999
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
21000
|
+
# Service User Guide*.
|
21001
|
+
#
|
21002
|
+
# This setting is required for RDS Custom.
|
21003
|
+
#
|
21004
|
+
#
|
21005
|
+
#
|
21006
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
21007
|
+
# @return [String]
|
21008
|
+
#
|
21009
|
+
# @!attribute [rw] backup_target
|
21010
|
+
# Specifies where automated backups and manual snapshots are stored
|
21011
|
+
# for the restored DB instance.
|
21012
|
+
#
|
21013
|
+
# Possible values are `outposts` (Amazon Web Services Outposts) and
|
21014
|
+
# `region` (Amazon Web Services Region). The default is `region`.
|
21015
|
+
#
|
21016
|
+
# For more information, see [Working with Amazon RDS on Amazon Web
|
21017
|
+
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
21018
|
+
#
|
21019
|
+
#
|
21020
|
+
#
|
21021
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
21022
|
+
# @return [String]
|
21023
|
+
#
|
20227
21024
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTimeMessage AWS API Documentation
|
20228
21025
|
#
|
20229
21026
|
class RestoreDBInstanceToPointInTimeMessage < Struct.new(
|
@@ -20260,7 +21057,9 @@ module Aws::RDS
|
|
20260
21057
|
:source_dbi_resource_id,
|
20261
21058
|
:max_allocated_storage,
|
20262
21059
|
:source_db_instance_automated_backups_arn,
|
20263
|
-
:enable_customer_owned_ip
|
21060
|
+
:enable_customer_owned_ip,
|
21061
|
+
:custom_iam_instance_profile,
|
21062
|
+
:backup_target)
|
20264
21063
|
SENSITIVE = []
|
20265
21064
|
include Aws::Structure
|
20266
21065
|
end
|
@@ -20666,7 +21465,7 @@ module Aws::RDS
|
|
20666
21465
|
# The Amazon Web Services KMS key identifier for encrypting messages
|
20667
21466
|
# in the database activity stream. The Amazon Web Services KMS key
|
20668
21467
|
# identifier is the key ARN, key ID, alias ARN, or alias name for the
|
20669
|
-
#
|
21468
|
+
# KMS key.
|
20670
21469
|
# @return [String]
|
20671
21470
|
#
|
20672
21471
|
# @!attribute [rw] apply_immediately
|
@@ -20908,11 +21707,10 @@ module Aws::RDS
|
|
20908
21707
|
# @return [String]
|
20909
21708
|
#
|
20910
21709
|
# @!attribute [rw] kms_key_id
|
20911
|
-
# The ID of the Amazon Web Services KMS
|
20912
|
-
#
|
20913
|
-
#
|
20914
|
-
#
|
20915
|
-
# (CMK). The caller of this operation must be authorized to execute
|
21710
|
+
# The ID of the Amazon Web Services KMS key to use to encrypt the
|
21711
|
+
# snapshot exported to Amazon S3. The Amazon Web Services KMS key
|
21712
|
+
# identifier is the key ARN, key ID, alias ARN, or alias name for the
|
21713
|
+
# KMS key. The caller of this operation must be authorized to execute
|
20916
21714
|
# the following operations. These can be set in the Amazon Web
|
20917
21715
|
# Services KMS key policy:
|
20918
21716
|
#
|
@@ -21008,8 +21806,7 @@ module Aws::RDS
|
|
21008
21806
|
# messages in the database activity stream.
|
21009
21807
|
#
|
21010
21808
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
21011
|
-
# alias ARN, or alias name for the
|
21012
|
-
# master key (CMK).
|
21809
|
+
# alias ARN, or alias name for the KMS key.
|
21013
21810
|
# @return [String]
|
21014
21811
|
#
|
21015
21812
|
# @!attribute [rw] kinesis_stream_name
|