Skip to content

Commit e0b3fe4

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation for TAZ IAM support
1 parent 5933d69 commit e0b3fe4

File tree

3 files changed

+38
-30
lines changed

3 files changed

+38
-30
lines changed

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

+7-5
Original file line numberDiff line numberDiff line change
@@ -4798,10 +4798,12 @@ export interface CreateDBClusterMessage {
47984798
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
47994799
* Management (IAM) accounts to database accounts. By default, mapping isn't
48004800
* enabled.</p>
4801-
* <p>For more information, see
4802-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
4803-
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
4804-
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
4801+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
4802+
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
4803+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">IAM database
4804+
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
4805+
* RDS User Guide</i>.</p>
4806+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
48054807
* @public
48064808
*/
48074809
EnableIAMDatabaseAuthentication?: boolean;
@@ -14302,7 +14304,7 @@ export class DBShardGroupNotFoundFault extends __BaseException {
1430214304
*/
1430314305
export interface DeleteDBShardGroupMessage {
1430414306
/**
14305-
* <p>Teh name of the DB shard group to delete.</p>
14307+
* <p>The name of the DB shard group to delete.</p>
1430614308
* @public
1430714309
*/
1430814310
DBShardGroupIdentifier: string | undefined;

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

+23-17
Original file line numberDiff line numberDiff line change
@@ -3371,8 +3371,8 @@ export interface DescribeDBSecurityGroupsMessage {
33713371
*/
33723372
export interface DescribeDBShardGroupsMessage {
33733373
/**
3374-
* <p>The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified,
3375-
* information for only the specific DB shard group is returned. This parameter isn't case-sensitive.</p>
3374+
* <p>The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned.
3375+
* This parameter isn't case-sensitive.</p>
33763376
* <p>Constraints:</p>
33773377
* <ul>
33783378
* <li>
@@ -7519,10 +7519,12 @@ export interface ModifyDBClusterMessage {
75197519
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
75207520
* Management (IAM) accounts to database accounts. By default, mapping isn't
75217521
* enabled.</p>
7522-
* <p>For more information, see
7523-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
7524-
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
7525-
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
7522+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
7523+
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
7524+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">IAM database
7525+
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
7526+
* RDS User Guide</i>.</p>
7527+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
75267528
* @public
75277529
*/
75287530
EnableIAMDatabaseAuthentication?: boolean;
@@ -7815,7 +7817,7 @@ export interface ModifyDBClusterMessage {
78157817
* <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
78167818
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
78177819
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>
7818-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
7820+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
78197821
* @public
78207822
*/
78217823
EnablePerformanceInsights?: boolean;
@@ -11644,10 +11646,12 @@ export interface RestoreDBClusterFromSnapshotMessage {
1164411646
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
1164511647
* Management (IAM) accounts to database accounts. By default, mapping isn't
1164611648
* enabled.</p>
11647-
* <p>For more information, see
11648-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
11649-
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
11650-
* <p>Valid for: Aurora DB clusters only</p>
11649+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
11650+
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
11651+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html"> IAM database
11652+
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
11653+
* RDS User Guide</i>.</p>
11654+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
1165111655
* @public
1165211656
*/
1165311657
EnableIAMDatabaseAuthentication?: boolean;
@@ -12096,10 +12100,12 @@ export interface RestoreDBClusterToPointInTimeMessage {
1209612100
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
1209712101
* Management (IAM) accounts to database accounts. By default, mapping isn't
1209812102
* enabled.</p>
12099-
* <p>For more information, see
12100-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
12101-
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
12102-
* <p>Valid for: Aurora DB clusters only</p>
12103+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
12104+
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
12105+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html"> IAM database
12106+
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
12107+
* RDS User Guide</i>.</p>
12108+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
1210312109
* @public
1210412110
*/
1210512111
EnableIAMDatabaseAuthentication?: boolean;
@@ -15051,11 +15057,11 @@ export interface StopDBInstanceAutomatedBackupsReplicationResult {
1505115057
*/
1505215058
export interface SwitchoverBlueGreenDeploymentRequest {
1505315059
/**
15054-
* <p>The unique identifier of the blue/green deployment.</p>
15060+
* <p>The resource ID of the blue/green deployment.</p>
1505515061
* <p>Constraints:</p>
1505615062
* <ul>
1505715063
* <li>
15058-
* <p>Must match an existing blue/green deployment identifier.</p>
15064+
* <p>Must match an existing blue/green deployment resource ID.</p>
1505915065
* </li>
1506015066
* </ul>
1506115067
* @public

‎codegen/sdk-codegen/aws-models/rds.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -4296,7 +4296,7 @@
42964296
"EnableIAMDatabaseAuthentication": {
42974297
"target": "com.amazonaws.rds#BooleanOptional",
42984298
"traits": {
4299-
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\">\n IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>\n <p>Valid for Cluster Type: Aurora DB clusters only</p>"
4299+
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database\n Authentication</a> in the <i>Amazon Aurora User Guide</i> or\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\">IAM database\n authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon\n RDS User Guide</i>.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>"
43004300
}
43014301
},
43024302
"BacktrackWindow": {
@@ -12707,7 +12707,7 @@
1270712707
"target": "com.amazonaws.rds#DBShardGroupIdentifier",
1270812708
"traits": {
1270912709
"smithy.api#clientOptional": {},
12710-
"smithy.api#documentation": "<p>Teh name of the DB shard group to delete.</p>",
12710+
"smithy.api#documentation": "<p>The name of the DB shard group to delete.</p>",
1271112711
"smithy.api#required": {}
1271212712
}
1271312713
}
@@ -15866,7 +15866,7 @@
1586615866
"DBShardGroupIdentifier": {
1586715867
"target": "com.amazonaws.rds#DBShardGroupIdentifier",
1586815868
"traits": {
15869-
"smithy.api#documentation": "<p>The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, \n information for only the specific DB shard group is returned. This parameter isn't case-sensitive.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>If supplied, must match an existing DB shard group identifier.</p>\n </li>\n </ul>"
15869+
"smithy.api#documentation": "<p>The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. \n This parameter isn't case-sensitive.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>If supplied, must match an existing DB shard group identifier.</p>\n </li>\n </ul>"
1587015870
}
1587115871
},
1587215872
"Filters": {
@@ -21533,7 +21533,7 @@
2153321533
"EnableIAMDatabaseAuthentication": {
2153421534
"target": "com.amazonaws.rds#BooleanOptional",
2153521535
"traits": {
21536-
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\">\n IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>\n <p>Valid for Cluster Type: Aurora DB clusters only</p>"
21536+
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database\n Authentication</a> in the <i>Amazon Aurora User Guide</i> or\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\">IAM database\n authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon\n RDS User Guide</i>.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>"
2153721537
}
2153821538
},
2153921539
"BacktrackWindow": {
@@ -21653,7 +21653,7 @@
2165321653
"EnablePerformanceInsights": {
2165421654
"target": "com.amazonaws.rds#BooleanOptional",
2165521655
"traits": {
21656-
"smithy.api#documentation": "<p>Specifies whether to turn on Performance Insights for the DB cluster.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">\n Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>\n <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>"
21656+
"smithy.api#documentation": "<p>Specifies whether to turn on Performance Insights for the DB cluster.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">\n Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>"
2165721657
}
2165821658
},
2165921659
"PerformanceInsightsKMSKeyId": {
@@ -27143,7 +27143,7 @@
2714327143
"EnableIAMDatabaseAuthentication": {
2714427144
"target": "com.amazonaws.rds#BooleanOptional",
2714527145
"traits": {
27146-
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\">\n IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>\n <p>Valid for: Aurora DB clusters only</p>"
27146+
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database\n Authentication</a> in the <i>Amazon Aurora User Guide</i> or\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM database\n authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon\n RDS User Guide</i>.</p>\n <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
2714727147
}
2714827148
},
2714927149
"BacktrackWindow": {
@@ -27462,7 +27462,7 @@
2746227462
"EnableIAMDatabaseAuthentication": {
2746327463
"target": "com.amazonaws.rds#BooleanOptional",
2746427464
"traits": {
27465-
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\">\n IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>\n <p>Valid for: Aurora DB clusters only</p>"
27465+
"smithy.api#documentation": "<p>Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database\n Authentication</a> in the <i>Amazon Aurora User Guide</i> or\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM database\n authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon\n RDS User Guide</i>.</p>\n <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
2746627466
}
2746727467
},
2746827468
"BacktrackWindow": {
@@ -30469,7 +30469,7 @@
3046930469
"target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier",
3047030470
"traits": {
3047130471
"smithy.api#clientOptional": {},
30472-
"smithy.api#documentation": "<p>The unique identifier of the blue/green deployment.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>Must match an existing blue/green deployment identifier.</p>\n </li>\n </ul>",
30472+
"smithy.api#documentation": "<p>The resource ID of the blue/green deployment.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>Must match an existing blue/green deployment resource ID.</p>\n </li>\n </ul>",
3047330473
"smithy.api#required": {}
3047430474
}
3047530475
},

0 commit comments

Comments
 (0)