aws_sdk_docdb/client/reset_db_cluster_parameter_group.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ResetDBClusterParameterGroup`](crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`db_cluster_parameter_group_name(impl Into<String>)`](crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder::db_cluster_parameter_group_name) / [`set_db_cluster_parameter_group_name(Option<String>)`](crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder::set_db_cluster_parameter_group_name):<br>required: **true**<br><p>The name of the cluster parameter group to reset.</p><br>
7 /// - [`reset_all_parameters(bool)`](crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder::reset_all_parameters) / [`set_reset_all_parameters(Option<bool>)`](crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder::set_reset_all_parameters):<br>required: **false**<br><p>A value that is set to <code>true</code> to reset all parameters in the cluster parameter group to their default values, and <code>false</code> otherwise. You can't use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter.</p><br>
8 /// - [`parameters(Parameter)`](crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder::parameters) / [`set_parameters(Option<Vec::<Parameter>>)`](crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder::set_parameters):<br>required: **false**<br><p>A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>.</p><br>
9 /// - On success, responds with [`ResetDbClusterParameterGroupOutput`](crate::operation::reset_db_cluster_parameter_group::ResetDbClusterParameterGroupOutput) with field(s):
10 /// - [`db_cluster_parameter_group_name(Option<String>)`](crate::operation::reset_db_cluster_parameter_group::ResetDbClusterParameterGroupOutput::db_cluster_parameter_group_name): <p>The name of a cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 255 letters or numbers.</p></li> <li> <p>The first character must be a letter.</p></li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li> </ul><note> <p>This value is stored as a lowercase string.</p> </note>
11 /// - On failure, responds with [`SdkError<ResetDBClusterParameterGroupError>`](crate::operation::reset_db_cluster_parameter_group::ResetDBClusterParameterGroupError)
12 pub fn reset_db_cluster_parameter_group(
13 &self,
14 ) -> crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder {
15 crate::operation::reset_db_cluster_parameter_group::builders::ResetDBClusterParameterGroupFluentBuilder::new(self.handle.clone())
16 }
17}