Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation for TAZ IAM support
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Oct 17, 2024
1 parent 5933d69 commit e0b3fe4
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 30 deletions.
12 changes: 7 additions & 5 deletions clients/client-rds/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4798,10 +4798,12 @@ export interface CreateDBClusterMessage {
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
* Management (IAM) accounts to database accounts. By default, mapping isn't
* enabled.</p>
* <p>For more information, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">IAM database
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
* RDS User Guide</i>.</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
EnableIAMDatabaseAuthentication?: boolean;
Expand Down Expand Up @@ -14302,7 +14304,7 @@ export class DBShardGroupNotFoundFault extends __BaseException {
*/
export interface DeleteDBShardGroupMessage {
/**
* <p>Teh name of the DB shard group to delete.</p>
* <p>The name of the DB shard group to delete.</p>
* @public
*/
DBShardGroupIdentifier: string | undefined;
Expand Down
40 changes: 23 additions & 17 deletions clients/client-rds/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3371,8 +3371,8 @@ export interface DescribeDBSecurityGroupsMessage {
*/
export interface DescribeDBShardGroupsMessage {
/**
* <p>The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified,
* information for only the specific DB shard group is returned. This parameter isn't case-sensitive.</p>
* <p>The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned.
* This parameter isn't case-sensitive.</p>
* <p>Constraints:</p>
* <ul>
* <li>
Expand Down Expand Up @@ -7519,10 +7519,12 @@ export interface ModifyDBClusterMessage {
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
* Management (IAM) accounts to database accounts. By default, mapping isn't
* enabled.</p>
* <p>For more information, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">IAM database
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
* RDS User Guide</i>.</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
EnableIAMDatabaseAuthentication?: boolean;
Expand Down Expand Up @@ -7815,7 +7817,7 @@ export interface ModifyDBClusterMessage {
* <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
EnablePerformanceInsights?: boolean;
Expand Down Expand Up @@ -11644,10 +11646,12 @@ export interface RestoreDBClusterFromSnapshotMessage {
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
* Management (IAM) accounts to database accounts. By default, mapping isn't
* enabled.</p>
* <p>For more information, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>Valid for: Aurora DB clusters only</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html"> IAM database
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
* RDS User Guide</i>.</p>
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
EnableIAMDatabaseAuthentication?: boolean;
Expand Down Expand Up @@ -12096,10 +12100,12 @@ export interface RestoreDBClusterToPointInTimeMessage {
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
* Management (IAM) accounts to database accounts. By default, mapping isn't
* enabled.</p>
* <p>For more information, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>Valid for: Aurora DB clusters only</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html"> IAM Database
* Authentication</a> in the <i>Amazon Aurora User Guide</i> or
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html"> IAM database
* authentication for MariaDB, MySQL, and PostgreSQL</a> in the <i>Amazon
* RDS User Guide</i>.</p>
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
EnableIAMDatabaseAuthentication?: boolean;
Expand Down Expand Up @@ -15051,11 +15057,11 @@ export interface StopDBInstanceAutomatedBackupsReplicationResult {
*/
export interface SwitchoverBlueGreenDeploymentRequest {
/**
* <p>The unique identifier of the blue/green deployment.</p>
* <p>The resource ID of the blue/green deployment.</p>
* <p>Constraints:</p>
* <ul>
* <li>
* <p>Must match an existing blue/green deployment identifier.</p>
* <p>Must match an existing blue/green deployment resource ID.</p>
* </li>
* </ul>
* @public
Expand Down
16 changes: 8 additions & 8 deletions codegen/sdk-codegen/aws-models/rds.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4296,7 +4296,7 @@
"EnableIAMDatabaseAuthentication": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
"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>"
"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>"
}
},
"BacktrackWindow": {
Expand Down Expand Up @@ -12707,7 +12707,7 @@
"target": "com.amazonaws.rds#DBShardGroupIdentifier",
"traits": {
"smithy.api#clientOptional": {},
"smithy.api#documentation": "<p>Teh name of the DB shard group to delete.</p>",
"smithy.api#documentation": "<p>The name of the DB shard group to delete.</p>",
"smithy.api#required": {}
}
}
Expand Down Expand Up @@ -15866,7 +15866,7 @@
"DBShardGroupIdentifier": {
"target": "com.amazonaws.rds#DBShardGroupIdentifier",
"traits": {
"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>"
"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>"
}
},
"Filters": {
Expand Down Expand Up @@ -21533,7 +21533,7 @@
"EnableIAMDatabaseAuthentication": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
"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>"
"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>"
}
},
"BacktrackWindow": {
Expand Down Expand Up @@ -21653,7 +21653,7 @@
"EnablePerformanceInsights": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
"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>"
"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>"
}
},
"PerformanceInsightsKMSKeyId": {
Expand Down Expand Up @@ -27143,7 +27143,7 @@
"EnableIAMDatabaseAuthentication": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
"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>"
"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>"
}
},
"BacktrackWindow": {
Expand Down Expand Up @@ -27462,7 +27462,7 @@
"EnableIAMDatabaseAuthentication": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
"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>"
"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>"
}
},
"BacktrackWindow": {
Expand Down Expand Up @@ -30469,7 +30469,7 @@
"target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier",
"traits": {
"smithy.api#clientOptional": {},
"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>",
"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>",
"smithy.api#required": {}
}
},
Expand Down

0 comments on commit e0b3fe4

Please sign in to comment.