Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation for TAZ export to S3.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jun 27, 2024
1 parent dc63d2c commit cee790f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
1 change: 0 additions & 1 deletion clients/client-rds/src/commands/StartExportTaskCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear
* <p>Starts an export of DB snapshot or DB cluster data to Amazon S3.
* The provided IAM role must have access to the S3 bucket.</p>
* <p>You can't export snapshot data from Db2 or RDS Custom DB instances.</p>
* <p>You can't export cluster data from Multi-AZ DB clusters.</p>
* <p>For more information on exporting DB snapshot data, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html">Exporting DB snapshot
* data to Amazon S3</a> in the <i>Amazon RDS User Guide</i>
Expand Down
15 changes: 6 additions & 9 deletions clients/client-rds/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2462,8 +2462,8 @@ export interface CopyDBSnapshotMessage {
* <p>The current number CPU cores and threads is set to a non-default value.</p>
* </li>
* </ul>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor">Configuring the
* Processor of the DB Instance Class</a> in the <i>Amazon RDS User Guide.
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor">
* Configuring the processor for a DB instance class in RDS for Oracle</a> in the <i>Amazon RDS User Guide.
* </i>
* </p>
* @public
Expand All @@ -2476,7 +2476,7 @@ export interface ProcessorFeature {
Name?: string;

/**
* <p>The value of a processor feature name.</p>
* <p>The value of a processor feature.</p>
* @public
*/
Value?: string;
Expand Down Expand Up @@ -4454,9 +4454,6 @@ export interface CreateDBClusterMessage {
* <li>
* <p>Must match the name of an existing DB subnet group.</p>
* </li>
* <li>
* <p>Must not be <code>default</code>.</p>
* </li>
* </ul>
* <p>Example: <code>mydbsubnetgroup</code>
* </p>
Expand Down Expand Up @@ -5281,7 +5278,7 @@ export interface DBClusterRole {
}

/**
* <p>Returns the details of the DB instance’s server certificate.</p>
* <p>The details of the DB instance’s server certificate.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB
* instance</a> in the <i>Amazon RDS User Guide</i> and
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">
Expand Down Expand Up @@ -5615,7 +5612,7 @@ export interface ClusterPendingModifiedValues {
StorageType?: string;

/**
* <p>Returns the details of the DB instance’s server certificate.</p>
* <p>The details of the DB instance’s server certificate.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB
* instance</a> in the <i>Amazon RDS User Guide</i> and
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">
Expand Down Expand Up @@ -6325,7 +6322,7 @@ export interface DBCluster {
StorageThroughput?: number;

/**
* <p>Returns the details of the DB instance’s server certificate.</p>
* <p>The details of the DB instance’s server certificate.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB
* instance</a> in the <i>Amazon RDS User Guide</i> and
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">
Expand Down
10 changes: 5 additions & 5 deletions codegen/sdk-codegen/aws-models/rds.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2783,7 +2783,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Returns the details of the DB instance’s server certificate.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html\">Using SSL/TLS to encrypt a connection to a DB \n instance</a> in the <i>Amazon RDS User Guide</i> and \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html\">\n Using SSL/TLS to encrypt a connection to a DB cluster</a> in the <i>Amazon Aurora \n User Guide</i>.</p>"
"smithy.api#documentation": "<p>The details of the DB instance’s server certificate.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html\">Using SSL/TLS to encrypt a connection to a DB \n instance</a> in the <i>Amazon RDS User Guide</i> and \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html\">\n Using SSL/TLS to encrypt a connection to a DB cluster</a> in the <i>Amazon Aurora \n User Guide</i>.</p>"
}
},
"com.amazonaws.rds#CertificateList": {
Expand Down Expand Up @@ -4193,7 +4193,7 @@
"DBSubnetGroupName": {
"target": "com.amazonaws.rds#String",
"traits": {
"smithy.api#documentation": "<p>A DB subnet group to associate with this DB cluster.</p>\n <p>This setting is required to create a Multi-AZ DB cluster.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>Must match the name of an existing DB subnet group.</p>\n </li>\n <li>\n <p>Must not be <code>default</code>.</p>\n </li>\n </ul>\n <p>Example: <code>mydbsubnetgroup</code>\n </p>"
"smithy.api#documentation": "<p>A DB subnet group to associate with this DB cluster.</p>\n <p>This setting is required to create a Multi-AZ DB cluster.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>Must match the name of an existing DB subnet group.</p>\n </li>\n </ul>\n <p>Example: <code>mydbsubnetgroup</code>\n </p>"
}
},
"Engine": {
Expand Down Expand Up @@ -24869,12 +24869,12 @@
"Value": {
"target": "com.amazonaws.rds#String",
"traits": {
"smithy.api#documentation": "<p>The value of a processor feature name.</p>"
"smithy.api#documentation": "<p>The value of a processor feature.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the processor features of a DB instance class.</p>\n <p>To specify the number of CPU cores, use the <code>coreCount</code> feature name \n for the <code>Name</code> parameter. To specify the number of threads per core, use the\n <code>threadsPerCore</code> feature name for the <code>Name</code> parameter.</p>\n <p>You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:</p>\n <ul>\n <li>\n <p>\n <code>CreateDBInstance</code>\n </p>\n </li>\n <li>\n <p>\n <code>ModifyDBInstance</code>\n </p>\n </li>\n <li>\n <p>\n <code>RestoreDBInstanceFromDBSnapshot</code>\n </p>\n </li>\n <li>\n <p>\n <code>RestoreDBInstanceFromS3</code>\n </p>\n </li>\n <li>\n <p>\n <code>RestoreDBInstanceToPointInTime</code>\n </p>\n </li>\n </ul>\n <p>You can view the valid processor values for a particular instance class by calling the\n <code>DescribeOrderableDBInstanceOptions</code> action and specifying the\n instance class for the <code>DBInstanceClass</code> parameter.</p>\n <p>In addition, you can use the following actions for DB instance class processor information:</p>\n <ul>\n <li>\n <p>\n <code>DescribeDBInstances</code>\n </p>\n </li>\n <li>\n <p>\n <code>DescribeDBSnapshots</code>\n </p>\n </li>\n <li>\n <p>\n <code>DescribeValidDBInstanceModifications</code>\n </p>\n </li>\n </ul>\n <p>If you call <code>DescribeDBInstances</code>, <code>ProcessorFeature</code> returns\n non-null values only if the following conditions are met:</p>\n <ul>\n <li>\n <p>You are accessing an Oracle DB instance.</p>\n </li>\n <li>\n <p>Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.</p>\n </li>\n <li>\n <p>The current number CPU cores and threads is set to a non-default value.</p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor\">Configuring the\n Processor of the DB Instance Class</a> in the <i>Amazon RDS User Guide.\n </i>\n </p>"
"smithy.api#documentation": "<p>Contains the processor features of a DB instance class.</p>\n <p>To specify the number of CPU cores, use the <code>coreCount</code> feature name \n for the <code>Name</code> parameter. To specify the number of threads per core, use the\n <code>threadsPerCore</code> feature name for the <code>Name</code> parameter.</p>\n <p>You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:</p>\n <ul>\n <li>\n <p>\n <code>CreateDBInstance</code>\n </p>\n </li>\n <li>\n <p>\n <code>ModifyDBInstance</code>\n </p>\n </li>\n <li>\n <p>\n <code>RestoreDBInstanceFromDBSnapshot</code>\n </p>\n </li>\n <li>\n <p>\n <code>RestoreDBInstanceFromS3</code>\n </p>\n </li>\n <li>\n <p>\n <code>RestoreDBInstanceToPointInTime</code>\n </p>\n </li>\n </ul>\n <p>You can view the valid processor values for a particular instance class by calling the\n <code>DescribeOrderableDBInstanceOptions</code> action and specifying the\n instance class for the <code>DBInstanceClass</code> parameter.</p>\n <p>In addition, you can use the following actions for DB instance class processor information:</p>\n <ul>\n <li>\n <p>\n <code>DescribeDBInstances</code>\n </p>\n </li>\n <li>\n <p>\n <code>DescribeDBSnapshots</code>\n </p>\n </li>\n <li>\n <p>\n <code>DescribeValidDBInstanceModifications</code>\n </p>\n </li>\n </ul>\n <p>If you call <code>DescribeDBInstances</code>, <code>ProcessorFeature</code> returns\n non-null values only if the following conditions are met:</p>\n <ul>\n <li>\n <p>You are accessing an Oracle DB instance.</p>\n </li>\n <li>\n <p>Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.</p>\n </li>\n <li>\n <p>The current number CPU cores and threads is set to a non-default value.</p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor\">\n Configuring the processor for a DB instance class in RDS for Oracle</a> in the <i>Amazon RDS User Guide.\n </i>\n </p>"
}
},
"com.amazonaws.rds#ProcessorFeatureList": {
Expand Down Expand Up @@ -29752,7 +29752,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.</p>\n <p>You can't export snapshot data from Db2 or RDS Custom DB instances.</p>\n <p>You can't export cluster data from Multi-AZ DB clusters.</p>\n <p>For more information on exporting DB snapshot data, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html\">Exporting DB snapshot \n data to Amazon S3</a> in the <i>Amazon RDS User Guide</i>\n or <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html\">Exporting DB \n cluster snapshot data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</p>\n <p>For more information on exporting DB cluster data, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html\">Exporting DB \n cluster data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</p>",
"smithy.api#documentation": "<p>Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.</p>\n <p>You can't export snapshot data from Db2 or RDS Custom DB instances.</p>\n <p>For more information on exporting DB snapshot data, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html\">Exporting DB snapshot \n data to Amazon S3</a> in the <i>Amazon RDS User Guide</i>\n or <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html\">Exporting DB \n cluster snapshot data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</p>\n <p>For more information on exporting DB cluster data, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html\">Exporting DB \n cluster data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</p>",
"smithy.api#examples": [
{
"title": "To export a snapshot to Amazon S3",
Expand Down

0 comments on commit cee790f

Please sign in to comment.