aws_sdk_rds/client/
modify_db_parameter_group.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyDBParameterGroup`](crate::operation::modify_db_parameter_group::builders::ModifyDBParameterGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_parameter_group_name(impl Into<String>)`](crate::operation::modify_db_parameter_group::builders::ModifyDBParameterGroupFluentBuilder::db_parameter_group_name) / [`set_db_parameter_group_name(Option<String>)`](crate::operation::modify_db_parameter_group::builders::ModifyDBParameterGroupFluentBuilder::set_db_parameter_group_name):<br>required: **true**<br><p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul>  <li>   <p>If supplied, must match the name of an existing <code>DBParameterGroup</code>.</p></li> </ul><br>
    ///   - [`parameters(Parameter)`](crate::operation::modify_db_parameter_group::builders::ModifyDBParameterGroupFluentBuilder::parameters) / [`set_parameters(Option<Vec::<Parameter>>)`](crate::operation::modify_db_parameter_group::builders::ModifyDBParameterGroupFluentBuilder::set_parameters):<br>required: **true**<br><p>An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.</p> <p>Valid Values (for the application method): <code>immediate | pending-reboot</code></p> <p>You can use the <code>immediate</code> value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic and static parameters.</p> <p>When the application method is <code>immediate</code>, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.</p> <p>When the application method is <code>pending-reboot</code>, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.</p><note>  <p>You can't use <code>pending-reboot</code> with dynamic parameters on RDS for SQL Server DB instances. Use <code>immediate</code>.</p> </note> <p>For more information on modifying DB parameters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html">Working with DB parameter groups</a> in the <i>Amazon RDS User Guide</i>.</p><br>
    /// - On success, responds with [`ModifyDbParameterGroupOutput`](crate::operation::modify_db_parameter_group::ModifyDbParameterGroupOutput) with field(s):
    ///   - [`db_parameter_group_name(Option<String>)`](crate::operation::modify_db_parameter_group::ModifyDbParameterGroupOutput::db_parameter_group_name): <p>The name of the DB parameter group.</p>
    /// - On failure, responds with [`SdkError<ModifyDBParameterGroupError>`](crate::operation::modify_db_parameter_group::ModifyDBParameterGroupError)
    pub fn modify_db_parameter_group(&self) -> crate::operation::modify_db_parameter_group::builders::ModifyDBParameterGroupFluentBuilder {
        crate::operation::modify_db_parameter_group::builders::ModifyDBParameterGroupFluentBuilder::new(self.handle.clone())
    }
}