aws_sdk_neptune/operation/modify_db_parameter_group/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::modify_db_parameter_group::_modify_db_parameter_group_output::ModifyDbParameterGroupOutputBuilder;
3
4pub use crate::operation::modify_db_parameter_group::_modify_db_parameter_group_input::ModifyDbParameterGroupInputBuilder;
5
6impl crate::operation::modify_db_parameter_group::builders::ModifyDbParameterGroupInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::modify_db_parameter_group::ModifyDbParameterGroupOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::modify_db_parameter_group::ModifyDBParameterGroupError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.modify_db_parameter_group();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ModifyDBParameterGroup`.
24///
25/// <p>Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request.</p><note>
26/// <p>Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.</p>
27/// </note> <important>
28/// <p>After you modify 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 Neptune to fully complete the modify 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 Amazon Neptune console or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p>
29/// </important>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct ModifyDBParameterGroupFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::modify_db_parameter_group::builders::ModifyDbParameterGroupInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::modify_db_parameter_group::ModifyDbParameterGroupOutput,
39        crate::operation::modify_db_parameter_group::ModifyDBParameterGroupError,
40    > for ModifyDBParameterGroupFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::modify_db_parameter_group::ModifyDbParameterGroupOutput,
48            crate::operation::modify_db_parameter_group::ModifyDBParameterGroupError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl ModifyDBParameterGroupFluentBuilder {
55    /// Creates a new `ModifyDBParameterGroupFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the ModifyDBParameterGroup as a reference.
64    pub fn as_input(&self) -> &crate::operation::modify_db_parameter_group::builders::ModifyDbParameterGroupInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::modify_db_parameter_group::ModifyDbParameterGroupOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::modify_db_parameter_group::ModifyDBParameterGroupError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::modify_db_parameter_group::ModifyDBParameterGroup::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::modify_db_parameter_group::ModifyDBParameterGroup::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::modify_db_parameter_group::ModifyDbParameterGroupOutput,
101        crate::operation::modify_db_parameter_group::ModifyDBParameterGroupError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The name of the DB parameter group.</p>
116    /// <p>Constraints:</p>
117    /// <ul>
118    /// <li>
119    /// <p>If supplied, must match the name of an existing DBParameterGroup.</p></li>
120    /// </ul>
121    pub fn db_parameter_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.db_parameter_group_name(input.into());
123        self
124    }
125    /// <p>The name of the DB parameter group.</p>
126    /// <p>Constraints:</p>
127    /// <ul>
128    /// <li>
129    /// <p>If supplied, must match the name of an existing DBParameterGroup.</p></li>
130    /// </ul>
131    pub fn set_db_parameter_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_db_parameter_group_name(input);
133        self
134    }
135    /// <p>The name of the DB parameter group.</p>
136    /// <p>Constraints:</p>
137    /// <ul>
138    /// <li>
139    /// <p>If supplied, must match the name of an existing DBParameterGroup.</p></li>
140    /// </ul>
141    pub fn get_db_parameter_group_name(&self) -> &::std::option::Option<::std::string::String> {
142        self.inner.get_db_parameter_group_name()
143    }
144    ///
145    /// Appends an item to `Parameters`.
146    ///
147    /// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
148    ///
149    /// <p>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.</p>
150    /// <p>Valid Values (for the application method): <code>immediate | pending-reboot</code></p><note>
151    /// <p>You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.</p>
152    /// </note>
153    pub fn parameters(mut self, input: crate::types::Parameter) -> Self {
154        self.inner = self.inner.parameters(input);
155        self
156    }
157    /// <p>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.</p>
158    /// <p>Valid Values (for the application method): <code>immediate | pending-reboot</code></p><note>
159    /// <p>You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.</p>
160    /// </note>
161    pub fn set_parameters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Parameter>>) -> Self {
162        self.inner = self.inner.set_parameters(input);
163        self
164    }
165    /// <p>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.</p>
166    /// <p>Valid Values (for the application method): <code>immediate | pending-reboot</code></p><note>
167    /// <p>You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.</p>
168    /// </note>
169    pub fn get_parameters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Parameter>> {
170        self.inner.get_parameters()
171    }
172}