Skip to content

Commit cee790f

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation for TAZ export to S3.
1 parent dc63d2c commit cee790f

File tree

3 files changed

+11
-15
lines changed

3 files changed

+11
-15
lines changed

Diff for: clients/client-rds/src/commands/StartExportTaskCommand.ts

-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear
3232
* <p>Starts an export of DB snapshot or DB cluster data to Amazon S3.
3333
* The provided IAM role must have access to the S3 bucket.</p>
3434
* <p>You can't export snapshot data from Db2 or RDS Custom DB instances.</p>
35-
* <p>You can't export cluster data from Multi-AZ DB clusters.</p>
3635
* <p>For more information on exporting DB snapshot data, see
3736
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html">Exporting DB snapshot
3837
* data to Amazon S3</a> in the <i>Amazon RDS User Guide</i>

Diff for: clients/client-rds/src/models/models_0.ts

+6-9
Original file line numberDiff line numberDiff line change
@@ -2462,8 +2462,8 @@ export interface CopyDBSnapshotMessage {
24622462
* <p>The current number CPU cores and threads is set to a non-default value.</p>
24632463
* </li>
24642464
* </ul>
2465-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor">Configuring the
2466-
* Processor of the DB Instance Class</a> in the <i>Amazon RDS User Guide.
2465+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor">
2466+
* Configuring the processor for a DB instance class in RDS for Oracle</a> in the <i>Amazon RDS User Guide.
24672467
* </i>
24682468
* </p>
24692469
* @public
@@ -2476,7 +2476,7 @@ export interface ProcessorFeature {
24762476
Name?: string;
24772477

24782478
/**
2479-
* <p>The value of a processor feature name.</p>
2479+
* <p>The value of a processor feature.</p>
24802480
* @public
24812481
*/
24822482
Value?: string;
@@ -4454,9 +4454,6 @@ export interface CreateDBClusterMessage {
44544454
* <li>
44554455
* <p>Must match the name of an existing DB subnet group.</p>
44564456
* </li>
4457-
* <li>
4458-
* <p>Must not be <code>default</code>.</p>
4459-
* </li>
44604457
* </ul>
44614458
* <p>Example: <code>mydbsubnetgroup</code>
44624459
* </p>
@@ -5281,7 +5278,7 @@ export interface DBClusterRole {
52815278
}
52825279

52835280
/**
5284-
* <p>Returns the details of the DB instance’s server certificate.</p>
5281+
* <p>The details of the DB instance’s server certificate.</p>
52855282
* <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
52865283
* instance</a> in the <i>Amazon RDS User Guide</i> and
52875284
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">
@@ -5615,7 +5612,7 @@ export interface ClusterPendingModifiedValues {
56155612
StorageType?: string;
56165613

56175614
/**
5618-
* <p>Returns the details of the DB instance’s server certificate.</p>
5615+
* <p>The details of the DB instance’s server certificate.</p>
56195616
* <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
56205617
* instance</a> in the <i>Amazon RDS User Guide</i> and
56215618
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">
@@ -6325,7 +6322,7 @@ export interface DBCluster {
63256322
StorageThroughput?: number;
63266323

63276324
/**
6328-
* <p>Returns the details of the DB instance’s server certificate.</p>
6325+
* <p>The details of the DB instance’s server certificate.</p>
63296326
* <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
63306327
* instance</a> in the <i>Amazon RDS User Guide</i> and
63316328
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">

Diff for: codegen/sdk-codegen/aws-models/rds.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -2783,7 +2783,7 @@
27832783
}
27842784
},
27852785
"traits": {
2786-
"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>"
2786+
"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>"
27872787
}
27882788
},
27892789
"com.amazonaws.rds#CertificateList": {
@@ -4193,7 +4193,7 @@
41934193
"DBSubnetGroupName": {
41944194
"target": "com.amazonaws.rds#String",
41954195
"traits": {
4196-
"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>"
4196+
"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>"
41974197
}
41984198
},
41994199
"Engine": {
@@ -24869,12 +24869,12 @@
2486924869
"Value": {
2487024870
"target": "com.amazonaws.rds#String",
2487124871
"traits": {
24872-
"smithy.api#documentation": "<p>The value of a processor feature name.</p>"
24872+
"smithy.api#documentation": "<p>The value of a processor feature.</p>"
2487324873
}
2487424874
}
2487524875
},
2487624876
"traits": {
24877-
"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>"
24877+
"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>"
2487824878
}
2487924879
},
2488024880
"com.amazonaws.rds#ProcessorFeatureList": {
@@ -29752,7 +29752,7 @@
2975229752
}
2975329753
],
2975429754
"traits": {
29755-
"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>",
29755+
"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>",
2975629756
"smithy.api#examples": [
2975729757
{
2975829758
"title": "To export a snapshot to Amazon S3",

0 commit comments

Comments
 (0)