Skip to content

Commit

Permalink
docs(client-rds): Updates to Aurora MySQL and Aurora PostgreSQL API p…
Browse files Browse the repository at this point in the history
…ages with instance log type in the create and modify DB Cluster.
  • Loading branch information
awstools committed Jan 31, 2025
1 parent 49662bc commit 31194b2
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 22 deletions.
7 changes: 4 additions & 3 deletions clients/client-rds/src/commands/StopDBInstanceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ export interface StopDBInstanceCommandInput extends StopDBInstanceMessage {}
export interface StopDBInstanceCommandOutput extends StopDBInstanceResult, __MetadataBearer {}

/**
* <p>Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint,
* DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if
* necessary.</p>
* <p>Stops an Amazon RDS DB instance temporarily. When you stop a DB instance, Amazon RDS retains the DB instance's metadata,
* including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains
* the transaction logs so you can do a point-in-time restore if necessary. The instance restarts automatically
* after 7 days.</p>
* <p>For more information, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html">
* Stopping an Amazon RDS DB Instance Temporarily</a> in the
Expand Down
15 changes: 11 additions & 4 deletions clients/client-rds/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4984,11 +4984,11 @@ export interface CreateDBClusterMessage {
* <p>The following values are valid for each DB engine:</p>
* <ul>
* <li>
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
* <p>Aurora MySQL - <code>audit | error | general | instance | slowquery</code>
* </p>
* </li>
* <li>
* <p>Aurora PostgreSQL - <code>postgresql</code>
* <p>Aurora PostgreSQL - <code>instance | postgresql</code>
* </p>
* </li>
* <li>
Expand Down Expand Up @@ -6207,7 +6207,14 @@ export interface DBCluster {
IAMDatabaseAuthenticationEnabled?: boolean | undefined;

/**
* <p>The ID of the clone group with which the DB cluster is associated.</p>
* <p>The ID of the clone group with which the DB cluster is associated. For newly created
* clusters, the ID is typically null. </p>
* <p>If you clone a DB cluster when the ID is null, the operation populates the ID value
* for the source cluster and the clone because both clusters become part of the same clone
* group. Even if you delete the clone cluster, the clone group ID remains for the lifetime
* of the source cluster to show that it was used in a cloning operation.</p>
* <p>For PITR, the clone group ID is inherited from the source cluster. For snapshot
* restore operations, the clone group ID isn't inherited from the source cluster.</p>
* @public
*/
CloneGroupId?: string | undefined;
Expand Down Expand Up @@ -8620,7 +8627,7 @@ export interface CreateDBInstanceMessage {
NetworkType?: string | undefined;

/**
* <p>The storage throughput value for the DB instance.</p>
* <p>The storage throughput value, in mebibyte per second (MiBps), for the DB instance.</p>
* <p>This setting applies only to the <code>gp3</code> storage type.</p>
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
* @public
Expand Down
19 changes: 12 additions & 7 deletions clients/client-rds/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7673,11 +7673,11 @@ export interface ModifyDBClusterMessage {
* <p>The following values are valid for each DB engine:</p>
* <ul>
* <li>
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
* <p>Aurora MySQL - <code>audit | error | general | instance | slowquery</code>
* </p>
* </li>
* <li>
* <p>Aurora PostgreSQL - <code>postgresql</code>
* <p>Aurora PostgreSQL - <code>instance | postgresql</code>
* </p>
* </li>
* <li>
Expand Down Expand Up @@ -11423,7 +11423,12 @@ export interface RestoreDBClusterFromS3Message {
* <p>
* <b>Aurora MySQL</b>
* </p>
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p>
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, <code>instance</code>, and <code>slowquery</code>.</p>
* <p>
* <b>Aurora PostgreSQL</b>
* </p>
* <p>Possible value are <code>instance</code> and <code>postgresql</code>.</p>
* <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>
* @public
*/
Expand Down Expand Up @@ -11859,11 +11864,11 @@ export interface RestoreDBClusterFromSnapshotMessage {
* <p>
* <b>Aurora MySQL</b>
* </p>
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p>
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, <code>instance</code>, and <code>slowquery</code>.</p>
* <p>
* <b>Aurora PostgreSQL</b>
* </p>
* <p>Possible value is <code>postgresql</code>.</p>
* <p>Possible value are <code>instance</code> and <code>postgresql</code>.</p>
* <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
Expand Down Expand Up @@ -12371,11 +12376,11 @@ export interface RestoreDBClusterToPointInTimeMessage {
* <p>
* <b>Aurora MySQL</b>
* </p>
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p>
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, <code>instance</code>, and <code>slowquery</code>.</p>
* <p>
* <b>Aurora PostgreSQL</b>
* </p>
* <p>Possible value is <code>postgresql</code>.</p>
* <p>Possible value are <code>instance</code> and <code>postgresql</code>.</p>
* <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
Expand Down
Loading

0 comments on commit 31194b2

Please # to comment.