Skip to content

Commit

Permalink
Documentation updates to clarify the description for the parameter Al…
Browse files Browse the repository at this point in the history
…locatedStorage 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.
  • Loading branch information
aws-sdk-dotnet-automation committed Feb 5, 2025
1 parent facae93 commit 864597b
Show file tree
Hide file tree
Showing 14 changed files with 26 additions and 213 deletions.
14 changes: 7 additions & 7 deletions generator/ServiceModels/rds/rds-2014-10-31.docs.json

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions generator/ServiceModels/rds/rds-2014-10-31.normal.json
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
"documentation":"<p>Creates a new DB parameter group.</p> <p>A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.</p> <p>This command doesn't apply to RDS Custom.</p> <important> <p>After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>"
"documentation":"<p>Creates a new DB parameter group.</p> <p>A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.</p> <p>This command doesn't apply to RDS Custom.</p>"
},
"CreateDBProxy":{
"name":"CreateDBProxy",
Expand Down Expand Up @@ -2283,7 +2283,7 @@
{"shape":"InvalidIntegrationStateFault"},
{"shape":"IntegrationConflictOperationFault"}
],
"documentation":"<p>Modifies a zero-ETL integration with Amazon Redshift.</p> <note> <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> </note>"
"documentation":"<p>Modifies a zero-ETL integration with Amazon Redshift.</p>"
},
"ModifyOptionGroup":{
"name":"ModifyOptionGroup",
Expand Down Expand Up @@ -5271,7 +5271,7 @@
"Tags":{"shape":"TagList"},
"DataFilter":{
"shape":"DataFilter",
"documentation":"<p>Data filtering options for the integration. For more information, see <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>. </p> <p>Valid for: Integrations with Aurora MySQL source DB clusters only</p>"
"documentation":"<p>Data filtering options for the integration. For more information, see <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> or <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>. </p>"
},
"Description":{
"shape":"IntegrationDescription",
Expand Down Expand Up @@ -5452,7 +5452,7 @@
"members":{
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"<p>For all database engines except Amazon Aurora, <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). For Aurora, <code>AllocatedStorage</code> always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.</p>"
"documentation":"<p> <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). For Aurora, <code>AllocatedStorage</code> can vary because Aurora DB cluster storage size adjusts as needed.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZones",
Expand Down Expand Up @@ -8808,7 +8808,7 @@
},
"DeleteAutomatedBackups":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.</p>"
"documentation":"<p>Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the Amazon Web Services Backup policy specifies a point-in-time restore rule.</p>"
}
},
"documentation":"<p/>"
Expand Down Expand Up @@ -12891,7 +12891,7 @@
},
"NewName":{
"shape":"String",
"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>"
"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> <p>You can't rename the <code>default</code> target group.</p>"
}
}
},
Expand Down Expand Up @@ -13110,7 +13110,7 @@
},
"DataFilter":{
"shape":"DataFilter",
"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 for Aurora zero-ETL integrations with Amazon Redshift</a>.</p>"
"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 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 filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.</p>"
},
"Description":{
"shape":"IntegrationDescription",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,6 @@ namespace Amazon.RDS.Model
/// <para>
/// This command doesn't apply to RDS Custom.
/// </para>
/// <important>
/// <para>
/// After you create a DB parameter group, you should wait at least 5 minutes before creating
/// your first DB instance that uses that DB parameter group as the default parameter
/// group. This allows Amazon RDS to fully complete the create action before the parameter
/// group is used as the default for a new DB instance. This is especially important for
/// parameters that are critical when creating the default database for a DB instance,
/// such as the character set for the default database defined by the <c>character_set_database</c>
/// parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon
/// RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB
/// parameter group has been created or modified.
/// </para>
/// </important>
/// </summary>
public partial class CreateDBParameterGroupRequest : AmazonRDSRequest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,8 @@ internal bool IsSetAdditionalEncryptionContext()
/// Gets and sets the property DataFilter.
/// <para>
/// Data filtering options for the integration. For more information, see <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>.
/// </para>
///
/// <para>
/// Valid for: Integrations with Aurora MySQL source DB clusters only
/// filtering 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
/// filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=25600)]
Expand Down
5 changes: 2 additions & 3 deletions sdk/src/Services/RDS/Generated/Model/DBCluster.cs
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,8 @@ internal bool IsSetActivityStreamStatus()
/// <summary>
/// Gets and sets the property AllocatedStorage.
/// <para>
/// For all database engines except Amazon Aurora, <c>AllocatedStorage</c> specifies the
/// allocated storage size in gibibytes (GiB). For Aurora, <c>AllocatedStorage</c> always
/// returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically
/// <c>AllocatedStorage</c> specifies the allocated storage size in gibibytes (GiB).
/// For Aurora, <c>AllocatedStorage</c> can vary because Aurora DB cluster storage size
/// adjusts as needed.
/// </para>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ internal bool IsSetDBClusterIdentifier()
/// <para>
/// Specifies whether to remove automated backups immediately after the DB cluster is
/// deleted. This parameter isn't case-sensitive. The default is to remove automated backups
/// immediately after the DB cluster is deleted.
/// immediately after the DB cluster is deleted, unless the Amazon Web Services Backup
/// policy specifies a point-in-time restore rule.
/// </para>
/// </summary>
public bool DeleteAutomatedBackups
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ internal bool IsSetDBProxyName()
/// a letter and must contain only ASCII letters, digits, and hyphens; it can't end with
/// a hyphen or contain two consecutive hyphens.
/// </para>
///
/// <para>
/// You can't rename the <c>default</c> target group.
/// </para>
/// </summary>
public string NewName
{
Expand Down
11 changes: 2 additions & 9 deletions sdk/src/Services/RDS/Generated/Model/ModifyIntegrationRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,6 @@ namespace Amazon.RDS.Model
/// <summary>
/// Container for the parameters to the ModifyIntegration operation.
/// Modifies a zero-ETL integration with Amazon Redshift.
///
/// <note>
/// <para>
/// 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.
/// </para>
/// </note>
/// </summary>
public partial class ModifyIntegrationRequest : AmazonRDSRequest
{
Expand All @@ -52,7 +44,8 @@ public partial class ModifyIntegrationRequest : AmazonRDSRequest
/// Gets and sets the property DataFilter.
/// <para>
/// 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 for Aurora zero-ETL integrations with Amazon Redshift</a>.
/// filtering 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
/// filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=25600)]
Expand Down
21 changes: 0 additions & 21 deletions sdk/src/Services/RDS/Generated/_bcl35/AmazonRDSClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2266,19 +2266,6 @@ public virtual CreateDBInstanceReadReplicaResponse EndCreateDBInstanceReadReplic
/// <para>
/// This command doesn't apply to RDS Custom.
/// </para>
/// <important>
/// <para>
/// After you create a DB parameter group, you should wait at least 5 minutes before creating
/// your first DB instance that uses that DB parameter group as the default parameter
/// group. This allows Amazon RDS to fully complete the create action before the parameter
/// group is used as the default for a new DB instance. This is especially important for
/// parameters that are critical when creating the default database for a DB instance,
/// such as the character set for the default database defined by the <c>character_set_database</c>
/// parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon
/// RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB
/// parameter group has been created or modified.
/// </para>
/// </important>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup service method.</param>
///
Expand Down Expand Up @@ -10001,14 +9988,6 @@ public virtual ModifyGlobalClusterResponse EndModifyGlobalCluster(IAsyncResult a

/// <summary>
/// Modifies a zero-ETL integration with Amazon Redshift.
///
/// <note>
/// <para>
/// 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.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ModifyIntegration service method.</param>
///
Expand Down
21 changes: 0 additions & 21 deletions sdk/src/Services/RDS/Generated/_bcl35/IAmazonRDS.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1753,19 +1753,6 @@ public partial interface IAmazonRDS : IAmazonService, IDisposable
/// <para>
/// This command doesn't apply to RDS Custom.
/// </para>
/// <important>
/// <para>
/// After you create a DB parameter group, you should wait at least 5 minutes before creating
/// your first DB instance that uses that DB parameter group as the default parameter
/// group. This allows Amazon RDS to fully complete the create action before the parameter
/// group is used as the default for a new DB instance. This is especially important for
/// parameters that are critical when creating the default database for a DB instance,
/// such as the character set for the default database defined by the <c>character_set_database</c>
/// parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon
/// RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB
/// parameter group has been created or modified.
/// </para>
/// </important>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup service method.</param>
///
Expand Down Expand Up @@ -7979,14 +7966,6 @@ public partial interface IAmazonRDS : IAmazonService, IDisposable

/// <summary>
/// Modifies a zero-ETL integration with Amazon Redshift.
///
/// <note>
/// <para>
/// 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.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ModifyIntegration service method.</param>
///
Expand Down
42 changes: 0 additions & 42 deletions sdk/src/Services/RDS/Generated/_bcl45/AmazonRDSClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2775,19 +2775,6 @@ public virtual CreateDBInstanceReadReplicaResponse CreateDBInstanceReadReplica(C
/// <para>
/// This command doesn't apply to RDS Custom.
/// </para>
/// <important>
/// <para>
/// After you create a DB parameter group, you should wait at least 5 minutes before creating
/// your first DB instance that uses that DB parameter group as the default parameter
/// group. This allows Amazon RDS to fully complete the create action before the parameter
/// group is used as the default for a new DB instance. This is especially important for
/// parameters that are critical when creating the default database for a DB instance,
/// such as the character set for the default database defined by the <c>character_set_database</c>
/// parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon
/// RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB
/// parameter group has been created or modified.
/// </para>
/// </important>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup service method.</param>
///
Expand Down Expand Up @@ -2827,19 +2814,6 @@ public virtual CreateDBParameterGroupResponse CreateDBParameterGroup(CreateDBPar
/// <para>
/// This command doesn't apply to RDS Custom.
/// </para>
/// <important>
/// <para>
/// After you create a DB parameter group, you should wait at least 5 minutes before creating
/// your first DB instance that uses that DB parameter group as the default parameter
/// group. This allows Amazon RDS to fully complete the create action before the parameter
/// group is used as the default for a new DB instance. This is especially important for
/// parameters that are critical when creating the default database for a DB instance,
/// such as the character set for the default database defined by the <c>character_set_database</c>
/// parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon
/// RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB
/// parameter group has been created or modified.
/// </para>
/// </important>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup service method.</param>
/// <param name="cancellationToken">
Expand Down Expand Up @@ -11277,14 +11251,6 @@ public virtual ModifyGlobalClusterResponse ModifyGlobalCluster(ModifyGlobalClust

/// <summary>
/// Modifies a zero-ETL integration with Amazon Redshift.
///
/// <note>
/// <para>
/// 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.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ModifyIntegration service method.</param>
///
Expand Down Expand Up @@ -11313,14 +11279,6 @@ public virtual ModifyIntegrationResponse ModifyIntegration(ModifyIntegrationRequ

/// <summary>
/// Modifies a zero-ETL integration with Amazon Redshift.
///
/// <note>
/// <para>
/// 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.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ModifyIntegration service method.</param>
/// <param name="cancellationToken">
Expand Down
Loading

0 comments on commit 864597b

Please sign in to comment.