aws-sdk-rds 1.128.0 → 1.129.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1279 -258
- data/lib/aws-sdk-rds/client_api.rb +93 -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 +514 -139
- data/lib/aws-sdk-rds/db_snapshot.rb +78 -30
- data/lib/aws-sdk-rds/errors.rb +44 -0
- data/lib/aws-sdk-rds/resource.rb +186 -59
- data/lib/aws-sdk-rds/types.rb +1058 -285
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
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,7 @@ 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",
|
2542
2669
|
# }
|
2543
2670
|
#
|
2544
2671
|
# @!attribute [rw] db_name
|
@@ -2604,6 +2731,21 @@ module Aws::RDS
|
|
2604
2731
|
#
|
2605
2732
|
# ^
|
2606
2733
|
#
|
2734
|
+
# **Amazon RDS Custom**
|
2735
|
+
#
|
2736
|
+
# The Oracle System ID (SID) of the created RDS Custom DB instance. If
|
2737
|
+
# you don't specify a value, the default value is `ORCL`.
|
2738
|
+
#
|
2739
|
+
# Default: `ORCL`
|
2740
|
+
#
|
2741
|
+
# Constraints:
|
2742
|
+
#
|
2743
|
+
# * It must contain 1 to 8 alphanumeric characters.
|
2744
|
+
#
|
2745
|
+
# * It must contain a letter.
|
2746
|
+
#
|
2747
|
+
# * It can't be a word reserved by the database engine.
|
2748
|
+
#
|
2607
2749
|
# **SQL Server**
|
2608
2750
|
#
|
2609
2751
|
# Not applicable. Must be null.
|
@@ -2665,6 +2807,17 @@ module Aws::RDS
|
|
2665
2807
|
# amount of data in your database increases, though you are only
|
2666
2808
|
# charged for the space that you use in an Aurora cluster volume.
|
2667
2809
|
#
|
2810
|
+
# **Amazon RDS Custom**
|
2811
|
+
#
|
2812
|
+
# Constraints to the amount of storage for each storage type are the
|
2813
|
+
# following:
|
2814
|
+
#
|
2815
|
+
# * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
|
2816
|
+
# 65536.
|
2817
|
+
#
|
2818
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to
|
2819
|
+
# 65536.
|
2820
|
+
#
|
2668
2821
|
# **MySQL**
|
2669
2822
|
#
|
2670
2823
|
# Constraints to the amount of storage for each storage type are the
|
@@ -2770,6 +2923,8 @@ module Aws::RDS
|
|
2770
2923
|
#
|
2771
2924
|
# * `aurora-postgresql`
|
2772
2925
|
#
|
2926
|
+
# * `custom-oracle-ee (for RDS Custom instances)`
|
2927
|
+
#
|
2773
2928
|
# * `mariadb`
|
2774
2929
|
#
|
2775
2930
|
# * `mysql`
|
@@ -2970,6 +3125,8 @@ module Aws::RDS
|
|
2970
3125
|
# instance. If you do not specify a value, then the default DB
|
2971
3126
|
# parameter group for the specified DB engine and version is used.
|
2972
3127
|
#
|
3128
|
+
# This setting doesn't apply to RDS Custom.
|
3129
|
+
#
|
2973
3130
|
# Constraints:
|
2974
3131
|
#
|
2975
3132
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
@@ -2996,6 +3153,8 @@ module Aws::RDS
|
|
2996
3153
|
# * Must be a value from 0 to 35
|
2997
3154
|
#
|
2998
3155
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
3156
|
+
#
|
3157
|
+
# * Can't be set to 0 or 35 for an RDS Custom DB instance
|
2999
3158
|
# @return [Integer]
|
3000
3159
|
#
|
3001
3160
|
# @!attribute [rw] preferred_backup_window
|
@@ -3079,6 +3238,8 @@ module Aws::RDS
|
|
3079
3238
|
# A value that indicates whether the DB instance is a Multi-AZ
|
3080
3239
|
# deployment. You can't set the `AvailabilityZone` parameter if the
|
3081
3240
|
# DB instance is a Multi-AZ deployment.
|
3241
|
+
#
|
3242
|
+
# This setting doesn't apply to RDS Custom.
|
3082
3243
|
# @return [Boolean]
|
3083
3244
|
#
|
3084
3245
|
# @!attribute [rw] engine_version
|
@@ -3097,44 +3258,56 @@ module Aws::RDS
|
|
3097
3258
|
# Not applicable. The version number of the database engine to be used
|
3098
3259
|
# by the DB instance is managed by the DB cluster.
|
3099
3260
|
#
|
3261
|
+
# **Amazon RDS Custom**
|
3262
|
+
#
|
3263
|
+
# A custom engine version (CEV) that you have previously created. This
|
3264
|
+
# setting is required for RDS Custom. The CEV name has the following
|
3265
|
+
# format: `19.customized_string `. An example identifier is
|
3266
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom DB
|
3267
|
+
# instance][1] in the *Amazon RDS User Guide.*.
|
3268
|
+
#
|
3100
3269
|
# **MariaDB**
|
3101
3270
|
#
|
3102
|
-
# See [MariaDB on Amazon RDS Versions][
|
3271
|
+
# See [MariaDB on Amazon RDS Versions][2] in the *Amazon RDS User
|
3103
3272
|
# Guide.*
|
3104
3273
|
#
|
3105
3274
|
# **Microsoft SQL Server**
|
3106
3275
|
#
|
3107
|
-
# See [Microsoft SQL Server Versions on Amazon RDS][
|
3276
|
+
# See [Microsoft SQL Server Versions on Amazon RDS][3] in the *Amazon
|
3108
3277
|
# RDS User Guide.*
|
3109
3278
|
#
|
3110
3279
|
# **MySQL**
|
3111
3280
|
#
|
3112
|
-
# See [MySQL on Amazon RDS Versions][
|
3281
|
+
# See [MySQL on Amazon RDS Versions][4] in the *Amazon RDS User
|
3113
3282
|
# Guide.*
|
3114
3283
|
#
|
3115
3284
|
# **Oracle**
|
3116
3285
|
#
|
3117
|
-
# See [Oracle Database Engine Release Notes][
|
3286
|
+
# See [Oracle Database Engine Release Notes][5] in the *Amazon RDS
|
3118
3287
|
# User Guide.*
|
3119
3288
|
#
|
3120
3289
|
# **PostgreSQL**
|
3121
3290
|
#
|
3122
|
-
# See [Amazon RDS for PostgreSQL versions and extensions][
|
3291
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][6] in the
|
3123
3292
|
# *Amazon RDS User Guide.*
|
3124
3293
|
#
|
3125
3294
|
#
|
3126
3295
|
#
|
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/
|
3296
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
|
3297
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
|
3298
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
3299
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
3300
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
3301
|
+
# [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
3132
3302
|
# @return [String]
|
3133
3303
|
#
|
3134
3304
|
# @!attribute [rw] auto_minor_version_upgrade
|
3135
3305
|
# A value that indicates whether minor engine upgrades are applied
|
3136
3306
|
# automatically to the DB instance during the maintenance window. By
|
3137
3307
|
# default, minor engine upgrades are applied automatically.
|
3308
|
+
#
|
3309
|
+
# If you create an RDS Custom DB instance, you must set
|
3310
|
+
# `AutoMinorVersionUpgrade` to `false`.
|
3138
3311
|
# @return [Boolean]
|
3139
3312
|
#
|
3140
3313
|
# @!attribute [rw] license_model
|
@@ -3142,6 +3315,8 @@ module Aws::RDS
|
|
3142
3315
|
#
|
3143
3316
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
3144
3317
|
# `general-public-license`
|
3318
|
+
#
|
3319
|
+
# This setting doesn't apply to RDS Custom.
|
3145
3320
|
# @return [String]
|
3146
3321
|
#
|
3147
3322
|
# @!attribute [rw] iops
|
@@ -3166,13 +3341,18 @@ module Aws::RDS
|
|
3166
3341
|
#
|
3167
3342
|
# Permanent options, such as the TDE option for Oracle Advanced
|
3168
3343
|
# 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
|
3344
|
+
# option group can't be removed from a DB instance after it is
|
3345
|
+
# associated with a DB instance.
|
3346
|
+
#
|
3347
|
+
# This setting doesn't apply to RDS Custom.
|
3171
3348
|
# @return [String]
|
3172
3349
|
#
|
3173
3350
|
# @!attribute [rw] character_set_name
|
3174
|
-
# For supported engines, indicates that the DB instance
|
3175
|
-
# associated with the specified CharacterSet
|
3351
|
+
# For supported engines, this value indicates that the DB instance
|
3352
|
+
# should be associated with the specified `CharacterSet`.
|
3353
|
+
#
|
3354
|
+
# This setting doesn't apply to RDS Custom. However, if you need to
|
3355
|
+
# change the character set, you can change it on the database itself.
|
3176
3356
|
#
|
3177
3357
|
# **Amazon Aurora**
|
3178
3358
|
#
|
@@ -3182,6 +3362,8 @@ module Aws::RDS
|
|
3182
3362
|
#
|
3183
3363
|
# @!attribute [rw] nchar_character_set_name
|
3184
3364
|
# The name of the NCHAR character set for the Oracle DB instance.
|
3365
|
+
#
|
3366
|
+
# This parameter doesn't apply to RDS Custom.
|
3185
3367
|
# @return [String]
|
3186
3368
|
#
|
3187
3369
|
# @!attribute [rw] publicly_accessible
|
@@ -3226,6 +3408,8 @@ module Aws::RDS
|
|
3226
3408
|
#
|
3227
3409
|
# @!attribute [rw] db_cluster_identifier
|
3228
3410
|
# The identifier of the DB cluster that the instance will belong to.
|
3411
|
+
#
|
3412
|
+
# This setting doesn't apply to RDS Custom.
|
3229
3413
|
# @return [String]
|
3230
3414
|
#
|
3231
3415
|
# @!attribute [rw] storage_type
|
@@ -3242,17 +3426,25 @@ module Aws::RDS
|
|
3242
3426
|
# @!attribute [rw] tde_credential_arn
|
3243
3427
|
# The ARN from the key store with which to associate the instance for
|
3244
3428
|
# TDE encryption.
|
3429
|
+
#
|
3430
|
+
# This setting doesn't apply to RDS Custom.
|
3245
3431
|
# @return [String]
|
3246
3432
|
#
|
3247
3433
|
# @!attribute [rw] tde_credential_password
|
3248
3434
|
# The password for the given ARN from the key store in order to access
|
3249
3435
|
# the device.
|
3436
|
+
#
|
3437
|
+
# This setting doesn't apply to RDS Custom.
|
3250
3438
|
# @return [String]
|
3251
3439
|
#
|
3252
3440
|
# @!attribute [rw] storage_encrypted
|
3253
3441
|
# A value that indicates whether the DB instance is encrypted. By
|
3254
3442
|
# default, it isn't encrypted.
|
3255
3443
|
#
|
3444
|
+
# For RDS Custom Oracle instances, either set this parameter to `true`
|
3445
|
+
# or leave it unset. If you set this parameter to `false`, RDS reports
|
3446
|
+
# an error.
|
3447
|
+
#
|
3256
3448
|
# **Amazon Aurora**
|
3257
3449
|
#
|
3258
3450
|
# Not applicable. The encryption for DB instances is managed by the DB
|
@@ -3264,9 +3456,9 @@ module Aws::RDS
|
|
3264
3456
|
# instance.
|
3265
3457
|
#
|
3266
3458
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3267
|
-
# alias ARN, or alias name for the
|
3268
|
-
#
|
3269
|
-
#
|
3459
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
3460
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
3461
|
+
# ARN.
|
3270
3462
|
#
|
3271
3463
|
# **Amazon Aurora**
|
3272
3464
|
#
|
@@ -3275,10 +3467,18 @@ module Aws::RDS
|
|
3275
3467
|
# `CreateDBCluster`.
|
3276
3468
|
#
|
3277
3469
|
# 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.
|
3470
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
|
3471
|
+
# There is a default KMS key for your Amazon Web Services account.
|
3472
|
+
# Your Amazon Web Services account has a different default KMS key for
|
3473
|
+
# each Amazon Web Services Region.
|
3474
|
+
#
|
3475
|
+
# **Amazon RDS Custom**
|
3476
|
+
#
|
3477
|
+
# A KMS key is required for RDS Custom Oracle instances. For most RDS
|
3478
|
+
# engines, if you leave this parameter empty while enabling
|
3479
|
+
# `StorageEncrypted`, the engine uses the default KMS key. However,
|
3480
|
+
# RDS Custom for Oracle doesn't use the default key when this
|
3481
|
+
# parameter is empty. You must explicitly specify a key.
|
3282
3482
|
# @return [String]
|
3283
3483
|
#
|
3284
3484
|
# @!attribute [rw] domain
|
@@ -3289,6 +3489,8 @@ module Aws::RDS
|
|
3289
3489
|
# For more information, see [ Kerberos Authentication][1] in the
|
3290
3490
|
# *Amazon RDS User Guide*.
|
3291
3491
|
#
|
3492
|
+
# This setting doesn't apply to RDS Custom.
|
3493
|
+
#
|
3292
3494
|
#
|
3293
3495
|
#
|
3294
3496
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -3307,12 +3509,14 @@ module Aws::RDS
|
|
3307
3509
|
#
|
3308
3510
|
# @!attribute [rw] monitoring_interval
|
3309
3511
|
# The interval, in seconds, between points when Enhanced Monitoring
|
3310
|
-
# metrics are collected for the DB instance. To disable
|
3512
|
+
# metrics are collected for the DB instance. To disable collection of
|
3311
3513
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
3312
3514
|
#
|
3313
|
-
# If `MonitoringRoleArn` is specified, then you must
|
3515
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
3314
3516
|
# `MonitoringInterval` to a value other than 0.
|
3315
3517
|
#
|
3518
|
+
# This setting doesn't apply to RDS Custom.
|
3519
|
+
#
|
3316
3520
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
3317
3521
|
# @return [Integer]
|
3318
3522
|
#
|
@@ -3320,12 +3524,14 @@ module Aws::RDS
|
|
3320
3524
|
# The ARN for the IAM role that permits RDS to send enhanced
|
3321
3525
|
# monitoring metrics to Amazon CloudWatch Logs. For example,
|
3322
3526
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on
|
3323
|
-
# creating a monitoring role,
|
3527
|
+
# creating a monitoring role, see [Setting Up and Enabling Enhanced
|
3324
3528
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
3325
3529
|
#
|
3326
3530
|
# If `MonitoringInterval` is set to a value other than 0, then you
|
3327
3531
|
# must supply a `MonitoringRoleArn` value.
|
3328
3532
|
#
|
3533
|
+
# This setting doesn't apply to RDS Custom.
|
3534
|
+
#
|
3329
3535
|
#
|
3330
3536
|
#
|
3331
3537
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
@@ -3334,6 +3540,8 @@ module Aws::RDS
|
|
3334
3540
|
# @!attribute [rw] domain_iam_role_name
|
3335
3541
|
# Specify the name of the IAM role to be used when making API calls to
|
3336
3542
|
# the Directory Service.
|
3543
|
+
#
|
3544
|
+
# This setting doesn't apply to RDS Custom.
|
3337
3545
|
# @return [String]
|
3338
3546
|
#
|
3339
3547
|
# @!attribute [rw] promotion_tier
|
@@ -3342,6 +3550,8 @@ module Aws::RDS
|
|
3342
3550
|
# primary instance. For more information, see [ Fault Tolerance for an
|
3343
3551
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
3344
3552
|
#
|
3553
|
+
# This setting doesn't apply to RDS Custom.
|
3554
|
+
#
|
3345
3555
|
# Default: 1
|
3346
3556
|
#
|
3347
3557
|
# Valid Values: 0 - 15
|
@@ -3365,9 +3575,9 @@ module Aws::RDS
|
|
3365
3575
|
# Services Identity and Access Management (IAM) accounts to database
|
3366
3576
|
# accounts. By default, mapping is disabled.
|
3367
3577
|
#
|
3368
|
-
# This setting doesn't apply to Amazon Aurora.
|
3369
|
-
# Services IAM accounts to database
|
3370
|
-
# cluster.
|
3578
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora. In
|
3579
|
+
# Aurora, mapping Amazon Web Services IAM accounts to database
|
3580
|
+
# accounts is managed by the DB cluster.
|
3371
3581
|
#
|
3372
3582
|
# For more information, see [ IAM Database Authentication for MySQL
|
3373
3583
|
# and PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -3379,10 +3589,10 @@ module Aws::RDS
|
|
3379
3589
|
#
|
3380
3590
|
# @!attribute [rw] enable_performance_insights
|
3381
3591
|
# A value that indicates whether to enable Performance Insights for
|
3382
|
-
# the DB instance.
|
3592
|
+
# the DB instance. For more information, see [Using Amazon Performance
|
3593
|
+
# Insights][1] in the *Amazon Relational Database Service User Guide*.
|
3383
3594
|
#
|
3384
|
-
#
|
3385
|
-
# the *Amazon Relational Database Service User Guide*.
|
3595
|
+
# This setting doesn't apply to RDS Custom.
|
3386
3596
|
#
|
3387
3597
|
#
|
3388
3598
|
#
|
@@ -3394,32 +3604,39 @@ module Aws::RDS
|
|
3394
3604
|
# Performance Insights data.
|
3395
3605
|
#
|
3396
3606
|
# 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).
|
3607
|
+
# alias ARN, or alias name for the KMS key.
|
3399
3608
|
#
|
3400
3609
|
# 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
|
3610
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
3611
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
3612
|
+
# account has a different default KMS key for each Amazon Web Services
|
3613
|
+
# Region.
|
3614
|
+
#
|
3615
|
+
# This setting doesn't apply to RDS Custom.
|
3404
3616
|
# @return [String]
|
3405
3617
|
#
|
3406
3618
|
# @!attribute [rw] performance_insights_retention_period
|
3407
3619
|
# The amount of time, in days, to retain Performance Insights data.
|
3408
3620
|
# Valid values are 7 or 731 (2 years).
|
3621
|
+
#
|
3622
|
+
# This setting doesn't apply to RDS Custom.
|
3409
3623
|
# @return [Integer]
|
3410
3624
|
#
|
3411
3625
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
3412
3626
|
# 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*.
|
3627
|
+
# CloudWatch Logs. The values in the list depend on the DB engine. For
|
3628
|
+
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
3629
|
+
# Logs][1] in the *Amazon Relational Database Service User Guide*.
|
3417
3630
|
#
|
3418
3631
|
# **Amazon Aurora**
|
3419
3632
|
#
|
3420
3633
|
# Not applicable. CloudWatch Logs exports are managed by the DB
|
3421
3634
|
# cluster.
|
3422
3635
|
#
|
3636
|
+
# **RDS Custom**
|
3637
|
+
#
|
3638
|
+
# Not applicable.
|
3639
|
+
#
|
3423
3640
|
# **MariaDB**
|
3424
3641
|
#
|
3425
3642
|
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
@@ -3449,6 +3666,8 @@ module Aws::RDS
|
|
3449
3666
|
# @!attribute [rw] processor_features
|
3450
3667
|
# The number of CPU cores and the number of threads per core for the
|
3451
3668
|
# DB instance class of the DB instance.
|
3669
|
+
#
|
3670
|
+
# This setting doesn't apply to RDS Custom.
|
3452
3671
|
# @return [Array<Types::ProcessorFeature>]
|
3453
3672
|
#
|
3454
3673
|
# @!attribute [rw] deletion_protection
|
@@ -3477,6 +3696,8 @@ module Aws::RDS
|
|
3477
3696
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3478
3697
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3479
3698
|
#
|
3699
|
+
# This setting doesn't apply to RDS Custom.
|
3700
|
+
#
|
3480
3701
|
#
|
3481
3702
|
#
|
3482
3703
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -3505,6 +3726,30 @@ module Aws::RDS
|
|
3505
3726
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
3506
3727
|
# @return [Boolean]
|
3507
3728
|
#
|
3729
|
+
# @!attribute [rw] custom_iam_instance_profile
|
3730
|
+
# The instance profile associated with the underlying Amazon EC2
|
3731
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
3732
|
+
# meet the following requirements:
|
3733
|
+
#
|
3734
|
+
# * The profile must exist in your account.
|
3735
|
+
#
|
3736
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
3737
|
+
# to assume.
|
3738
|
+
#
|
3739
|
+
# * The instance profile name and the associated IAM role name must
|
3740
|
+
# start with the prefix `AWSRDSCustom`.
|
3741
|
+
#
|
3742
|
+
# For the list of permissions required for the IAM role, see [
|
3743
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
3744
|
+
# Service User Guide*.
|
3745
|
+
#
|
3746
|
+
# This setting is required for RDS Custom.
|
3747
|
+
#
|
3748
|
+
#
|
3749
|
+
#
|
3750
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
3751
|
+
# @return [String]
|
3752
|
+
#
|
3508
3753
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
3509
3754
|
#
|
3510
3755
|
class CreateDBInstanceMessage < Struct.new(
|
@@ -3555,7 +3800,8 @@ module Aws::RDS
|
|
3555
3800
|
:processor_features,
|
3556
3801
|
:deletion_protection,
|
3557
3802
|
:max_allocated_storage,
|
3558
|
-
:enable_customer_owned_ip
|
3803
|
+
:enable_customer_owned_ip,
|
3804
|
+
:custom_iam_instance_profile)
|
3559
3805
|
SENSITIVE = []
|
3560
3806
|
include Aws::Structure
|
3561
3807
|
end
|
@@ -3606,6 +3852,7 @@ module Aws::RDS
|
|
3606
3852
|
# domain_iam_role_name: "String",
|
3607
3853
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
3608
3854
|
# max_allocated_storage: 1,
|
3855
|
+
# custom_iam_instance_profile: "String",
|
3609
3856
|
# source_region: "String",
|
3610
3857
|
# }
|
3611
3858
|
#
|
@@ -3649,8 +3896,8 @@ module Aws::RDS
|
|
3649
3896
|
# * If the source DB instance is in a different Amazon Web Services
|
3650
3897
|
# Region from the read replica, specify a valid DB instance ARN. For
|
3651
3898
|
# 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
|
3899
|
+
# the *Amazon RDS User Guide*. This doesn't apply to SQL Server or
|
3900
|
+
# RDS Custom, which don't support cross-Region replicas.
|
3654
3901
|
#
|
3655
3902
|
#
|
3656
3903
|
#
|
@@ -3699,12 +3946,16 @@ module Aws::RDS
|
|
3699
3946
|
# support for the replica. Creating your read replica as a Multi-AZ DB
|
3700
3947
|
# instance is independent of whether the source database is a Multi-AZ
|
3701
3948
|
# DB instance.
|
3949
|
+
#
|
3950
|
+
# This setting doesn't apply to RDS Custom.
|
3702
3951
|
# @return [Boolean]
|
3703
3952
|
#
|
3704
3953
|
# @!attribute [rw] auto_minor_version_upgrade
|
3705
3954
|
# A value that indicates whether minor engine upgrades are applied
|
3706
3955
|
# automatically to the read replica during the maintenance window.
|
3707
3956
|
#
|
3957
|
+
# This setting doesn't apply to RDS Custom.
|
3958
|
+
#
|
3708
3959
|
# Default: Inherits from the source DB instance
|
3709
3960
|
# @return [Boolean]
|
3710
3961
|
#
|
@@ -3721,6 +3972,8 @@ module Aws::RDS
|
|
3721
3972
|
# source instance.
|
3722
3973
|
#
|
3723
3974
|
# </note>
|
3975
|
+
#
|
3976
|
+
# This setting doesn't apply to RDS Custom.
|
3724
3977
|
# @return [String]
|
3725
3978
|
#
|
3726
3979
|
# @!attribute [rw] db_parameter_group_name
|
@@ -3732,10 +3985,8 @@ module Aws::RDS
|
|
3732
3985
|
# same region read replica, or the default `DBParameterGroup` for the
|
3733
3986
|
# specified DB engine for a cross region read replica.
|
3734
3987
|
#
|
3735
|
-
#
|
3736
|
-
#
|
3737
|
-
#
|
3738
|
-
# </note>
|
3988
|
+
# Specifying a parameter group for this operation is only supported
|
3989
|
+
# for Oracle DB instances. It isn't supported for RDS Custom.
|
3739
3990
|
#
|
3740
3991
|
# Constraints:
|
3741
3992
|
#
|
@@ -3801,9 +4052,11 @@ module Aws::RDS
|
|
3801
4052
|
# @return [String]
|
3802
4053
|
#
|
3803
4054
|
# @!attribute [rw] vpc_security_group_ids
|
3804
|
-
# A list of EC2 VPC security groups to associate with the read
|
4055
|
+
# A list of Amazon EC2 VPC security groups to associate with the read
|
3805
4056
|
# replica.
|
3806
4057
|
#
|
4058
|
+
# This setting doesn't apply to RDS Custom.
|
4059
|
+
#
|
3807
4060
|
# Default: The default EC2 VPC security group for the DB subnet
|
3808
4061
|
# group's VPC.
|
3809
4062
|
# @return [Array<String>]
|
@@ -3833,6 +4086,8 @@ module Aws::RDS
|
|
3833
4086
|
# If `MonitoringRoleArn` is specified, then you must also set
|
3834
4087
|
# `MonitoringInterval` to a value other than 0.
|
3835
4088
|
#
|
4089
|
+
# This setting doesn't apply to RDS Custom.
|
4090
|
+
#
|
3836
4091
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
3837
4092
|
# @return [Integer]
|
3838
4093
|
#
|
@@ -3846,6 +4101,8 @@ module Aws::RDS
|
|
3846
4101
|
# If `MonitoringInterval` is set to a value other than 0, then you
|
3847
4102
|
# must supply a `MonitoringRoleArn` value.
|
3848
4103
|
#
|
4104
|
+
# This setting doesn't apply to RDS Custom.
|
4105
|
+
#
|
3849
4106
|
#
|
3850
4107
|
#
|
3851
4108
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
@@ -3856,23 +4113,26 @@ module Aws::RDS
|
|
3856
4113
|
# replica.
|
3857
4114
|
#
|
3858
4115
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3859
|
-
# alias ARN, or alias name for the
|
4116
|
+
# alias ARN, or alias name for the KMS key.
|
3860
4117
|
#
|
3861
4118
|
# If you create an encrypted read replica in the same Amazon Web
|
3862
4119
|
# 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
|
4120
|
+
# value for this parameter. A read replica in the same Amazon Web
|
4121
|
+
# Services Region is always encrypted with the same KMS key as the
|
3865
4122
|
# source DB instance.
|
3866
4123
|
#
|
3867
4124
|
# 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
|
4125
|
+
# Services Region, then you must specify a KMS key identifier for the
|
4126
|
+
# destination Amazon Web Services Region. KMS keys are specific to the
|
4127
|
+
# Amazon Web Services Region that they are created in, and you can't
|
4128
|
+
# use KMS keys from one Amazon Web Services Region in another Amazon
|
4129
|
+
# Web Services Region.
|
3873
4130
|
#
|
3874
4131
|
# You can't create an encrypted read replica from an unencrypted DB
|
3875
4132
|
# instance.
|
4133
|
+
#
|
4134
|
+
# This setting doesn't apply to RDS Custom, which uses the same KMS
|
4135
|
+
# key as the primary replica.
|
3876
4136
|
# @return [String]
|
3877
4137
|
#
|
3878
4138
|
# @!attribute [rw] pre_signed_url
|
@@ -3939,6 +4199,8 @@ module Aws::RDS
|
|
3939
4199
|
#
|
3940
4200
|
# </note>
|
3941
4201
|
#
|
4202
|
+
# This setting doesn't apply to RDS Custom.
|
4203
|
+
#
|
3942
4204
|
#
|
3943
4205
|
#
|
3944
4206
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -3954,6 +4216,8 @@ module Aws::RDS
|
|
3954
4216
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
3955
4217
|
# RDS User Guide.*
|
3956
4218
|
#
|
4219
|
+
# This setting doesn't apply to RDS Custom.
|
4220
|
+
#
|
3957
4221
|
#
|
3958
4222
|
#
|
3959
4223
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -3966,6 +4230,8 @@ module Aws::RDS
|
|
3966
4230
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3967
4231
|
# the *Amazon RDS User Guide*.
|
3968
4232
|
#
|
4233
|
+
# This setting doesn't apply to RDS Custom.
|
4234
|
+
#
|
3969
4235
|
#
|
3970
4236
|
#
|
3971
4237
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -3976,18 +4242,22 @@ module Aws::RDS
|
|
3976
4242
|
# Performance Insights data.
|
3977
4243
|
#
|
3978
4244
|
# 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).
|
4245
|
+
# alias ARN, or alias name for the KMS key.
|
3981
4246
|
#
|
3982
4247
|
# 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
|
4248
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
4249
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
4250
|
+
# account has a different default KMS key for each Amazon Web Services
|
4251
|
+
# Region.
|
4252
|
+
#
|
4253
|
+
# This setting doesn't apply to RDS Custom.
|
3986
4254
|
# @return [String]
|
3987
4255
|
#
|
3988
4256
|
# @!attribute [rw] performance_insights_retention_period
|
3989
4257
|
# The amount of time, in days, to retain Performance Insights data.
|
3990
4258
|
# Valid values are 7 or 731 (2 years).
|
4259
|
+
#
|
4260
|
+
# This setting doesn't apply to RDS Custom.
|
3991
4261
|
# @return [Integer]
|
3992
4262
|
#
|
3993
4263
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -3996,6 +4266,8 @@ module Aws::RDS
|
|
3996
4266
|
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
3997
4267
|
# Logs ][1] in the *Amazon RDS User Guide*.
|
3998
4268
|
#
|
4269
|
+
# This setting doesn't apply to RDS Custom.
|
4270
|
+
#
|
3999
4271
|
#
|
4000
4272
|
#
|
4001
4273
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -4004,11 +4276,15 @@ module Aws::RDS
|
|
4004
4276
|
# @!attribute [rw] processor_features
|
4005
4277
|
# The number of CPU cores and the number of threads per core for the
|
4006
4278
|
# DB instance class of the DB instance.
|
4279
|
+
#
|
4280
|
+
# This setting doesn't apply to RDS Custom.
|
4007
4281
|
# @return [Array<Types::ProcessorFeature>]
|
4008
4282
|
#
|
4009
4283
|
# @!attribute [rw] use_default_processor_features
|
4010
4284
|
# A value that indicates whether the DB instance class of the DB
|
4011
4285
|
# instance uses its default processor features.
|
4286
|
+
#
|
4287
|
+
# This setting doesn't apply to RDS Custom.
|
4012
4288
|
# @return [Boolean]
|
4013
4289
|
#
|
4014
4290
|
# @!attribute [rw] deletion_protection
|
@@ -4030,6 +4306,8 @@ module Aws::RDS
|
|
4030
4306
|
# For more information, see [ Kerberos Authentication][1] in the
|
4031
4307
|
# *Amazon RDS User Guide*.
|
4032
4308
|
#
|
4309
|
+
# This setting doesn't apply to RDS Custom.
|
4310
|
+
#
|
4033
4311
|
#
|
4034
4312
|
#
|
4035
4313
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -4038,6 +4316,8 @@ module Aws::RDS
|
|
4038
4316
|
# @!attribute [rw] domain_iam_role_name
|
4039
4317
|
# Specify the name of the IAM role to be used when making API calls to
|
4040
4318
|
# the Directory Service.
|
4319
|
+
#
|
4320
|
+
# This setting doesn't apply to RDS Custom.
|
4041
4321
|
# @return [String]
|
4042
4322
|
#
|
4043
4323
|
# @!attribute [rw] replica_mode
|
@@ -4047,18 +4327,22 @@ module Aws::RDS
|
|
4047
4327
|
#
|
4048
4328
|
# </note>
|
4049
4329
|
#
|
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.
|
4330
|
+
# Mounted DB replicas are included in Oracle Database Enterprise
|
4331
|
+
# Edition. The main use case for mounted replicas is cross-Region
|
4332
|
+
# disaster recovery. The primary database doesn't use Active Data
|
4333
|
+
# Guard to transmit information to the mounted replica. Because it
|
4334
|
+
# doesn't accept user connections, a mounted replica can't serve a
|
4335
|
+
# read-only workload.
|
4056
4336
|
#
|
4057
4337
|
# You can create a combination of mounted and read-only DB replicas
|
4058
4338
|
# for the same primary DB instance. For more information, see [Working
|
4059
4339
|
# with Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
|
4060
4340
|
# Guide*.
|
4061
4341
|
#
|
4342
|
+
# For RDS Custom, you must specify this parameter and set it to
|
4343
|
+
# `mounted`. The value won't be set by default. After replica
|
4344
|
+
# creation, you can manage the open mode manually.
|
4345
|
+
#
|
4062
4346
|
#
|
4063
4347
|
#
|
4064
4348
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -4077,6 +4361,30 @@ module Aws::RDS
|
|
4077
4361
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
4078
4362
|
# @return [Integer]
|
4079
4363
|
#
|
4364
|
+
# @!attribute [rw] custom_iam_instance_profile
|
4365
|
+
# The instance profile associated with the underlying Amazon EC2
|
4366
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
4367
|
+
# meet the following requirements:
|
4368
|
+
#
|
4369
|
+
# * The profile must exist in your account.
|
4370
|
+
#
|
4371
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
4372
|
+
# to assume.
|
4373
|
+
#
|
4374
|
+
# * The instance profile name and the associated IAM role name must
|
4375
|
+
# start with the prefix `AWSRDSCustom`.
|
4376
|
+
#
|
4377
|
+
# For the list of permissions required for the IAM role, see [
|
4378
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
4379
|
+
# Service User Guide*.
|
4380
|
+
#
|
4381
|
+
# This setting is required for RDS Custom.
|
4382
|
+
#
|
4383
|
+
#
|
4384
|
+
#
|
4385
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
4386
|
+
# @return [String]
|
4387
|
+
#
|
4080
4388
|
# @!attribute [rw] source_region
|
4081
4389
|
# The source region of the snapshot. This is only needed when the
|
4082
4390
|
# shapshot is encrypted and in a different region.
|
@@ -4117,6 +4425,7 @@ module Aws::RDS
|
|
4117
4425
|
:domain_iam_role_name,
|
4118
4426
|
:replica_mode,
|
4119
4427
|
:max_allocated_storage,
|
4428
|
+
:custom_iam_instance_profile,
|
4120
4429
|
:source_region)
|
4121
4430
|
SENSITIVE = []
|
4122
4431
|
include Aws::Structure
|
@@ -5044,6 +5353,24 @@ module Aws::RDS
|
|
5044
5353
|
#
|
5045
5354
|
class CustomAvailabilityZoneQuotaExceededFault < Aws::EmptyStructure; end
|
5046
5355
|
|
5356
|
+
# A CEV with the specified name already exists.
|
5357
|
+
#
|
5358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionAlreadyExistsFault AWS API Documentation
|
5359
|
+
#
|
5360
|
+
class CustomDBEngineVersionAlreadyExistsFault < Aws::EmptyStructure; end
|
5361
|
+
|
5362
|
+
# The specified CEV was not found.
|
5363
|
+
#
|
5364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionNotFoundFault AWS API Documentation
|
5365
|
+
#
|
5366
|
+
class CustomDBEngineVersionNotFoundFault < Aws::EmptyStructure; end
|
5367
|
+
|
5368
|
+
# You have exceeded your CEV quota.
|
5369
|
+
#
|
5370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionQuotaExceededFault AWS API Documentation
|
5371
|
+
#
|
5372
|
+
class CustomDBEngineVersionQuotaExceededFault < Aws::EmptyStructure; end
|
5373
|
+
|
5047
5374
|
# Contains the details of an Amazon Aurora DB cluster.
|
5048
5375
|
#
|
5049
5376
|
# This data type is used as a response element in the
|
@@ -5211,15 +5538,14 @@ module Aws::RDS
|
|
5211
5538
|
# identifier for the encrypted DB cluster.
|
5212
5539
|
#
|
5213
5540
|
# 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).
|
5541
|
+
# alias ARN, or alias name for the KMS key.
|
5216
5542
|
# @return [String]
|
5217
5543
|
#
|
5218
5544
|
# @!attribute [rw] db_cluster_resource_id
|
5219
5545
|
# The Amazon Web Services Region-unique, immutable identifier for the
|
5220
5546
|
# DB cluster. This identifier is found in Amazon Web Services
|
5221
|
-
# CloudTrail log entries whenever the
|
5222
|
-
#
|
5547
|
+
# CloudTrail log entries whenever the KMS key for the DB cluster is
|
5548
|
+
# accessed.
|
5223
5549
|
# @return [String]
|
5224
5550
|
#
|
5225
5551
|
# @!attribute [rw] db_cluster_arn
|
@@ -5348,8 +5674,7 @@ module Aws::RDS
|
|
5348
5674
|
# messages in the database activity stream.
|
5349
5675
|
#
|
5350
5676
|
# 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).
|
5677
|
+
# alias ARN, or alias name for the KMS key.
|
5353
5678
|
# @return [String]
|
5354
5679
|
#
|
5355
5680
|
# @!attribute [rw] activity_stream_kinesis_stream_name
|
@@ -5937,8 +6262,8 @@ module Aws::RDS
|
|
5937
6262
|
#
|
5938
6263
|
# @!attribute [rw] feature_name
|
5939
6264
|
# The name of the feature associated with the Amazon Web Services
|
5940
|
-
# Identity and Access Management (IAM) role. For
|
5941
|
-
# feature names, see DBEngineVersion.
|
6265
|
+
# Identity and Access Management (IAM) role. For information about
|
6266
|
+
# supported feature names, see DBEngineVersion.
|
5942
6267
|
# @return [String]
|
5943
6268
|
#
|
5944
6269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBClusterRole AWS API Documentation
|
@@ -6059,8 +6384,7 @@ module Aws::RDS
|
|
6059
6384
|
# identifier for the encrypted DB cluster snapshot.
|
6060
6385
|
#
|
6061
6386
|
# 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).
|
6387
|
+
# alias ARN, or alias name for the KMS key.
|
6064
6388
|
# @return [String]
|
6065
6389
|
#
|
6066
6390
|
# @!attribute [rw] db_cluster_snapshot_arn
|
@@ -6287,12 +6611,24 @@ module Aws::RDS
|
|
6287
6611
|
# @return [Array<String>]
|
6288
6612
|
#
|
6289
6613
|
# @!attribute [rw] supported_feature_names
|
6290
|
-
# A list of features supported by the DB engine.
|
6291
|
-
# names include the following.
|
6614
|
+
# A list of features supported by the DB engine.
|
6292
6615
|
#
|
6293
|
-
#
|
6616
|
+
# The supported features vary by DB engine and DB engine version.
|
6294
6617
|
#
|
6295
|
-
#
|
6618
|
+
# To determine the supported features for a specific DB engine and DB
|
6619
|
+
# engine version using the CLI, use the following command:
|
6620
|
+
#
|
6621
|
+
# `aws rds describe-db-engine-versions --engine <engine_name>
|
6622
|
+
# --engine-version <engine_version>`
|
6623
|
+
#
|
6624
|
+
# For example, to determine the supported features for RDS for
|
6625
|
+
# PostgreSQL version 13.3 using the CLI, use the following command:
|
6626
|
+
#
|
6627
|
+
# `aws rds describe-db-engine-versions --engine postgres
|
6628
|
+
# --engine-version 13.3`
|
6629
|
+
#
|
6630
|
+
# The supported features are listed under `SupportedFeatureNames` in
|
6631
|
+
# the output.
|
6296
6632
|
# @return [Array<String>]
|
6297
6633
|
#
|
6298
6634
|
# @!attribute [rw] status
|
@@ -6310,6 +6646,43 @@ module Aws::RDS
|
|
6310
6646
|
# with a specific DB engine version.
|
6311
6647
|
# @return [Boolean]
|
6312
6648
|
#
|
6649
|
+
# @!attribute [rw] major_engine_version
|
6650
|
+
# The major engine version of the CEV.
|
6651
|
+
# @return [String]
|
6652
|
+
#
|
6653
|
+
# @!attribute [rw] database_installation_files_s3_bucket_name
|
6654
|
+
# The name of the Amazon S3 bucket that contains your database
|
6655
|
+
# installation files.
|
6656
|
+
# @return [String]
|
6657
|
+
#
|
6658
|
+
# @!attribute [rw] database_installation_files_s3_prefix
|
6659
|
+
# The Amazon S3 directory that contains the database installation
|
6660
|
+
# files. If not specified, then no prefix is assumed.
|
6661
|
+
# @return [String]
|
6662
|
+
#
|
6663
|
+
# @!attribute [rw] db_engine_version_arn
|
6664
|
+
# The ARN of the custom engine version.
|
6665
|
+
# @return [String]
|
6666
|
+
#
|
6667
|
+
# @!attribute [rw] kms_key_id
|
6668
|
+
# The Amazon Web Services KMS key identifier for an encrypted CEV.
|
6669
|
+
# This parameter is required for RDS Custom, but optional for Amazon
|
6670
|
+
# RDS.
|
6671
|
+
# @return [String]
|
6672
|
+
#
|
6673
|
+
# @!attribute [rw] create_time
|
6674
|
+
# The creation time of the DB engine version.
|
6675
|
+
# @return [Time]
|
6676
|
+
#
|
6677
|
+
# @!attribute [rw] tag_list
|
6678
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
6679
|
+
# Resources][1] in the *Amazon RDS User Guide.*
|
6680
|
+
#
|
6681
|
+
#
|
6682
|
+
#
|
6683
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
6684
|
+
# @return [Array<Types::Tag>]
|
6685
|
+
#
|
6313
6686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBEngineVersion AWS API Documentation
|
6314
6687
|
#
|
6315
6688
|
class DBEngineVersion < Struct.new(
|
@@ -6330,7 +6703,14 @@ module Aws::RDS
|
|
6330
6703
|
:supported_feature_names,
|
6331
6704
|
:status,
|
6332
6705
|
:supports_parallel_query,
|
6333
|
-
:supports_global_databases
|
6706
|
+
:supports_global_databases,
|
6707
|
+
:major_engine_version,
|
6708
|
+
:database_installation_files_s3_bucket_name,
|
6709
|
+
:database_installation_files_s3_prefix,
|
6710
|
+
:db_engine_version_arn,
|
6711
|
+
:kms_key_id,
|
6712
|
+
:create_time,
|
6713
|
+
:tag_list)
|
6334
6714
|
SENSITIVE = []
|
6335
6715
|
include Aws::Structure
|
6336
6716
|
end
|
@@ -6486,7 +6866,8 @@ module Aws::RDS
|
|
6486
6866
|
# @return [Time]
|
6487
6867
|
#
|
6488
6868
|
# @!attribute [rw] multi_az
|
6489
|
-
# Specifies if the DB instance is a Multi-AZ deployment.
|
6869
|
+
# Specifies if the DB instance is a Multi-AZ deployment. This setting
|
6870
|
+
# doesn't apply to RDS Custom.
|
6490
6871
|
# @return [Boolean]
|
6491
6872
|
#
|
6492
6873
|
# @!attribute [rw] engine_version
|
@@ -6537,7 +6918,8 @@ module Aws::RDS
|
|
6537
6918
|
# @return [String]
|
6538
6919
|
#
|
6539
6920
|
# @!attribute [rw] license_model
|
6540
|
-
# License model information for this DB instance.
|
6921
|
+
# License model information for this DB instance. This setting
|
6922
|
+
# doesn't apply to RDS Custom.
|
6541
6923
|
# @return [String]
|
6542
6924
|
#
|
6543
6925
|
# @!attribute [rw] iops
|
@@ -6614,15 +6996,14 @@ module Aws::RDS
|
|
6614
6996
|
# identifier for the encrypted DB instance.
|
6615
6997
|
#
|
6616
6998
|
# 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).
|
6999
|
+
# alias ARN, or alias name for the KMS key.
|
6619
7000
|
# @return [String]
|
6620
7001
|
#
|
6621
7002
|
# @!attribute [rw] dbi_resource_id
|
6622
7003
|
# The Amazon Web Services Region-unique, immutable identifier for the
|
6623
7004
|
# DB instance. This identifier is found in Amazon Web Services
|
6624
|
-
# CloudTrail log entries whenever the Amazon Web Services KMS
|
6625
|
-
#
|
7005
|
+
# CloudTrail log entries whenever the Amazon Web Services KMS key for
|
7006
|
+
# the DB instance is accessed.
|
6626
7007
|
# @return [String]
|
6627
7008
|
#
|
6628
7009
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -6708,8 +7089,7 @@ module Aws::RDS
|
|
6708
7089
|
# Performance Insights data.
|
6709
7090
|
#
|
6710
7091
|
# 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).
|
7092
|
+
# alias ARN, or alias name for the KMS key.
|
6713
7093
|
# @return [String]
|
6714
7094
|
#
|
6715
7095
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -6809,7 +7189,7 @@ module Aws::RDS
|
|
6809
7189
|
# The Amazon Web Services KMS key identifier used for encrypting
|
6810
7190
|
# messages in the database activity stream. The Amazon Web Services
|
6811
7191
|
# KMS key identifier is the key ARN, key ID, alias ARN, or alias name
|
6812
|
-
# for the
|
7192
|
+
# for the KMS key.
|
6813
7193
|
# @return [String]
|
6814
7194
|
#
|
6815
7195
|
# @!attribute [rw] activity_stream_kinesis_stream_name
|
@@ -6828,6 +7208,41 @@ module Aws::RDS
|
|
6828
7208
|
# database activity stream.
|
6829
7209
|
# @return [Boolean]
|
6830
7210
|
#
|
7211
|
+
# @!attribute [rw] automation_mode
|
7212
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
7213
|
+
# paused`. If `full`, the DB instance automates monitoring and
|
7214
|
+
# instance recovery. If `all paused`, the instance pauses automation
|
7215
|
+
# for the duration set by `--resume-full-automation-mode-minutes`.
|
7216
|
+
# @return [String]
|
7217
|
+
#
|
7218
|
+
# @!attribute [rw] resume_full_automation_mode_time
|
7219
|
+
# The number of minutes to pause the automation. When the time period
|
7220
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
7221
|
+
# (default). The maximum value is 1,440.
|
7222
|
+
# @return [Time]
|
7223
|
+
#
|
7224
|
+
# @!attribute [rw] custom_iam_instance_profile
|
7225
|
+
# The instance profile associated with the underlying Amazon EC2
|
7226
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
7227
|
+
# meet the following requirements:
|
7228
|
+
#
|
7229
|
+
# * The profile must exist in your account.
|
7230
|
+
#
|
7231
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
7232
|
+
# to assume.
|
7233
|
+
#
|
7234
|
+
# * The instance profile name and the associated IAM role name must
|
7235
|
+
# start with the prefix `AWSRDSCustom`.
|
7236
|
+
#
|
7237
|
+
# For the list of permissions required for the IAM role, see [
|
7238
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
7239
|
+
# Service User Guide*.
|
7240
|
+
#
|
7241
|
+
#
|
7242
|
+
#
|
7243
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
7244
|
+
# @return [String]
|
7245
|
+
#
|
6831
7246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
|
6832
7247
|
#
|
6833
7248
|
class DBInstance < Struct.new(
|
@@ -6900,7 +7315,10 @@ module Aws::RDS
|
|
6900
7315
|
:activity_stream_kms_key_id,
|
6901
7316
|
:activity_stream_kinesis_stream_name,
|
6902
7317
|
:activity_stream_mode,
|
6903
|
-
:activity_stream_engine_native_audit_fields_included
|
7318
|
+
:activity_stream_engine_native_audit_fields_included,
|
7319
|
+
:automation_mode,
|
7320
|
+
:resume_full_automation_mode_time,
|
7321
|
+
:custom_iam_instance_profile)
|
6904
7322
|
SENSITIVE = []
|
6905
7323
|
include Aws::Structure
|
6906
7324
|
end
|
@@ -7020,8 +7438,7 @@ module Aws::RDS
|
|
7020
7438
|
# The Amazon Web Services KMS key ID for an automated backup.
|
7021
7439
|
#
|
7022
7440
|
# 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).
|
7441
|
+
# alias ARN, or alias name for the KMS key.
|
7025
7442
|
# @return [String]
|
7026
7443
|
#
|
7027
7444
|
# @!attribute [rw] timezone
|
@@ -7172,8 +7589,8 @@ module Aws::RDS
|
|
7172
7589
|
#
|
7173
7590
|
# @!attribute [rw] feature_name
|
7174
7591
|
# The name of the feature associated with the Amazon Web Services
|
7175
|
-
# Identity and Access Management (IAM) role. For
|
7176
|
-
# feature names, see `DBEngineVersion`.
|
7592
|
+
# Identity and Access Management (IAM) role. For information about
|
7593
|
+
# supported feature names, see `DBEngineVersion`.
|
7177
7594
|
# @return [String]
|
7178
7595
|
#
|
7179
7596
|
# @!attribute [rw] status
|
@@ -8027,8 +8444,7 @@ module Aws::RDS
|
|
8027
8444
|
# for the encrypted DB snapshot.
|
8028
8445
|
#
|
8029
8446
|
# 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).
|
8447
|
+
# alias ARN, or alias name for the KMS key.
|
8032
8448
|
# @return [String]
|
8033
8449
|
#
|
8034
8450
|
# @!attribute [rw] db_snapshot_arn
|
@@ -8353,6 +8769,35 @@ module Aws::RDS
|
|
8353
8769
|
include Aws::Structure
|
8354
8770
|
end
|
8355
8771
|
|
8772
|
+
# @note When making an API call, you may pass DeleteCustomDBEngineVersionMessage
|
8773
|
+
# data as a hash:
|
8774
|
+
#
|
8775
|
+
# {
|
8776
|
+
# engine: "CustomEngineName", # required
|
8777
|
+
# engine_version: "CustomEngineVersion", # required
|
8778
|
+
# }
|
8779
|
+
#
|
8780
|
+
# @!attribute [rw] engine
|
8781
|
+
# The database engine. The only supported engine is
|
8782
|
+
# `custom-oracle-ee`.
|
8783
|
+
# @return [String]
|
8784
|
+
#
|
8785
|
+
# @!attribute [rw] engine_version
|
8786
|
+
# The custom engine version (CEV) for your DB instance. This option is
|
8787
|
+
# required for RDS Custom, but optional for Amazon RDS. The
|
8788
|
+
# combination of `Engine` and `EngineVersion` is unique per customer
|
8789
|
+
# per Amazon Web Services Region.
|
8790
|
+
# @return [String]
|
8791
|
+
#
|
8792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteCustomDBEngineVersionMessage AWS API Documentation
|
8793
|
+
#
|
8794
|
+
class DeleteCustomDBEngineVersionMessage < Struct.new(
|
8795
|
+
:engine,
|
8796
|
+
:engine_version)
|
8797
|
+
SENSITIVE = []
|
8798
|
+
include Aws::Structure
|
8799
|
+
end
|
8800
|
+
|
8356
8801
|
# @note When making an API call, you may pass DeleteDBClusterEndpointMessage
|
8357
8802
|
# data as a hash:
|
8358
8803
|
#
|
@@ -8534,6 +8979,8 @@ module Aws::RDS
|
|
8534
8979
|
# The Amazon Resource Name (ARN) of the automated backups to delete,
|
8535
8980
|
# for example,
|
8536
8981
|
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
8982
|
+
#
|
8983
|
+
# This setting doesn't apply to RDS Custom.
|
8537
8984
|
# @return [String]
|
8538
8985
|
#
|
8539
8986
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackupMessage AWS API Documentation
|
@@ -8582,32 +9029,38 @@ module Aws::RDS
|
|
8582
9029
|
#
|
8583
9030
|
# @!attribute [rw] skip_final_snapshot
|
8584
9031
|
# A value that indicates whether to skip the creation of a final DB
|
8585
|
-
# snapshot before the
|
8586
|
-
# DB snapshot
|
8587
|
-
#
|
8588
|
-
#
|
9032
|
+
# snapshot before deleting the instance. If you enable this parameter,
|
9033
|
+
# RDS doesn't create a DB snapshot. If you don't enable this
|
9034
|
+
# parameter, RDS creates a DB snapshot before the DB instance is
|
9035
|
+
# deleted. By default, skip isn't enabled, and the DB snapshot is
|
9036
|
+
# created.
|
8589
9037
|
#
|
8590
|
-
#
|
8591
|
-
#
|
8592
|
-
# it can only be deleted when skip is specified.
|
9038
|
+
# <note markdown="1"> If you don't enable this parameter, you must specify the
|
9039
|
+
# `FinalDBSnapshotIdentifier` parameter.
|
8593
9040
|
#
|
8594
|
-
#
|
9041
|
+
# </note>
|
8595
9042
|
#
|
8596
|
-
#
|
8597
|
-
#
|
9043
|
+
# When a DB instance is in a failure state and has a status of
|
9044
|
+
# `failed`, `incompatible-restore`, or `incompatible-network`, RDS can
|
9045
|
+
# delete the instance only if you enable this parameter.
|
8598
9046
|
#
|
8599
|
-
#
|
9047
|
+
# If you delete a read replica or an RDS Custom instance, you must
|
9048
|
+
# enable this setting.
|
9049
|
+
#
|
9050
|
+
# This setting is required for RDS Custom.
|
8600
9051
|
# @return [Boolean]
|
8601
9052
|
#
|
8602
9053
|
# @!attribute [rw] final_db_snapshot_identifier
|
8603
9054
|
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
8604
9055
|
# `SkipFinalSnapshot` parameter is disabled.
|
8605
9056
|
#
|
8606
|
-
# <note markdown="1">
|
8607
|
-
#
|
9057
|
+
# <note markdown="1"> If you enable this parameter and also enable SkipFinalShapshot, the
|
9058
|
+
# command results in an error.
|
8608
9059
|
#
|
8609
9060
|
# </note>
|
8610
9061
|
#
|
9062
|
+
# This setting doesn't apply to RDS Custom.
|
9063
|
+
#
|
8611
9064
|
# Constraints:
|
8612
9065
|
#
|
8613
9066
|
# * Must be 1 to 255 letters or numbers.
|
@@ -9790,6 +10243,10 @@ module Aws::RDS
|
|
9790
10243
|
# If this parameter is enabled and the requested engine supports the
|
9791
10244
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
9792
10245
|
# includes a list of supported character sets for each engine version.
|
10246
|
+
#
|
10247
|
+
# For RDS Custom, the default is not to list supported character sets.
|
10248
|
+
# If you set `ListSupportedCharacterSets` to `true`, RDS Custom
|
10249
|
+
# returns no results.
|
9793
10250
|
# @return [Boolean]
|
9794
10251
|
#
|
9795
10252
|
# @!attribute [rw] list_supported_timezones
|
@@ -9799,6 +10256,10 @@ module Aws::RDS
|
|
9799
10256
|
# If this parameter is enabled and the requested engine supports the
|
9800
10257
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
9801
10258
|
# list of supported time zones for each engine version.
|
10259
|
+
#
|
10260
|
+
# For RDS Custom, the default is not to list supported time zones. If
|
10261
|
+
# you set `ListSupportedTimezones` to `true`, RDS Custom returns no
|
10262
|
+
# results.
|
9802
10263
|
# @return [Boolean]
|
9803
10264
|
#
|
9804
10265
|
# @!attribute [rw] include_all
|
@@ -9899,6 +10360,8 @@ module Aws::RDS
|
|
9899
10360
|
# The Amazon Resource Name (ARN) of the replicated automated backups,
|
9900
10361
|
# for example,
|
9901
10362
|
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
10363
|
+
#
|
10364
|
+
# This setting doesn't apply to RDS Custom.
|
9902
10365
|
# @return [String]
|
9903
10366
|
#
|
9904
10367
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstanceAutomatedBackupsMessage AWS API Documentation
|
@@ -10768,6 +11231,8 @@ module Aws::RDS
|
|
10768
11231
|
# You can give an Amazon Web Services account permission to restore a
|
10769
11232
|
# manual DB snapshot from another Amazon Web Services account by using
|
10770
11233
|
# the `ModifyDBSnapshotAttribute` API action.
|
11234
|
+
#
|
11235
|
+
# This setting doesn't apply to RDS Custom.
|
10771
11236
|
# @return [Boolean]
|
10772
11237
|
#
|
10773
11238
|
# @!attribute [rw] include_public
|
@@ -10778,6 +11243,8 @@ module Aws::RDS
|
|
10778
11243
|
#
|
10779
11244
|
# You can share a manual DB snapshot as public by using the
|
10780
11245
|
# ModifyDBSnapshotAttribute API.
|
11246
|
+
#
|
11247
|
+
# This setting doesn't apply to RDS Custom.
|
10781
11248
|
# @return [Boolean]
|
10782
11249
|
#
|
10783
11250
|
# @!attribute [rw] dbi_resource_id
|
@@ -11074,7 +11541,7 @@ module Aws::RDS
|
|
11074
11541
|
#
|
11075
11542
|
# {
|
11076
11543
|
# source_identifier: "String",
|
11077
|
-
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
|
11544
|
+
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version
|
11078
11545
|
# start_time: Time.now,
|
11079
11546
|
# end_time: Time.now,
|
11080
11547
|
# duration: 1,
|
@@ -11237,8 +11704,18 @@ module Aws::RDS
|
|
11237
11704
|
# * `source-arn` - The Amazon Resource Name (ARN) of the snapshot
|
11238
11705
|
# exported to Amazon S3
|
11239
11706
|
#
|
11240
|
-
# * `status` - The status of the export task. Must be lowercase
|
11241
|
-
#
|
11707
|
+
# * `status` - The status of the export task. Must be lowercase. Valid
|
11708
|
+
# statuses are the following:
|
11709
|
+
#
|
11710
|
+
# * `canceled`
|
11711
|
+
#
|
11712
|
+
# * `canceling`
|
11713
|
+
#
|
11714
|
+
# * `complete`
|
11715
|
+
#
|
11716
|
+
# * `failed`
|
11717
|
+
#
|
11718
|
+
# * `starting`
|
11242
11719
|
# @return [Array<Types::Filter>]
|
11243
11720
|
#
|
11244
11721
|
# @!attribute [rw] marker
|
@@ -11634,6 +12111,8 @@ module Aws::RDS
|
|
11634
12111
|
# @!attribute [rw] license_model
|
11635
12112
|
# The license model filter value. Specify this parameter to show only
|
11636
12113
|
# the available offerings matching the specified license model.
|
12114
|
+
#
|
12115
|
+
# RDS Custom supports only the BYOL licensing model.
|
11637
12116
|
# @return [String]
|
11638
12117
|
#
|
11639
12118
|
# @!attribute [rw] availability_zone_group
|
@@ -11643,11 +12122,16 @@ module Aws::RDS
|
|
11643
12122
|
#
|
11644
12123
|
# Omit this parameter to show the available offerings in the specified
|
11645
12124
|
# Amazon Web Services Region.
|
12125
|
+
#
|
12126
|
+
# This setting doesn't apply to RDS Custom.
|
11646
12127
|
# @return [String]
|
11647
12128
|
#
|
11648
12129
|
# @!attribute [rw] vpc
|
11649
12130
|
# A value that indicates whether to show only VPC or non-VPC
|
11650
|
-
# offerings.
|
12131
|
+
# offerings. RDS Custom supports only VPC offerings.
|
12132
|
+
#
|
12133
|
+
# RDS Custom supports only VPC offerings. If you describe non-VPC
|
12134
|
+
# offerings for RDS Custom, the output shows VPC offerings.
|
11651
12135
|
# @return [Boolean]
|
11652
12136
|
#
|
11653
12137
|
# @!attribute [rw] filters
|
@@ -12571,12 +13055,11 @@ module Aws::RDS
|
|
12571
13055
|
# @return [String]
|
12572
13056
|
#
|
12573
13057
|
# @!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.
|
13058
|
+
# The key identifier of the Amazon Web Services KMS key that is used
|
13059
|
+
# to encrypt the snapshot when it's exported to Amazon S3. The KMS
|
13060
|
+
# key identifier is its key ARN, key ID, alias ARN, or alias name. The
|
13061
|
+
# IAM role used for the snapshot export must have encryption and
|
13062
|
+
# decryption permissions to use this KMS key.
|
12580
13063
|
# @return [String]
|
12581
13064
|
#
|
12582
13065
|
# @!attribute [rw] status
|
@@ -12858,7 +13341,7 @@ module Aws::RDS
|
|
12858
13341
|
# The Amazon Web Services Region-unique, immutable identifier for the
|
12859
13342
|
# global database cluster. This identifier is found in Amazon Web
|
12860
13343
|
# Services CloudTrail log entries whenever the Amazon Web Services KMS
|
12861
|
-
#
|
13344
|
+
# key for the DB cluster is accessed.
|
12862
13345
|
# @return [String]
|
12863
13346
|
#
|
12864
13347
|
# @!attribute [rw] global_cluster_arn
|
@@ -13249,6 +13732,12 @@ module Aws::RDS
|
|
13249
13732
|
#
|
13250
13733
|
class InsufficientStorageClusterCapacityFault < Aws::EmptyStructure; end
|
13251
13734
|
|
13735
|
+
# You can't delete the CEV.
|
13736
|
+
#
|
13737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/InvalidCustomDBEngineVersionStateFault AWS API Documentation
|
13738
|
+
#
|
13739
|
+
class InvalidCustomDBEngineVersionStateFault < Aws::EmptyStructure; end
|
13740
|
+
|
13252
13741
|
# `Capacity` isn't a valid Aurora Serverless DB cluster capacity. Valid
|
13253
13742
|
# capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`.
|
13254
13743
|
#
|
@@ -13582,6 +14071,65 @@ module Aws::RDS
|
|
13582
14071
|
include Aws::Structure
|
13583
14072
|
end
|
13584
14073
|
|
14074
|
+
# @note When making an API call, you may pass ModifyCustomDBEngineVersionMessage
|
14075
|
+
# data as a hash:
|
14076
|
+
#
|
14077
|
+
# {
|
14078
|
+
# engine: "CustomEngineName", # required
|
14079
|
+
# engine_version: "CustomEngineVersion", # required
|
14080
|
+
# description: "Description",
|
14081
|
+
# status: "available", # accepts available, inactive, inactive-except-restore
|
14082
|
+
# }
|
14083
|
+
#
|
14084
|
+
# @!attribute [rw] engine
|
14085
|
+
# The DB engine. The only supported value is `custom-oracle-ee`.
|
14086
|
+
# @return [String]
|
14087
|
+
#
|
14088
|
+
# @!attribute [rw] engine_version
|
14089
|
+
# The custom engine version (CEV) that you want to modify. This option
|
14090
|
+
# is required for RDS Custom, but optional for Amazon RDS. The
|
14091
|
+
# combination of `Engine` and `EngineVersion` is unique per customer
|
14092
|
+
# per Amazon Web Services Region.
|
14093
|
+
# @return [String]
|
14094
|
+
#
|
14095
|
+
# @!attribute [rw] description
|
14096
|
+
# An optional description of your CEV.
|
14097
|
+
# @return [String]
|
14098
|
+
#
|
14099
|
+
# @!attribute [rw] status
|
14100
|
+
# The availability status to be assigned to the CEV. Valid values are
|
14101
|
+
# as follows:
|
14102
|
+
#
|
14103
|
+
# available
|
14104
|
+
#
|
14105
|
+
# : You can use this CEV to create a new RDS Custom DB instance.
|
14106
|
+
#
|
14107
|
+
# inactive
|
14108
|
+
#
|
14109
|
+
# : You can create a new RDS Custom instance by restoring a DB
|
14110
|
+
# snapshot with this CEV. You can't patch or create new instances
|
14111
|
+
# with this CEV.
|
14112
|
+
#
|
14113
|
+
# You can change any status to any status. A typical reason to change
|
14114
|
+
# status is to prevent the accidental use of a CEV, or to make a
|
14115
|
+
# deprecated CEV eligible for use again. For example, you might change
|
14116
|
+
# the status of your CEV from `available` to `inactive`, and from
|
14117
|
+
# `inactive` back to `available`. To change the availability status of
|
14118
|
+
# the CEV, it must not currently be in use by an RDS Custom instance,
|
14119
|
+
# snapshot, or automated backup.
|
14120
|
+
# @return [String]
|
14121
|
+
#
|
14122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCustomDBEngineVersionMessage AWS API Documentation
|
14123
|
+
#
|
14124
|
+
class ModifyCustomDBEngineVersionMessage < Struct.new(
|
14125
|
+
:engine,
|
14126
|
+
:engine_version,
|
14127
|
+
:description,
|
14128
|
+
:status)
|
14129
|
+
SENSITIVE = []
|
14130
|
+
include Aws::Structure
|
14131
|
+
end
|
14132
|
+
|
13585
14133
|
# @note When making an API call, you may pass ModifyDBClusterEndpointMessage
|
13586
14134
|
# data as a hash:
|
13587
14135
|
#
|
@@ -14207,6 +14755,8 @@ module Aws::RDS
|
|
14207
14755
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
14208
14756
|
# enable_customer_owned_ip: false,
|
14209
14757
|
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
14758
|
+
# automation_mode: "full", # accepts full, all-paused
|
14759
|
+
# resume_full_automation_mode_minutes: 1,
|
14210
14760
|
# }
|
14211
14761
|
#
|
14212
14762
|
# @!attribute [rw] db_instance_identifier
|
@@ -14238,12 +14788,14 @@ module Aws::RDS
|
|
14238
14788
|
# `db.m4.large`. Not all DB instance classes are available in all
|
14239
14789
|
# Amazon Web Services Regions, or for all database engines. For the
|
14240
14790
|
# full list of DB instance classes, and availability for your engine,
|
14241
|
-
# see [DB Instance Class][1] in the *Amazon RDS User Guide
|
14791
|
+
# see [DB Instance Class][1] in the *Amazon RDS User Guide*.
|
14242
14792
|
#
|
14243
14793
|
# If you modify the DB instance class, an outage occurs during the
|
14244
14794
|
# change. The change is applied during the next maintenance window,
|
14245
14795
|
# unless `ApplyImmediately` is enabled for this request.
|
14246
14796
|
#
|
14797
|
+
# This setting doesn't apply to RDS Custom.
|
14798
|
+
#
|
14247
14799
|
# Default: Uses existing setting
|
14248
14800
|
#
|
14249
14801
|
#
|
@@ -14256,12 +14808,14 @@ module Aws::RDS
|
|
14256
14808
|
# parameter to move your DB instance to a different VPC. If your DB
|
14257
14809
|
# instance isn't in a VPC, you can also use this parameter to move
|
14258
14810
|
# 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
|
14811
|
+
# a DB instance in a VPC][1] in the *Amazon RDS User Guide*.
|
14260
14812
|
#
|
14261
14813
|
# Changing the subnet group causes an outage during the change. The
|
14262
14814
|
# change is applied during the next maintenance window, unless you
|
14263
14815
|
# enable `ApplyImmediately`.
|
14264
14816
|
#
|
14817
|
+
# This parameter doesn't apply to RDS Custom.
|
14818
|
+
#
|
14265
14819
|
# Constraints: If supplied, must match the name of an existing
|
14266
14820
|
# DBSubnetGroup.
|
14267
14821
|
#
|
@@ -14277,6 +14831,8 @@ module Aws::RDS
|
|
14277
14831
|
# Changing this setting doesn't result in an outage and the change is
|
14278
14832
|
# asynchronously applied as soon as possible.
|
14279
14833
|
#
|
14834
|
+
# This setting doesn't apply to RDS Custom.
|
14835
|
+
#
|
14280
14836
|
# Constraints:
|
14281
14837
|
#
|
14282
14838
|
# * If supplied, must match existing DBSecurityGroups.
|
@@ -14285,8 +14841,10 @@ module Aws::RDS
|
|
14285
14841
|
# @return [Array<String>]
|
14286
14842
|
#
|
14287
14843
|
# @!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.
|
14844
|
+
# A list of Amazon EC2 VPC security groups to authorize on this DB
|
14845
|
+
# instance. This change is asynchronously applied as soon as possible.
|
14846
|
+
#
|
14847
|
+
# This setting doesn't apply to RDS Custom.
|
14290
14848
|
#
|
14291
14849
|
# **Amazon Aurora**
|
14292
14850
|
#
|
@@ -14331,6 +14889,8 @@ module Aws::RDS
|
|
14331
14889
|
# `MasterUserPassword` element exists in the `PendingModifiedValues`
|
14332
14890
|
# element of the operation response.
|
14333
14891
|
#
|
14892
|
+
# This setting doesn't apply to RDS Custom.
|
14893
|
+
#
|
14334
14894
|
# **Amazon Aurora**
|
14335
14895
|
#
|
14336
14896
|
# Not applicable. The password for the master user is managed by the
|
@@ -14368,17 +14928,22 @@ module Aws::RDS
|
|
14368
14928
|
#
|
14369
14929
|
# @!attribute [rw] db_parameter_group_name
|
14370
14930
|
# The name of the DB parameter group to apply to the DB instance.
|
14931
|
+
#
|
14371
14932
|
# Changing this setting doesn't result in an outage. The parameter
|
14372
14933
|
# group name itself is changed immediately, but the actual parameter
|
14373
14934
|
# changes are not applied until you reboot the instance without
|
14374
14935
|
# failover. In this case, the DB instance isn't rebooted
|
14375
|
-
# automatically and the parameter changes
|
14376
|
-
# next maintenance window.
|
14936
|
+
# automatically, and the parameter changes aren't applied during the
|
14937
|
+
# next maintenance window. However, if you modify dynamic parameters
|
14938
|
+
# in the newly associated DB parameter group, these changes are
|
14939
|
+
# applied immediately without a reboot.
|
14940
|
+
#
|
14941
|
+
# This setting doesn't apply to RDS Custom.
|
14377
14942
|
#
|
14378
14943
|
# Default: Uses existing setting
|
14379
14944
|
#
|
14380
14945
|
# Constraints: The DB parameter group must be in the same DB parameter
|
14381
|
-
# group family as
|
14946
|
+
# group family as the DB instance.
|
14382
14947
|
# @return [String]
|
14383
14948
|
#
|
14384
14949
|
# @!attribute [rw] backup_retention_period
|
@@ -14407,15 +14972,15 @@ module Aws::RDS
|
|
14407
14972
|
#
|
14408
14973
|
# Constraints:
|
14409
14974
|
#
|
14410
|
-
# *
|
14411
|
-
#
|
14412
|
-
#
|
14413
|
-
# running MySQL 5.6 or later
|
14975
|
+
# * It must be a value from 0 to 35. It can't be set to 0 if the DB
|
14976
|
+
# instance is a source to read replicas. It can't be set to 0 or 35
|
14977
|
+
# for an RDS Custom DB instance.
|
14414
14978
|
#
|
14415
|
-
# *
|
14416
|
-
#
|
14979
|
+
# * It can be specified for a MySQL read replica only if the source is
|
14980
|
+
# running MySQL 5.6 or later.
|
14417
14981
|
#
|
14418
|
-
# *
|
14982
|
+
# * It can be specified for a PostgreSQL read replica only if the
|
14983
|
+
# source is running PostgreSQL 9.3.5.
|
14419
14984
|
# @return [Integer]
|
14420
14985
|
#
|
14421
14986
|
# @!attribute [rw] preferred_backup_window
|
@@ -14478,9 +15043,11 @@ module Aws::RDS
|
|
14478
15043
|
#
|
14479
15044
|
# @!attribute [rw] multi_az
|
14480
15045
|
# A value that indicates whether the DB instance is a Multi-AZ
|
14481
|
-
# deployment. Changing this parameter doesn't result in an outage
|
14482
|
-
#
|
15046
|
+
# deployment. Changing this parameter doesn't result in an outage.
|
15047
|
+
# The change is applied during the next maintenance window unless the
|
14483
15048
|
# `ApplyImmediately` parameter is enabled for this request.
|
15049
|
+
#
|
15050
|
+
# This setting doesn't apply to RDS Custom.
|
14484
15051
|
# @return [Boolean]
|
14485
15052
|
#
|
14486
15053
|
# @!attribute [rw] engine_version
|
@@ -14499,6 +15066,9 @@ module Aws::RDS
|
|
14499
15066
|
# instance to the default minor version if the current minor version
|
14500
15067
|
# is lower. For information about valid engine versions, see
|
14501
15068
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
15069
|
+
#
|
15070
|
+
# In RDS Custom, this parameter is supported for read replicas only if
|
15071
|
+
# they are in the `PATCH_DB_FAILURE` lifecycle.
|
14502
15072
|
# @return [String]
|
14503
15073
|
#
|
14504
15074
|
# @!attribute [rw] allow_major_version_upgrade
|
@@ -14506,6 +15076,8 @@ module Aws::RDS
|
|
14506
15076
|
# Changing this parameter doesn't result in an outage and the change
|
14507
15077
|
# is asynchronously applied as soon as possible.
|
14508
15078
|
#
|
15079
|
+
# This setting doesn't apply to RDS Custom.
|
15080
|
+
#
|
14509
15081
|
# Constraints: Major version upgrades must be allowed when specifying
|
14510
15082
|
# a value for the EngineVersion parameter that is a different major
|
14511
15083
|
# version than the DB instance's current version.
|
@@ -14513,17 +15085,27 @@ module Aws::RDS
|
|
14513
15085
|
#
|
14514
15086
|
# @!attribute [rw] auto_minor_version_upgrade
|
14515
15087
|
# 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
|
-
#
|
15088
|
+
# automatically to the DB instance during the maintenance window. An
|
15089
|
+
# outage occurs when all the following conditions are met:
|
15090
|
+
#
|
15091
|
+
# * The automatic upgrade is enabled for the maintenance window.
|
15092
|
+
#
|
15093
|
+
# * A newer minor version is available.
|
15094
|
+
#
|
15095
|
+
# * RDS has enabled automatic patching for the engine version.
|
15096
|
+
#
|
15097
|
+
# If any of the preceding conditions isn't met, RDS applies the
|
15098
|
+
# change as soon as possible and doesn't cause an outage.
|
15099
|
+
#
|
15100
|
+
# For an RDS Custom DB instance, set `AutoMinorVersionUpgrade` to
|
15101
|
+
# `false`. Otherwise, the operation returns an error.
|
14522
15102
|
# @return [Boolean]
|
14523
15103
|
#
|
14524
15104
|
# @!attribute [rw] license_model
|
14525
15105
|
# The license model for the DB instance.
|
14526
15106
|
#
|
15107
|
+
# This setting doesn't apply to RDS Custom.
|
15108
|
+
#
|
14527
15109
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
14528
15110
|
# `general-public-license`
|
14529
15111
|
# @return [String]
|
@@ -14565,18 +15147,23 @@ module Aws::RDS
|
|
14565
15147
|
#
|
14566
15148
|
# @!attribute [rw] option_group_name
|
14567
15149
|
# A value that indicates the DB instance should be associated with the
|
14568
|
-
# specified option group.
|
14569
|
-
#
|
14570
|
-
#
|
14571
|
-
#
|
14572
|
-
#
|
14573
|
-
#
|
14574
|
-
#
|
15150
|
+
# specified option group.
|
15151
|
+
#
|
15152
|
+
# Changing this parameter doesn't result in an outage, with one
|
15153
|
+
# exception. If the parameter change results in an option group that
|
15154
|
+
# enables OEM, it can cause a brief period, lasting less than a
|
15155
|
+
# second, during which new connections are rejected but existing
|
15156
|
+
# connections aren't interrupted.
|
15157
|
+
#
|
15158
|
+
# The change is applied during the next maintenance window unless the
|
15159
|
+
# `ApplyImmediately` parameter is enabled for this request.
|
14575
15160
|
#
|
14576
15161
|
# Permanent options, such as the TDE option for Oracle Advanced
|
14577
15162
|
# 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
|
15163
|
+
# option group can't be removed from a DB instance after it is
|
15164
|
+
# associated with a DB instance.
|
15165
|
+
#
|
15166
|
+
# This setting doesn't apply to RDS Custom.
|
14580
15167
|
# @return [String]
|
14581
15168
|
#
|
14582
15169
|
# @!attribute [rw] new_db_instance_identifier
|
@@ -14586,6 +15173,8 @@ module Aws::RDS
|
|
14586
15173
|
# occur during the next maintenance window if you disable Apply
|
14587
15174
|
# Immediately. This value is stored as a lowercase string.
|
14588
15175
|
#
|
15176
|
+
# This setting doesn't apply to RDS Custom.
|
15177
|
+
#
|
14589
15178
|
# Constraints:
|
14590
15179
|
#
|
14591
15180
|
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
@@ -14627,28 +15216,35 @@ module Aws::RDS
|
|
14627
15216
|
# @!attribute [rw] tde_credential_arn
|
14628
15217
|
# The ARN from the key store with which to associate the instance for
|
14629
15218
|
# TDE encryption.
|
15219
|
+
#
|
15220
|
+
# This setting doesn't apply to RDS Custom.
|
14630
15221
|
# @return [String]
|
14631
15222
|
#
|
14632
15223
|
# @!attribute [rw] tde_credential_password
|
14633
15224
|
# The password for the given ARN from the key store in order to access
|
14634
15225
|
# the device.
|
15226
|
+
#
|
15227
|
+
# This setting doesn't apply to RDS Custom.
|
14635
15228
|
# @return [String]
|
14636
15229
|
#
|
14637
15230
|
# @!attribute [rw] ca_certificate_identifier
|
14638
|
-
#
|
14639
|
-
#
|
15231
|
+
# Specifies the certificate to associate with the DB instance.
|
15232
|
+
#
|
15233
|
+
# This setting doesn't apply to RDS Custom.
|
14640
15234
|
# @return [String]
|
14641
15235
|
#
|
14642
15236
|
# @!attribute [rw] domain
|
14643
15237
|
# 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
|
-
#
|
15238
|
+
# Specify `none` to remove the instance from its current domain. You
|
15239
|
+
# must create the domain before this operation. Currently, you can
|
15240
|
+
# create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
15241
|
+
# instances in an Active Directory Domain.
|
14648
15242
|
#
|
14649
15243
|
# For more information, see [ Kerberos Authentication][1] in the
|
14650
15244
|
# *Amazon RDS User Guide*.
|
14651
15245
|
#
|
15246
|
+
# This setting doesn't apply to RDS Custom.
|
15247
|
+
#
|
14652
15248
|
#
|
14653
15249
|
#
|
14654
15250
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -14669,10 +15265,12 @@ module Aws::RDS
|
|
14669
15265
|
# @!attribute [rw] monitoring_interval
|
14670
15266
|
# The interval, in seconds, between points when Enhanced Monitoring
|
14671
15267
|
# metrics are collected for the DB instance. To disable collecting
|
14672
|
-
# Enhanced Monitoring metrics, specify 0
|
15268
|
+
# Enhanced Monitoring metrics, specify 0, which is the default.
|
14673
15269
|
#
|
14674
|
-
# If `MonitoringRoleArn` is specified,
|
14675
|
-
#
|
15270
|
+
# If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
|
15271
|
+
# value other than 0.
|
15272
|
+
#
|
15273
|
+
# This setting doesn't apply to RDS Custom.
|
14676
15274
|
#
|
14677
15275
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
14678
15276
|
# @return [Integer]
|
@@ -14684,9 +15282,11 @@ module Aws::RDS
|
|
14684
15282
|
# port values specified for options in the option group for the DB
|
14685
15283
|
# instance.
|
14686
15284
|
#
|
14687
|
-
#
|
15285
|
+
# If you change the `DBPortNumber` value, your database restarts
|
14688
15286
|
# regardless of the value of the `ApplyImmediately` parameter.
|
14689
15287
|
#
|
15288
|
+
# This setting doesn't apply to RDS Custom.
|
15289
|
+
#
|
14690
15290
|
# **MySQL**
|
14691
15291
|
#
|
14692
15292
|
# Default: `3306`
|
@@ -14748,17 +15348,21 @@ module Aws::RDS
|
|
14748
15348
|
# Changes to the `PubliclyAccessible` parameter are applied
|
14749
15349
|
# immediately regardless of the value of the `ApplyImmediately`
|
14750
15350
|
# parameter.
|
15351
|
+
#
|
15352
|
+
# This setting doesn't apply to RDS Custom.
|
14751
15353
|
# @return [Boolean]
|
14752
15354
|
#
|
14753
15355
|
# @!attribute [rw] monitoring_role_arn
|
14754
15356
|
# The ARN for the IAM role that permits RDS to send enhanced
|
14755
15357
|
# monitoring metrics to Amazon CloudWatch Logs. For example,
|
14756
15358
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on
|
14757
|
-
# creating a monitoring role,
|
15359
|
+
# creating a monitoring role, see [To create an IAM role for Amazon
|
14758
15360
|
# RDS Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
14759
15361
|
#
|
14760
|
-
# If `MonitoringInterval` is set to a value other than 0,
|
14761
|
-
#
|
15362
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
15363
|
+
# `MonitoringRoleArn` value.
|
15364
|
+
#
|
15365
|
+
# This setting doesn't apply to RDS Custom.
|
14762
15366
|
#
|
14763
15367
|
#
|
14764
15368
|
#
|
@@ -14768,6 +15372,8 @@ module Aws::RDS
|
|
14768
15372
|
# @!attribute [rw] domain_iam_role_name
|
14769
15373
|
# The name of the IAM role to use when making API calls to the
|
14770
15374
|
# Directory Service.
|
15375
|
+
#
|
15376
|
+
# This setting doesn't apply to RDS Custom.
|
14771
15377
|
# @return [String]
|
14772
15378
|
#
|
14773
15379
|
# @!attribute [rw] promotion_tier
|
@@ -14776,6 +15382,8 @@ module Aws::RDS
|
|
14776
15382
|
# primary instance. For more information, see [ Fault Tolerance for an
|
14777
15383
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
14778
15384
|
#
|
15385
|
+
# This setting doesn't apply to RDS Custom.
|
15386
|
+
#
|
14779
15387
|
# Default: 1
|
14780
15388
|
#
|
14781
15389
|
# Valid Values: 0 - 15
|
@@ -14798,6 +15406,8 @@ module Aws::RDS
|
|
14798
15406
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
14799
15407
|
# RDS User Guide.*
|
14800
15408
|
#
|
15409
|
+
# This setting doesn't apply to RDS Custom.
|
15410
|
+
#
|
14801
15411
|
#
|
14802
15412
|
#
|
14803
15413
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -14810,6 +15420,8 @@ module Aws::RDS
|
|
14810
15420
|
# For more information, see [Using Amazon Performance Insights][1] in
|
14811
15421
|
# the *Amazon Relational Database Service User Guide*.
|
14812
15422
|
#
|
15423
|
+
# This setting doesn't apply to RDS Custom.
|
15424
|
+
#
|
14813
15425
|
#
|
14814
15426
|
#
|
14815
15427
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -14820,18 +15432,22 @@ module Aws::RDS
|
|
14820
15432
|
# Performance Insights data.
|
14821
15433
|
#
|
14822
15434
|
# 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).
|
15435
|
+
# alias ARN, or alias name for the KMS key.
|
14825
15436
|
#
|
14826
15437
|
# 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
|
15438
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
15439
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
15440
|
+
# account has a different default KMS key for each Amazon Web Services
|
15441
|
+
# Region.
|
15442
|
+
#
|
15443
|
+
# This setting doesn't apply to RDS Custom.
|
14830
15444
|
# @return [String]
|
14831
15445
|
#
|
14832
15446
|
# @!attribute [rw] performance_insights_retention_period
|
14833
15447
|
# The amount of time, in days, to retain Performance Insights data.
|
14834
15448
|
# Valid values are 7 or 731 (2 years).
|
15449
|
+
#
|
15450
|
+
# This setting doesn't apply to RDS Custom.
|
14835
15451
|
# @return [Integer]
|
14836
15452
|
#
|
14837
15453
|
# @!attribute [rw] cloudwatch_logs_export_configuration
|
@@ -14841,16 +15457,22 @@ module Aws::RDS
|
|
14841
15457
|
# A change to the `CloudwatchLogsExportConfiguration` parameter is
|
14842
15458
|
# always applied to the DB instance immediately. Therefore, the
|
14843
15459
|
# `ApplyImmediately` parameter has no effect.
|
15460
|
+
#
|
15461
|
+
# This setting doesn't apply to RDS Custom.
|
14844
15462
|
# @return [Types::CloudwatchLogsExportConfiguration]
|
14845
15463
|
#
|
14846
15464
|
# @!attribute [rw] processor_features
|
14847
15465
|
# The number of CPU cores and the number of threads per core for the
|
14848
15466
|
# DB instance class of the DB instance.
|
15467
|
+
#
|
15468
|
+
# This setting doesn't apply to RDS Custom.
|
14849
15469
|
# @return [Array<Types::ProcessorFeature>]
|
14850
15470
|
#
|
14851
15471
|
# @!attribute [rw] use_default_processor_features
|
14852
15472
|
# A value that indicates whether the DB instance class of the DB
|
14853
15473
|
# instance uses its default processor features.
|
15474
|
+
#
|
15475
|
+
# This setting doesn't apply to RDS Custom.
|
14854
15476
|
# @return [Boolean]
|
14855
15477
|
#
|
14856
15478
|
# @!attribute [rw] deletion_protection
|
@@ -14872,6 +15494,8 @@ module Aws::RDS
|
|
14872
15494
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
14873
15495
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
14874
15496
|
#
|
15497
|
+
# This setting doesn't apply to RDS Custom.
|
15498
|
+
#
|
14875
15499
|
#
|
14876
15500
|
#
|
14877
15501
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -14900,6 +15524,8 @@ module Aws::RDS
|
|
14900
15524
|
# Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
|
14901
15525
|
# the *Amazon Aurora User Guide.*
|
14902
15526
|
#
|
15527
|
+
# This setting doesn't apply to RDS Custom.
|
15528
|
+
#
|
14903
15529
|
#
|
14904
15530
|
#
|
14905
15531
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
@@ -14922,6 +15548,8 @@ module Aws::RDS
|
|
14922
15548
|
# workload. For more information, see [Working with Oracle Read
|
14923
15549
|
# Replicas for Amazon RDS][1] in the *Amazon RDS User Guide*.
|
14924
15550
|
#
|
15551
|
+
# This setting doesn't apply to RDS Custom.
|
15552
|
+
#
|
14925
15553
|
#
|
14926
15554
|
#
|
14927
15555
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -14953,8 +15581,23 @@ module Aws::RDS
|
|
14953
15581
|
# @!attribute [rw] aws_backup_recovery_point_arn
|
14954
15582
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
14955
15583
|
# Services Backup.
|
15584
|
+
#
|
15585
|
+
# This setting doesn't apply to RDS Custom.
|
15586
|
+
# @return [String]
|
15587
|
+
#
|
15588
|
+
# @!attribute [rw] automation_mode
|
15589
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
15590
|
+
# paused`. If `full`, the DB instance automates monitoring and
|
15591
|
+
# instance recovery. If `all paused`, the instance pauses automation
|
15592
|
+
# for the duration set by `ResumeFullAutomationModeMinutes`.
|
14956
15593
|
# @return [String]
|
14957
15594
|
#
|
15595
|
+
# @!attribute [rw] resume_full_automation_mode_minutes
|
15596
|
+
# The number of minutes to pause the automation. When the time period
|
15597
|
+
# ends, RDS Custom resumes full automation. The minimum value is `60`
|
15598
|
+
# (default). The maximum value is `1,440`.
|
15599
|
+
# @return [Integer]
|
15600
|
+
#
|
14958
15601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
14959
15602
|
#
|
14960
15603
|
class ModifyDBInstanceMessage < Struct.new(
|
@@ -15002,7 +15645,9 @@ module Aws::RDS
|
|
15002
15645
|
:certificate_rotation_restart,
|
15003
15646
|
:replica_mode,
|
15004
15647
|
:enable_customer_owned_ip,
|
15005
|
-
:aws_backup_recovery_point_arn
|
15648
|
+
:aws_backup_recovery_point_arn,
|
15649
|
+
:automation_mode,
|
15650
|
+
:resume_full_automation_mode_minutes)
|
15006
15651
|
SENSITIVE = []
|
15007
15652
|
include Aws::Structure
|
15008
15653
|
end
|
@@ -16752,6 +17397,19 @@ module Aws::RDS
|
|
16752
17397
|
# Management (IAM) accounts to database accounts is enabled.
|
16753
17398
|
# @return [Boolean]
|
16754
17399
|
#
|
17400
|
+
# @!attribute [rw] automation_mode
|
17401
|
+
# The automation mode of the RDS Custom DB instance: `full` or
|
17402
|
+
# `all-paused`. If `full`, the DB instance automates monitoring and
|
17403
|
+
# instance recovery. If `all-paused`, the instance pauses automation
|
17404
|
+
# for the duration set by `--resume-full-automation-mode-minutes`.
|
17405
|
+
# @return [String]
|
17406
|
+
#
|
17407
|
+
# @!attribute [rw] resume_full_automation_mode_time
|
17408
|
+
# The number of minutes to pause the automation. When the time period
|
17409
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
17410
|
+
# (default). The maximum value is 1,440.
|
17411
|
+
# @return [Time]
|
17412
|
+
#
|
16755
17413
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PendingModifiedValues AWS API Documentation
|
16756
17414
|
#
|
16757
17415
|
class PendingModifiedValues < Struct.new(
|
@@ -16770,7 +17428,9 @@ module Aws::RDS
|
|
16770
17428
|
:db_subnet_group_name,
|
16771
17429
|
:pending_cloudwatch_logs_exports,
|
16772
17430
|
:processor_features,
|
16773
|
-
:iam_database_authentication_enabled
|
17431
|
+
:iam_database_authentication_enabled,
|
17432
|
+
:automation_mode,
|
17433
|
+
:resume_full_automation_mode_time)
|
16774
17434
|
SENSITIVE = []
|
16775
17435
|
include Aws::Structure
|
16776
17436
|
end
|
@@ -17272,8 +17932,8 @@ module Aws::RDS
|
|
17272
17932
|
#
|
17273
17933
|
# @!attribute [rw] feature_name
|
17274
17934
|
# The name of the feature for the DB cluster that the IAM role is to
|
17275
|
-
# be disassociated from. For
|
17276
|
-
# DBEngineVersion.
|
17935
|
+
# be disassociated from. For information about supported feature
|
17936
|
+
# names, see DBEngineVersion.
|
17277
17937
|
# @return [String]
|
17278
17938
|
#
|
17279
17939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBClusterMessage AWS API Documentation
|
@@ -17307,8 +17967,8 @@ module Aws::RDS
|
|
17307
17967
|
#
|
17308
17968
|
# @!attribute [rw] feature_name
|
17309
17969
|
# The name of the feature for the DB instance that the IAM role is to
|
17310
|
-
# be disassociated from. For
|
17311
|
-
# `DBEngineVersion`.
|
17970
|
+
# be disassociated from. For information about supported feature
|
17971
|
+
# names, see `DBEngineVersion`.
|
17312
17972
|
# @return [String]
|
17313
17973
|
#
|
17314
17974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBInstanceMessage AWS API Documentation
|
@@ -18021,15 +18681,15 @@ module Aws::RDS
|
|
18021
18681
|
# cluster.
|
18022
18682
|
#
|
18023
18683
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18024
|
-
# alias ARN, or alias name for the
|
18025
|
-
#
|
18026
|
-
#
|
18684
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
18685
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
18686
|
+
# ARN.
|
18027
18687
|
#
|
18028
18688
|
# If the StorageEncrypted parameter is enabled, and you do not specify
|
18029
18689
|
# 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
|
-
#
|
18690
|
+
# default KMS key. There is a default KMS key for your Amazon Web
|
18691
|
+
# Services account. Your Amazon Web Services account has a different
|
18692
|
+
# default KMS key for each Amazon Web Services Region.
|
18033
18693
|
# @return [String]
|
18034
18694
|
#
|
18035
18695
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -18349,17 +19009,17 @@ module Aws::RDS
|
|
18349
19009
|
# encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
18350
19010
|
#
|
18351
19011
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18352
|
-
# alias ARN, or alias name for the
|
18353
|
-
#
|
18354
|
-
#
|
19012
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
19013
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
19014
|
+
# ARN.
|
18355
19015
|
#
|
18356
19016
|
# When you don't specify a value for the `KmsKeyId` parameter, then
|
18357
19017
|
# the following occurs:
|
18358
19018
|
#
|
18359
19019
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
18360
19020
|
# is encrypted, then the restored DB cluster is encrypted using the
|
18361
|
-
#
|
18362
|
-
# snapshot
|
19021
|
+
# KMS key that was used to encrypt the DB snapshot or DB cluster
|
19022
|
+
# snapshot.
|
18363
19023
|
#
|
18364
19024
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
18365
19025
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
@@ -18663,22 +19323,21 @@ module Aws::RDS
|
|
18663
19323
|
# encrypted DB cluster from an encrypted DB cluster.
|
18664
19324
|
#
|
18665
19325
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18666
|
-
# alias ARN, or alias name for the
|
18667
|
-
#
|
18668
|
-
#
|
19326
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
19327
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
19328
|
+
# ARN.
|
18669
19329
|
#
|
18670
19330
|
# 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.
|
19331
|
+
# with a KMS key that is different from the KMS key used to encrypt
|
19332
|
+
# the source DB cluster. The new DB cluster is encrypted with the KMS
|
19333
|
+
# key identified by the `KmsKeyId` parameter.
|
18675
19334
|
#
|
18676
19335
|
# If you don't specify a value for the `KmsKeyId` parameter, then the
|
18677
19336
|
# following occurs:
|
18678
19337
|
#
|
18679
19338
|
# * If the DB cluster is encrypted, then the restored DB cluster is
|
18680
|
-
# encrypted using the
|
18681
|
-
#
|
19339
|
+
# encrypted using the KMS key that was used to encrypt the source DB
|
19340
|
+
# cluster.
|
18682
19341
|
#
|
18683
19342
|
# * If the DB cluster isn't encrypted, then the restored DB cluster
|
18684
19343
|
# isn't encrypted.
|
@@ -18878,6 +19537,7 @@ module Aws::RDS
|
|
18878
19537
|
# db_parameter_group_name: "String",
|
18879
19538
|
# deletion_protection: false,
|
18880
19539
|
# enable_customer_owned_ip: false,
|
19540
|
+
# custom_iam_instance_profile: "String",
|
18881
19541
|
# }
|
18882
19542
|
#
|
18883
19543
|
# @!attribute [rw] db_instance_identifier
|
@@ -18952,6 +19612,8 @@ module Aws::RDS
|
|
18952
19612
|
# A value that indicates whether the DB instance is a Multi-AZ
|
18953
19613
|
# deployment.
|
18954
19614
|
#
|
19615
|
+
# This setting doesn't apply to RDS Custom.
|
19616
|
+
#
|
18955
19617
|
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
18956
19618
|
# the DB instance is a Multi-AZ deployment.
|
18957
19619
|
# @return [Boolean]
|
@@ -18976,11 +19638,16 @@ module Aws::RDS
|
|
18976
19638
|
# @!attribute [rw] auto_minor_version_upgrade
|
18977
19639
|
# A value that indicates whether minor version upgrades are applied
|
18978
19640
|
# automatically to the DB instance during the maintenance window.
|
19641
|
+
#
|
19642
|
+
# If you restore an RDS Custom DB instance, you must disable this
|
19643
|
+
# parameter.
|
18979
19644
|
# @return [Boolean]
|
18980
19645
|
#
|
18981
19646
|
# @!attribute [rw] license_model
|
18982
19647
|
# License model information for the restored DB instance.
|
18983
19648
|
#
|
19649
|
+
# This setting doesn't apply to RDS Custom.
|
19650
|
+
#
|
18984
19651
|
# Default: Same as source.
|
18985
19652
|
#
|
18986
19653
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -18990,15 +19657,15 @@ module Aws::RDS
|
|
18990
19657
|
# @!attribute [rw] db_name
|
18991
19658
|
# The database name for the restored DB instance.
|
18992
19659
|
#
|
18993
|
-
#
|
18994
|
-
# engines.
|
18995
|
-
#
|
18996
|
-
# </note>
|
19660
|
+
# This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
|
19661
|
+
# engines. It also doesn't apply to RDS Custom DB instances.
|
18997
19662
|
# @return [String]
|
18998
19663
|
#
|
18999
19664
|
# @!attribute [rw] engine
|
19000
19665
|
# The database engine to use for the new instance.
|
19001
19666
|
#
|
19667
|
+
# This setting doesn't apply to RDS Custom.
|
19668
|
+
#
|
19002
19669
|
# Default: The same as source
|
19003
19670
|
#
|
19004
19671
|
# Constraint: Must be compatible with the engine of the source. For
|
@@ -19056,8 +19723,10 @@ module Aws::RDS
|
|
19056
19723
|
#
|
19057
19724
|
# Permanent options, such as the TDE option for Oracle Advanced
|
19058
19725
|
# 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
|
19726
|
+
# option group can't be removed from a DB instance after it is
|
19727
|
+
# associated with a DB instance.
|
19728
|
+
#
|
19729
|
+
# This setting doesn't apply to RDS Custom.
|
19061
19730
|
# @return [String]
|
19062
19731
|
#
|
19063
19732
|
# @!attribute [rw] tags
|
@@ -19083,11 +19752,15 @@ module Aws::RDS
|
|
19083
19752
|
# @!attribute [rw] tde_credential_arn
|
19084
19753
|
# The ARN from the key store with which to associate the instance for
|
19085
19754
|
# TDE encryption.
|
19755
|
+
#
|
19756
|
+
# This setting doesn't apply to RDS Custom.
|
19086
19757
|
# @return [String]
|
19087
19758
|
#
|
19088
19759
|
# @!attribute [rw] tde_credential_password
|
19089
19760
|
# The password for the given ARN from the key store in order to access
|
19090
19761
|
# the device.
|
19762
|
+
#
|
19763
|
+
# This setting doesn't apply to RDS Custom.
|
19091
19764
|
# @return [String]
|
19092
19765
|
#
|
19093
19766
|
# @!attribute [rw] vpc_security_group_ids
|
@@ -19100,13 +19773,15 @@ module Aws::RDS
|
|
19100
19773
|
#
|
19101
19774
|
# @!attribute [rw] domain
|
19102
19775
|
# 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
|
-
#
|
19776
|
+
# in. The domain/ must be created prior to this operation. Currently,
|
19777
|
+
# you can create only MySQL, Microsoft SQL Server, Oracle, and
|
19778
|
+
# PostgreSQL DB instances in an Active Directory Domain.
|
19106
19779
|
#
|
19107
19780
|
# For more information, see [ Kerberos Authentication][1] in the
|
19108
19781
|
# *Amazon RDS User Guide*.
|
19109
19782
|
#
|
19783
|
+
# This setting doesn't apply to RDS Custom.
|
19784
|
+
#
|
19110
19785
|
#
|
19111
19786
|
#
|
19112
19787
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -19121,6 +19796,8 @@ module Aws::RDS
|
|
19121
19796
|
# @!attribute [rw] domain_iam_role_name
|
19122
19797
|
# Specify the name of the IAM role to be used when making API calls to
|
19123
19798
|
# the Directory Service.
|
19799
|
+
#
|
19800
|
+
# This setting doesn't apply to RDS Custom.
|
19124
19801
|
# @return [String]
|
19125
19802
|
#
|
19126
19803
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -19132,6 +19809,8 @@ module Aws::RDS
|
|
19132
19809
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
19133
19810
|
# RDS User Guide.*
|
19134
19811
|
#
|
19812
|
+
# This setting doesn't apply to RDS Custom.
|
19813
|
+
#
|
19135
19814
|
#
|
19136
19815
|
#
|
19137
19816
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -19143,6 +19822,8 @@ module Aws::RDS
|
|
19143
19822
|
# being used. For more information, see [Publishing Database Logs to
|
19144
19823
|
# Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
19145
19824
|
#
|
19825
|
+
# This setting doesn't apply to RDS Custom.
|
19826
|
+
#
|
19146
19827
|
#
|
19147
19828
|
#
|
19148
19829
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -19151,19 +19832,25 @@ module Aws::RDS
|
|
19151
19832
|
# @!attribute [rw] processor_features
|
19152
19833
|
# The number of CPU cores and the number of threads per core for the
|
19153
19834
|
# DB instance class of the DB instance.
|
19835
|
+
#
|
19836
|
+
# This setting doesn't apply to RDS Custom.
|
19154
19837
|
# @return [Array<Types::ProcessorFeature>]
|
19155
19838
|
#
|
19156
19839
|
# @!attribute [rw] use_default_processor_features
|
19157
19840
|
# A value that indicates whether the DB instance class of the DB
|
19158
19841
|
# instance uses its default processor features.
|
19842
|
+
#
|
19843
|
+
# This setting doesn't apply to RDS Custom.
|
19159
19844
|
# @return [Boolean]
|
19160
19845
|
#
|
19161
19846
|
# @!attribute [rw] db_parameter_group_name
|
19162
19847
|
# The name of the DB parameter group to associate with this DB
|
19163
19848
|
# instance.
|
19164
19849
|
#
|
19165
|
-
# If you
|
19166
|
-
# default `DBParameterGroup` for the specified DB engine
|
19850
|
+
# If you don't specify a value for `DBParameterGroupName`, then RDS
|
19851
|
+
# uses the default `DBParameterGroup` for the specified DB engine.
|
19852
|
+
#
|
19853
|
+
# This setting doesn't apply to RDS Custom.
|
19167
19854
|
#
|
19168
19855
|
# Constraints:
|
19169
19856
|
#
|
@@ -19197,6 +19884,8 @@ module Aws::RDS
|
|
19197
19884
|
# instance from outside of its virtual private cloud (VPC) on your
|
19198
19885
|
# local network.
|
19199
19886
|
#
|
19887
|
+
# This setting doesn't apply to RDS Custom.
|
19888
|
+
#
|
19200
19889
|
# For more information about RDS on Outposts, see [Working with Amazon
|
19201
19890
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
19202
19891
|
# Guide*.
|
@@ -19210,6 +19899,30 @@ module Aws::RDS
|
|
19210
19899
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
19211
19900
|
# @return [Boolean]
|
19212
19901
|
#
|
19902
|
+
# @!attribute [rw] custom_iam_instance_profile
|
19903
|
+
# The instance profile associated with the underlying Amazon EC2
|
19904
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
19905
|
+
# meet the following requirements:
|
19906
|
+
#
|
19907
|
+
# * The profile must exist in your account.
|
19908
|
+
#
|
19909
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
19910
|
+
# to assume.
|
19911
|
+
#
|
19912
|
+
# * The instance profile name and the associated IAM role name must
|
19913
|
+
# start with the prefix `AWSRDSCustom`.
|
19914
|
+
#
|
19915
|
+
# For the list of permissions required for the IAM role, see [
|
19916
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
19917
|
+
# Service User Guide*.
|
19918
|
+
#
|
19919
|
+
# This setting is required for RDS Custom.
|
19920
|
+
#
|
19921
|
+
#
|
19922
|
+
#
|
19923
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
19924
|
+
# @return [String]
|
19925
|
+
#
|
19213
19926
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshotMessage AWS API Documentation
|
19214
19927
|
#
|
19215
19928
|
class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
|
@@ -19241,7 +19954,8 @@ module Aws::RDS
|
|
19241
19954
|
:use_default_processor_features,
|
19242
19955
|
:db_parameter_group_name,
|
19243
19956
|
:deletion_protection,
|
19244
|
-
:enable_customer_owned_ip
|
19957
|
+
:enable_customer_owned_ip,
|
19958
|
+
:custom_iam_instance_profile)
|
19245
19959
|
SENSITIVE = []
|
19246
19960
|
include Aws::Structure
|
19247
19961
|
end
|
@@ -19583,15 +20297,15 @@ module Aws::RDS
|
|
19583
20297
|
# instance.
|
19584
20298
|
#
|
19585
20299
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
19586
|
-
# alias ARN, or alias name for the
|
19587
|
-
#
|
19588
|
-
#
|
20300
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
20301
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
20302
|
+
# ARN.
|
19589
20303
|
#
|
19590
20304
|
# If the `StorageEncrypted` parameter is enabled, and you do not
|
19591
20305
|
# 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
|
20306
|
+
# use your default KMS key. There is a default KMS key for your Amazon
|
20307
|
+
# Web Services account. Your Amazon Web Services account has a
|
20308
|
+
# different default KMS key for each Amazon Web Services Region.
|
19595
20309
|
# @return [String]
|
19596
20310
|
#
|
19597
20311
|
# @!attribute [rw] copy_tags_to_snapshot
|
@@ -19686,13 +20400,13 @@ module Aws::RDS
|
|
19686
20400
|
# Performance Insights data.
|
19687
20401
|
#
|
19688
20402
|
# 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).
|
20403
|
+
# alias ARN, or alias name for the KMS key.
|
19691
20404
|
#
|
19692
20405
|
# 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
|
20406
|
+
# then Amazon RDS uses your default KMS key. There is a default KMS
|
20407
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
20408
|
+
# account has a different default KMS key for each Amazon Web Services
|
20409
|
+
# Region.
|
19696
20410
|
# @return [String]
|
19697
20411
|
#
|
19698
20412
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -19859,6 +20573,7 @@ module Aws::RDS
|
|
19859
20573
|
# max_allocated_storage: 1,
|
19860
20574
|
# source_db_instance_automated_backups_arn: "String",
|
19861
20575
|
# enable_customer_owned_ip: false,
|
20576
|
+
# custom_iam_instance_profile: "String",
|
19862
20577
|
# }
|
19863
20578
|
#
|
19864
20579
|
# @!attribute [rw] source_db_instance_identifier
|
@@ -19954,6 +20669,8 @@ module Aws::RDS
|
|
19954
20669
|
# A value that indicates whether the DB instance is a Multi-AZ
|
19955
20670
|
# deployment.
|
19956
20671
|
#
|
20672
|
+
# This setting doesn't apply to RDS Custom.
|
20673
|
+
#
|
19957
20674
|
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
19958
20675
|
# the DB instance is a Multi-AZ deployment.
|
19959
20676
|
# @return [Boolean]
|
@@ -19978,11 +20695,15 @@ module Aws::RDS
|
|
19978
20695
|
# @!attribute [rw] auto_minor_version_upgrade
|
19979
20696
|
# A value that indicates whether minor version upgrades are applied
|
19980
20697
|
# automatically to the DB instance during the maintenance window.
|
20698
|
+
#
|
20699
|
+
# This setting doesn't apply to RDS Custom.
|
19981
20700
|
# @return [Boolean]
|
19982
20701
|
#
|
19983
20702
|
# @!attribute [rw] license_model
|
19984
20703
|
# License model information for the restored DB instance.
|
19985
20704
|
#
|
20705
|
+
# This setting doesn't apply to RDS Custom.
|
20706
|
+
#
|
19986
20707
|
# Default: Same as source.
|
19987
20708
|
#
|
19988
20709
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -19992,7 +20713,8 @@ module Aws::RDS
|
|
19992
20713
|
# @!attribute [rw] db_name
|
19993
20714
|
# The database name for the restored DB instance.
|
19994
20715
|
#
|
19995
|
-
# <note markdown="1"> This parameter isn't
|
20716
|
+
# <note markdown="1"> This parameter isn't supported for the MySQL or MariaDB engines. It
|
20717
|
+
# also doesn't apply to RDS Custom.
|
19996
20718
|
#
|
19997
20719
|
# </note>
|
19998
20720
|
# @return [String]
|
@@ -20000,6 +20722,8 @@ module Aws::RDS
|
|
20000
20722
|
# @!attribute [rw] engine
|
20001
20723
|
# The database engine to use for the new instance.
|
20002
20724
|
#
|
20725
|
+
# This setting doesn't apply to RDS Custom.
|
20726
|
+
#
|
20003
20727
|
# Default: The same as source
|
20004
20728
|
#
|
20005
20729
|
# Constraint: Must be compatible with the engine of the source
|
@@ -20047,8 +20771,10 @@ module Aws::RDS
|
|
20047
20771
|
#
|
20048
20772
|
# Permanent options, such as the TDE option for Oracle Advanced
|
20049
20773
|
# Security TDE, can't be removed from an option group, and that
|
20050
|
-
# option group can't be removed from a DB instance
|
20774
|
+
# option group can't be removed from a DB instance after it is
|
20051
20775
|
# associated with a DB instance
|
20776
|
+
#
|
20777
|
+
# This setting doesn't apply to RDS Custom.
|
20052
20778
|
# @return [String]
|
20053
20779
|
#
|
20054
20780
|
# @!attribute [rw] copy_tags_to_snapshot
|
@@ -20080,11 +20806,15 @@ module Aws::RDS
|
|
20080
20806
|
# @!attribute [rw] tde_credential_arn
|
20081
20807
|
# The ARN from the key store with which to associate the instance for
|
20082
20808
|
# TDE encryption.
|
20809
|
+
#
|
20810
|
+
# This setting doesn't apply to RDS Custom.
|
20083
20811
|
# @return [String]
|
20084
20812
|
#
|
20085
20813
|
# @!attribute [rw] tde_credential_password
|
20086
20814
|
# The password for the given ARN from the key store in order to access
|
20087
20815
|
# the device.
|
20816
|
+
#
|
20817
|
+
# This setting doesn't apply to RDS Custom.
|
20088
20818
|
# @return [String]
|
20089
20819
|
#
|
20090
20820
|
# @!attribute [rw] vpc_security_group_ids
|
@@ -20097,9 +20827,11 @@ module Aws::RDS
|
|
20097
20827
|
#
|
20098
20828
|
# @!attribute [rw] domain
|
20099
20829
|
# Specify the Active Directory directory ID to restore the DB instance
|
20100
|
-
# in.
|
20101
|
-
# only MySQL, Microsoft SQL Server, Oracle, and
|
20102
|
-
#
|
20830
|
+
# in. Create the domain before running this command. Currently, you
|
20831
|
+
# can create only the MySQL, Microsoft SQL Server, Oracle, and
|
20832
|
+
# PostgreSQL DB instances in an Active Directory Domain.
|
20833
|
+
#
|
20834
|
+
# This setting doesn't apply to RDS Custom.
|
20103
20835
|
#
|
20104
20836
|
# For more information, see [ Kerberos Authentication][1] in the
|
20105
20837
|
# *Amazon RDS User Guide*.
|
@@ -20112,6 +20844,8 @@ module Aws::RDS
|
|
20112
20844
|
# @!attribute [rw] domain_iam_role_name
|
20113
20845
|
# Specify the name of the IAM role to be used when making API calls to
|
20114
20846
|
# the Directory Service.
|
20847
|
+
#
|
20848
|
+
# This setting doesn't apply to RDS Custom.
|
20115
20849
|
# @return [String]
|
20116
20850
|
#
|
20117
20851
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -20119,6 +20853,8 @@ module Aws::RDS
|
|
20119
20853
|
# Services Identity and Access Management (IAM) accounts to database
|
20120
20854
|
# accounts. By default, mapping is disabled.
|
20121
20855
|
#
|
20856
|
+
# This setting doesn't apply to RDS Custom.
|
20857
|
+
#
|
20122
20858
|
# For more information about IAM database authentication, see [ IAM
|
20123
20859
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
20124
20860
|
# RDS User Guide.*
|
@@ -20134,6 +20870,8 @@ module Aws::RDS
|
|
20134
20870
|
# being used. For more information, see [Publishing Database Logs to
|
20135
20871
|
# Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
20136
20872
|
#
|
20873
|
+
# This setting doesn't apply to RDS Custom.
|
20874
|
+
#
|
20137
20875
|
#
|
20138
20876
|
#
|
20139
20877
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -20142,11 +20880,15 @@ module Aws::RDS
|
|
20142
20880
|
# @!attribute [rw] processor_features
|
20143
20881
|
# The number of CPU cores and the number of threads per core for the
|
20144
20882
|
# DB instance class of the DB instance.
|
20883
|
+
#
|
20884
|
+
# This setting doesn't apply to RDS Custom.
|
20145
20885
|
# @return [Array<Types::ProcessorFeature>]
|
20146
20886
|
#
|
20147
20887
|
# @!attribute [rw] use_default_processor_features
|
20148
20888
|
# A value that indicates whether the DB instance class of the DB
|
20149
20889
|
# instance uses its default processor features.
|
20890
|
+
#
|
20891
|
+
# This setting doesn't apply to RDS Custom.
|
20150
20892
|
# @return [Boolean]
|
20151
20893
|
#
|
20152
20894
|
# @!attribute [rw] db_parameter_group_name
|
@@ -20156,6 +20898,8 @@ module Aws::RDS
|
|
20156
20898
|
# If you do not specify a value for `DBParameterGroupName`, then the
|
20157
20899
|
# default `DBParameterGroup` for the specified DB engine is used.
|
20158
20900
|
#
|
20901
|
+
# This setting doesn't apply to RDS Custom.
|
20902
|
+
#
|
20159
20903
|
# Constraints:
|
20160
20904
|
#
|
20161
20905
|
# * If supplied, must match the name of an existing DBParameterGroup.
|
@@ -20190,6 +20934,8 @@ module Aws::RDS
|
|
20190
20934
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
20191
20935
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
20192
20936
|
#
|
20937
|
+
# This setting doesn't apply to RDS Custom.
|
20938
|
+
#
|
20193
20939
|
#
|
20194
20940
|
#
|
20195
20941
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -20199,6 +20945,8 @@ module Aws::RDS
|
|
20199
20945
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
20200
20946
|
# from which to restore, for example,
|
20201
20947
|
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
20948
|
+
#
|
20949
|
+
# This setting doesn't apply to RDS Custom.
|
20202
20950
|
# @return [String]
|
20203
20951
|
#
|
20204
20952
|
# @!attribute [rw] enable_customer_owned_ip
|
@@ -20211,6 +20959,8 @@ module Aws::RDS
|
|
20211
20959
|
# instance from outside of its virtual private cloud (VPC) on your
|
20212
20960
|
# local network.
|
20213
20961
|
#
|
20962
|
+
# This setting doesn't apply to RDS Custom.
|
20963
|
+
#
|
20214
20964
|
# For more information about RDS on Outposts, see [Working with Amazon
|
20215
20965
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
20216
20966
|
# Guide*.
|
@@ -20224,6 +20974,30 @@ module Aws::RDS
|
|
20224
20974
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
20225
20975
|
# @return [Boolean]
|
20226
20976
|
#
|
20977
|
+
# @!attribute [rw] custom_iam_instance_profile
|
20978
|
+
# The instance profile associated with the underlying Amazon EC2
|
20979
|
+
# instance of an RDS Custom DB instance. The instance profile must
|
20980
|
+
# meet the following requirements:
|
20981
|
+
#
|
20982
|
+
# * The profile must exist in your account.
|
20983
|
+
#
|
20984
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions
|
20985
|
+
# to assume.
|
20986
|
+
#
|
20987
|
+
# * The instance profile name and the associated IAM role name must
|
20988
|
+
# start with the prefix `AWSRDSCustom`.
|
20989
|
+
#
|
20990
|
+
# For the list of permissions required for the IAM role, see [
|
20991
|
+
# Configure IAM and your VPC][1] in the *Amazon Relational Database
|
20992
|
+
# Service User Guide*.
|
20993
|
+
#
|
20994
|
+
# This setting is required for RDS Custom.
|
20995
|
+
#
|
20996
|
+
#
|
20997
|
+
#
|
20998
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
20999
|
+
# @return [String]
|
21000
|
+
#
|
20227
21001
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTimeMessage AWS API Documentation
|
20228
21002
|
#
|
20229
21003
|
class RestoreDBInstanceToPointInTimeMessage < Struct.new(
|
@@ -20260,7 +21034,8 @@ module Aws::RDS
|
|
20260
21034
|
:source_dbi_resource_id,
|
20261
21035
|
:max_allocated_storage,
|
20262
21036
|
:source_db_instance_automated_backups_arn,
|
20263
|
-
:enable_customer_owned_ip
|
21037
|
+
:enable_customer_owned_ip,
|
21038
|
+
:custom_iam_instance_profile)
|
20264
21039
|
SENSITIVE = []
|
20265
21040
|
include Aws::Structure
|
20266
21041
|
end
|
@@ -20666,7 +21441,7 @@ module Aws::RDS
|
|
20666
21441
|
# The Amazon Web Services KMS key identifier for encrypting messages
|
20667
21442
|
# in the database activity stream. The Amazon Web Services KMS key
|
20668
21443
|
# identifier is the key ARN, key ID, alias ARN, or alias name for the
|
20669
|
-
#
|
21444
|
+
# KMS key.
|
20670
21445
|
# @return [String]
|
20671
21446
|
#
|
20672
21447
|
# @!attribute [rw] apply_immediately
|
@@ -20908,11 +21683,10 @@ module Aws::RDS
|
|
20908
21683
|
# @return [String]
|
20909
21684
|
#
|
20910
21685
|
# @!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
|
21686
|
+
# The ID of the Amazon Web Services KMS key to use to encrypt the
|
21687
|
+
# snapshot exported to Amazon S3. The Amazon Web Services KMS key
|
21688
|
+
# identifier is the key ARN, key ID, alias ARN, or alias name for the
|
21689
|
+
# KMS key. The caller of this operation must be authorized to execute
|
20916
21690
|
# the following operations. These can be set in the Amazon Web
|
20917
21691
|
# Services KMS key policy:
|
20918
21692
|
#
|
@@ -21008,8 +21782,7 @@ module Aws::RDS
|
|
21008
21782
|
# messages in the database activity stream.
|
21009
21783
|
#
|
21010
21784
|
# 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).
|
21785
|
+
# alias ARN, or alias name for the KMS key.
|
21013
21786
|
# @return [String]
|
21014
21787
|
#
|
21015
21788
|
# @!attribute [rw] kinesis_stream_name
|