aws_sdk_docdb/client/

describe_db_cluster_parameters.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBClusterParameters`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_cluster_parameter_group_name(impl Into<String>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::db_cluster_parameter_group_name) / [`set_db_cluster_parameter_group_name(Option<String>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::set_db_cluster_parameter_group_name):<br>required: **true**<br><p>The name of a specific cluster parameter group to return parameter details for.</p> <p>Constraints:</p> <ul>  <li>   <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p></li> </ul><br>
    ///   - [`source(impl Into<String>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::source) / [`set_source(Option<String>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::set_source):<br>required: **false**<br><p>A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::set_filters):<br>required: **false**<br><p>This parameter is not currently supported.</p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p><br>
    /// - On success, responds with [`DescribeDbClusterParametersOutput`](crate::operation::describe_db_cluster_parameters::DescribeDbClusterParametersOutput) with field(s):
    ///   - [`parameters(Option<Vec::<Parameter>>)`](crate::operation::describe_db_cluster_parameters::DescribeDbClusterParametersOutput::parameters): <p>Provides a list of parameters for the cluster parameter group.</p>
    ///   - [`marker(Option<String>)`](crate::operation::describe_db_cluster_parameters::DescribeDbClusterParametersOutput::marker): <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeDBClusterParametersError>`](crate::operation::describe_db_cluster_parameters::DescribeDBClusterParametersError)
    pub fn describe_db_cluster_parameters(
        &self,
    ) -> crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder {
        crate::operation::describe_db_cluster_parameters::builders::DescribeDBClusterParametersFluentBuilder::new(self.handle.clone())
    }
}