Skip to content

Commit 5ab41aa

Browse files
author
awstools
committed
feat(client-rds): This Amazon RDS release adds support for managed master user passwords for Oracle CDBs.
1 parent 231b6cf commit 5ab41aa

File tree

10 files changed

+385
-25
lines changed

10 files changed

+385
-25
lines changed

‎clients/client-rds/src/commands/CreateTenantDatabaseCommand.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,11 @@ export interface CreateTenantDatabaseCommandOutput extends CreateTenantDatabaseR
4545
* DBInstanceIdentifier: "STRING_VALUE", // required
4646
* TenantDBName: "STRING_VALUE", // required
4747
* MasterUsername: "STRING_VALUE", // required
48-
* MasterUserPassword: "STRING_VALUE", // required
48+
* MasterUserPassword: "STRING_VALUE",
4949
* CharacterSetName: "STRING_VALUE",
5050
* NcharCharacterSetName: "STRING_VALUE",
51+
* ManageMasterUserPassword: true || false,
52+
* MasterUserSecretKmsKeyId: "STRING_VALUE",
5153
* Tags: [ // TagList
5254
* { // Tag
5355
* Key: "STRING_VALUE",
@@ -74,6 +76,11 @@ export interface CreateTenantDatabaseCommandOutput extends CreateTenantDatabaseR
7476
* // MasterUserPassword: "STRING_VALUE",
7577
* // TenantDBName: "STRING_VALUE",
7678
* // },
79+
* // MasterUserSecret: { // MasterUserSecret
80+
* // SecretArn: "STRING_VALUE",
81+
* // SecretStatus: "STRING_VALUE",
82+
* // KmsKeyId: "STRING_VALUE",
83+
* // },
7784
* // TagList: [ // TagList
7885
* // { // Tag
7986
* // Key: "STRING_VALUE",
@@ -98,6 +105,9 @@ export interface CreateTenantDatabaseCommandOutput extends CreateTenantDatabaseR
98105
* @throws {@link InvalidDBInstanceStateFault} (client fault)
99106
* <p>The DB instance isn't in a valid state.</p>
100107
*
108+
* @throws {@link KMSKeyNotAccessibleFault} (client fault)
109+
* <p>An error occurred accessing an Amazon Web Services KMS key.</p>
110+
*
101111
* @throws {@link TenantDatabaseAlreadyExistsFault} (client fault)
102112
* <p>You attempted to either create a tenant database that already exists or
103113
* modify a tenant database to use the name of an existing tenant database.</p>

‎clients/client-rds/src/commands/DeleteTenantDatabaseCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ export interface DeleteTenantDatabaseCommandOutput extends DeleteTenantDatabaseR
6767
* // MasterUserPassword: "STRING_VALUE",
6868
* // TenantDBName: "STRING_VALUE",
6969
* // },
70+
* // MasterUserSecret: { // MasterUserSecret
71+
* // SecretArn: "STRING_VALUE",
72+
* // SecretStatus: "STRING_VALUE",
73+
* // KmsKeyId: "STRING_VALUE",
74+
* // },
7075
* // TagList: [ // TagList
7176
* // { // Tag
7277
* // Key: "STRING_VALUE",

‎clients/client-rds/src/commands/DescribeTenantDatabasesCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ export interface DescribeTenantDatabasesCommandOutput extends TenantDatabasesMes
7575
* // MasterUserPassword: "STRING_VALUE",
7676
* // TenantDBName: "STRING_VALUE",
7777
* // },
78+
* // MasterUserSecret: { // MasterUserSecret
79+
* // SecretArn: "STRING_VALUE",
80+
* // SecretStatus: "STRING_VALUE",
81+
* // KmsKeyId: "STRING_VALUE",
82+
* // },
7883
* // TagList: [ // TagList
7984
* // { // Tag
8085
* // Key: "STRING_VALUE",

‎clients/client-rds/src/commands/ModifyTenantDatabaseCommand.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ export interface ModifyTenantDatabaseCommandOutput extends ModifyTenantDatabaseR
4747
* TenantDBName: "STRING_VALUE", // required
4848
* MasterUserPassword: "STRING_VALUE",
4949
* NewTenantDBName: "STRING_VALUE",
50+
* ManageMasterUserPassword: true || false,
51+
* RotateMasterUserPassword: true || false,
52+
* MasterUserSecretKmsKeyId: "STRING_VALUE",
5053
* };
5154
* const command = new ModifyTenantDatabaseCommand(input);
5255
* const response = await client.send(command);
@@ -67,6 +70,11 @@ export interface ModifyTenantDatabaseCommandOutput extends ModifyTenantDatabaseR
6770
* // MasterUserPassword: "STRING_VALUE",
6871
* // TenantDBName: "STRING_VALUE",
6972
* // },
73+
* // MasterUserSecret: { // MasterUserSecret
74+
* // SecretArn: "STRING_VALUE",
75+
* // SecretStatus: "STRING_VALUE",
76+
* // KmsKeyId: "STRING_VALUE",
77+
* // },
7078
* // TagList: [ // TagList
7179
* // { // Tag
7280
* // Key: "STRING_VALUE",
@@ -91,6 +99,9 @@ export interface ModifyTenantDatabaseCommandOutput extends ModifyTenantDatabaseR
9199
* @throws {@link InvalidDBInstanceStateFault} (client fault)
92100
* <p>The DB instance isn't in a valid state.</p>
93101
*
102+
* @throws {@link KMSKeyNotAccessibleFault} (client fault)
103+
* <p>An error occurred accessing an Amazon Web Services KMS key.</p>
104+
*
94105
* @throws {@link TenantDatabaseAlreadyExistsFault} (client fault)
95106
* <p>You attempted to either create a tenant database that already exists or
96107
* modify a tenant database to use the name of an existing tenant database.</p>

‎clients/client-rds/src/commands/RestoreDBInstanceFromDBSnapshotCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput
115115
* DedicatedLogVolume: true || false,
116116
* CACertificateIdentifier: "STRING_VALUE",
117117
* EngineLifecycleSupport: "STRING_VALUE",
118+
* ManageMasterUserPassword: true || false,
119+
* MasterUserSecretKmsKeyId: "STRING_VALUE",
118120
* };
119121
* const command = new RestoreDBInstanceFromDBSnapshotCommand(input);
120122
* const response = await client.send(command);

