Skip to content

Commit ba6ad0a

Browse files
author
awstools
committed
docs(client-rds): Documentation updates to clarify the description for the parameter AllocatedStorage for the DB cluster data type, the description for the parameter DeleteAutomatedBackups for the DeleteDBCluster API operation, and removing an outdated note for the CreateDBParameterGroup API operation.
1 parent b301594 commit ba6ad0a

File tree

5 files changed

+19
-29
lines changed

5 files changed

+19
-29
lines changed

clients/client-rds/src/commands/CreateDBParameterGroupCommand.ts

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,6 @@ export interface CreateDBParameterGroupCommandOutput extends CreateDBParameterGr
3737
* a new DB parameter group with a running DB instance, you need to reboot the DB
3838
* instance without failover for the new DB parameter group and associated settings to take effect.</p>
3939
* <p>This command doesn't apply to RDS Custom.</p>
40-
* <important>
41-
* <p>After you create a DB parameter group, you should wait at least 5 minutes
42-
* before creating your first DB instance that uses that DB parameter group as the default parameter
43-
* group. This allows Amazon RDS to fully complete the create action before the parameter
44-
* group is used as the default for a new DB instance. This is especially important for parameters
45-
* that are critical when creating the default database for a DB instance, such as the character set
46-
* for the default database defined by the <code>character_set_database</code> parameter. You can use the
47-
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
48-
* <i>DescribeDBParameters</i> command to verify
49-
* that your DB parameter group has been created or modified.</p>
50-
* </important>
5140
* @example
5241
* Use a bare-bones client and the command you need to make an API call.
5342
* ```javascript

clients/client-rds/src/commands/ModifyIntegrationCommand.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ export interface ModifyIntegrationCommandOutput extends Integration, __MetadataB
3030

3131
/**
3232
* <p>Modifies a zero-ETL integration with Amazon Redshift.</p>
33-
* <note>
34-
* <p>Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.</p>
35-
* </note>
3633
* @example
3734
* Use a bare-bones client and the command you need to make an API call.
3835
* ```javascript

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5973,9 +5973,9 @@ export interface DBClusterStatusInfo {
59735973
*/
59745974
export interface DBCluster {
59755975
/**
5976-
* <p>For all database engines except Amazon Aurora, <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB).
5977-
* For Aurora, <code>AllocatedStorage</code> always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically
5978-
* adjusts as needed.</p>
5976+
* <p>
5977+
* <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB).
5978+
* For Aurora, <code>AllocatedStorage</code> can vary because Aurora DB cluster storage size adjusts as needed.</p>
59795979
* @public
59805980
*/
59815981
AllocatedStorage?: number | undefined;
@@ -12782,9 +12782,10 @@ export interface CreateIntegrationMessage {
1278212782

1278312783
/**
1278412784
* <p>Data filtering options for the integration. For more information, see
12785-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>.
12785+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>
12786+
* or
12787+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html">Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.
1278612788
* </p>
12787-
* <p>Valid for: Integrations with Aurora MySQL source DB clusters only</p>
1278812789
* @public
1278912790
*/
1279012791
DataFilter?: string | undefined;
@@ -13557,7 +13558,8 @@ export interface DeleteDBClusterMessage {
1355713558
/**
1355813559
* <p>Specifies whether to remove automated backups immediately after the DB
1355913560
* cluster is deleted. This parameter isn't case-sensitive. The default is to remove
13560-
* automated backups immediately after the DB cluster is deleted.</p>
13561+
* automated backups immediately after the DB cluster is deleted, unless the Amazon Web Services Backup
13562+
* policy specifies a point-in-time restore rule.</p>
1356113563
* @public
1356213564
*/
1356313565
DeleteAutomatedBackups?: boolean | undefined;

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9774,6 +9774,7 @@ export interface ModifyDBProxyTargetGroupRequest {
97749774

97759775
/**
97769776
* <p>The new name for the modified <code>DBProxyTarget</code>. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>
9777+
* <p>You can't rename the <code>default</code> target group.</p>
97779778
* @public
97789779
*/
97799780
NewName?: string | undefined;
@@ -10267,8 +10268,9 @@ export interface ModifyIntegrationMessage {
1026710268
IntegrationName?: string | undefined;
1026810269

1026910270
/**
10270-
* <p>A new data filter for the integration. For more information, see
10271-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>.</p>
10271+
* <p>A new data filter for the integration. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html">Data filtering
10272+
* for Aurora zero-ETL integrations with Amazon Redshift</a> or <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html">Data
10273+
* filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.</p>
1027210274
* @public
1027310275
*/
1027410276
DataFilter?: string | undefined;

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5750,7 +5750,7 @@
57505750
}
57515751
],
57525752
"traits": {
5753-
"smithy.api#documentation": "<p>Creates a new DB parameter group.</p>\n <p>A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to\n associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.</p>\n <p>This command doesn't apply to RDS Custom.</p>\n <important>\n <p>After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the <code>character_set_database</code> parameter. You can use the \n <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the \n <i>DescribeDBParameters</i> command to verify \n that your DB parameter group has been created or modified.</p>\n </important>",
5753+
"smithy.api#documentation": "<p>Creates a new DB parameter group.</p>\n <p>A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to\n associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.</p>\n <p>This command doesn't apply to RDS Custom.</p>",
57545754
"smithy.api#examples": [
57555755
{
57565756
"title": "To create a DB parameter group",
@@ -6760,7 +6760,7 @@
67606760
"DataFilter": {
67616761
"target": "com.amazonaws.rds#DataFilter",
67626762
"traits": {
6763-
"smithy.api#documentation": "<p>Data filtering options for the integration. For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html\">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>.\n </p>\n <p>Valid for: Integrations with Aurora MySQL source DB clusters only</p>"
6763+
"smithy.api#documentation": "<p>Data filtering options for the integration. For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html\">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>\n or\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html\">Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.\n </p>"
67646764
}
67656765
},
67666766
"Description": {
@@ -7114,7 +7114,7 @@
71147114
"AllocatedStorage": {
71157115
"target": "com.amazonaws.rds#IntegerOptional",
71167116
"traits": {
7117-
"smithy.api#documentation": "<p>For all database engines except Amazon Aurora, <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). \n For Aurora, <code>AllocatedStorage</code> always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.</p>"
7117+
"smithy.api#documentation": "<p>\n <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). \n For Aurora, <code>AllocatedStorage</code> can vary because Aurora DB cluster storage size adjusts as needed.</p>"
71187118
}
71197119
},
71207120
"AvailabilityZones": {
@@ -12261,7 +12261,7 @@
1226112261
"DeleteAutomatedBackups": {
1226212262
"target": "com.amazonaws.rds#BooleanOptional",
1226312263
"traits": {
12264-
"smithy.api#documentation": "<p>Specifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.</p>"
12264+
"smithy.api#documentation": "<p>Specifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted, unless the Amazon Web Services Backup \n policy specifies a point-in-time restore rule.</p>"
1226512265
}
1226612266
}
1226712267
},
@@ -22819,7 +22819,7 @@
2281922819
"NewName": {
2282022820
"target": "com.amazonaws.rds#String",
2282122821
"traits": {
22822-
"smithy.api#documentation": "<p>The new name for the modified <code>DBProxyTarget</code>. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>"
22822+
"smithy.api#documentation": "<p>The new name for the modified <code>DBProxyTarget</code>. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>\n <p>You can't rename the <code>default</code> target group.</p>"
2282322823
}
2282422824
}
2282522825
},
@@ -23503,7 +23503,7 @@
2350323503
}
2350423504
],
2350523505
"traits": {
23506-
"smithy.api#documentation": "<p>Modifies a zero-ETL integration with Amazon Redshift.</p>\n <note>\n <p>Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.</p>\n </note>",
23506+
"smithy.api#documentation": "<p>Modifies a zero-ETL integration with Amazon Redshift.</p>",
2350723507
"smithy.api#examples": [
2350823508
{
2350923509
"title": "To modify a zero-ETL integration",
@@ -23547,7 +23547,7 @@
2354723547
"DataFilter": {
2354823548
"target": "com.amazonaws.rds#DataFilter",
2354923549
"traits": {
23550-
"smithy.api#documentation": "<p>A new data filter for the integration. For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html\">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>.</p>"
23550+
"smithy.api#documentation": "<p>A new data filter for the integration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html\">Data filtering\n for Aurora zero-ETL integrations with Amazon Redshift</a> or <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html\">Data\n filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.</p>"
2355123551
}
2355223552
},
2355323553
"Description": {

0 commit comments

Comments
 (0)