‎clients/client-rds/src/commands/RestoreDBInstanceToPointInTimeCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput
112112
* DedicatedLogVolume: true || false,
113113
* CACertificateIdentifier: "STRING_VALUE",
114114
* EngineLifecycleSupport: "STRING_VALUE",
115+
* ManageMasterUserPassword: true || false,
116+
* MasterUserSecretKmsKeyId: "STRING_VALUE",
115117
* };
116118
* const command = new RestoreDBInstanceToPointInTimeCommand(input);
117119
* const response = await client.send(command);

‎clients/client-rds/src/models/models_0.ts

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5218,7 +5218,8 @@ export interface CreateDBClusterMessage {
52185218
/**
52195219
* <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
52205220
* By default, minor engine upgrades are applied automatically.</p>
5221-
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster</p>
5221+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.</p>
5222+
* <p>For more information about automatic minor version upgrades, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades">Automatically upgrading the minor engine version</a>.</p>
52225223
* @public
52235224
*/
52245225
AutoMinorVersionUpgrade?: boolean | undefined;
@@ -6414,6 +6415,7 @@ export interface DBCluster {
64146415
/**
64156416
* <p>Indicates whether minor version patches are applied automatically.</p>
64166417
* <p>This setting is for Aurora DB clusters and Multi-AZ DB clusters.</p>
6418+
* <p>For more information about automatic minor version upgrades, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades">Automatically upgrading the minor engine version</a>.</p>
64176419
* @public
64186420
*/
64196421
AutoMinorVersionUpgrade?: boolean | undefined;
@@ -8057,6 +8059,7 @@ export interface CreateDBInstanceMessage {
80578059
* By default, minor engine upgrades are applied automatically.</p>
80588060
* <p>If you create an RDS Custom DB instance, you must set <code>AutoMinorVersionUpgrade</code> to
80598061
* <code>false</code>.</p>
8062+
* <p>For more information about automatic minor version upgrades, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades">Automatically upgrading the minor engine version</a>.</p>
80608063
* @public
80618064
*/
80628065
AutoMinorVersionUpgrade?: boolean | undefined;
@@ -9423,6 +9426,7 @@ export interface DBInstance {
94239426

94249427
/**
94259428
* <p>Indicates whether minor version patches are applied automatically.</p>
9429+
* <p>For more information about automatic minor version upgrades, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades">Automatically upgrading the minor engine version</a>.</p>
94269430
* @public
94279431
*/
94289432
AutoMinorVersionUpgrade?: boolean | undefined;
@@ -10152,6 +10156,7 @@ export interface CreateDBInstanceReadReplicaMessage {
1015210156
* read replica during the maintenance window.</p>
1015310157
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
1015410158
* <p>Default: Inherits the value from the source DB instance.</p>
10159+
* <p>For more information about automatic minor version upgrades, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades">Automatically upgrading the minor engine version</a>.</p>
1015510160
* @public
1015610161
*/
1015710162
AutoMinorVersionUpgrade?: boolean | undefined;
@@ -10993,7 +10998,21 @@ export interface UserAuthConfig {
1099310998
IAMAuth?: IAMAuthMode | undefined;
1099410999

1099511000
/**
10996-
* <p>The type of authentication the proxy uses for connections from clients.</p>
11001+
* <p>The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:</p>
11002+
* <ul>
11003+
* <li>
11004+
* <p>RDS for MySQL: <code>MYSQL_CACHING_SHA2_PASSWORD</code>
11005+
* </p>
11006+
* </li>
11007+
* <li>
11008+
* <p>RDS for SQL Server: <code>SQL_SERVER_AUTHENTICATION</code>
11009+
* </p>
11010+
* </li>
11011+
* <li>
11012+
* <p>RDS for PostgreSQL: <code>POSTGRES_SCRAM_SHA2_256</code>
11013+
* </p>
11014+
* </li>
11015+
* </ul>
1099711016
* @public
1099811017
*/
1099911018
ClientPasswordAuthType?: ClientPasswordAuthType | undefined;
@@ -13162,10 +13181,14 @@ export interface CreateTenantDatabaseMessage {
1316213181
* (<code>/</code>), double quote (<code>"</code>), at symbol (<code>@</code>),
1316313182
* ampersand (<code>&</code>), or single quote (<code>'</code>).</p>
1316413183
* </li>
13184+
* <li>
13185+
* <p>Can't be specified when <code>ManageMasterUserPassword</code> is
13186+
* enabled.</p>
13187+
* </li>
1316513188
* </ul>
1316613189
* @public
1316713190
*/
13168-
MasterUserPassword: string | undefined;
13191+
MasterUserPassword?: string | undefined;
1316913192

1317013193
/**
1317113194
* <p>The character set for your tenant database. If you don't specify a value, the
@@ -13180,6 +13203,39 @@ export interface CreateTenantDatabaseMessage {
1318013203
*/
1318113204
NcharCharacterSetName?: string | undefined;
1318213205

13206+
/**
13207+
* <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.</p>
13208+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
13209+
* in the <i>Amazon RDS User Guide.</i>
13210+
* </p>
13211+
* <p>Constraints:</p>
13212+
* <ul>
13213+
* <li>
13214+
* <p>Can't manage the master user password with Amazon Web Services Secrets Manager if <code>MasterUserPassword</code>
13215+
* is specified.</p>
13216+
* </li>
13217+
* </ul>
13218+
* @public
13219+
*/
13220+
ManageMasterUserPassword?: boolean | undefined;
13221+
13222+
/**
13223+
* <p>The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and
13224+
* managed in Amazon Web Services Secrets Manager.</p>
13225+
* <p>This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets
13226+
* Manager for the DB instance.</p>
13227+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
13228+
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p>
13229+
* <p>If you don't specify <code>MasterUserSecretKmsKeyId</code>, then the <code>aws/secretsmanager</code>
13230+
* KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't
13231+
* use the <code>aws/secretsmanager</code> KMS key to encrypt the secret, and you must use a customer
13232+
* managed KMS key.</p>
13233+
* <p>There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account
13234+
* has a different default KMS key for each Amazon Web Services Region.</p>
13235+
* @public
13236+
*/
13237+
MasterUserSecretKmsKeyId?: string | undefined;
13238+
1318313239
/**
1318413240
* <p>A list of tags.</p>
1318513241
* <p>For more information, see
@@ -13288,6 +13344,16 @@ export interface TenantDatabase {
1328813344
*/
1328913345
PendingModifiedValues?: TenantDatabasePendingModifiedValues | undefined;
1329013346

13347+
/**
13348+
* <p>Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.</p>
13349+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
13350+
* in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
13351+
* in the <i>Amazon Aurora User Guide.</i>
13352+
* </p>
13353+
* @public
13354+
*/
13355+
MasterUserSecret?: MasterUserSecret | undefined;
13356+
1329113357
/**
1329213358
* <p>A list of tags.</p>
1329313359
* <p>For more information, see

0 commit comments

Comments
 (0)