Struct aws_sdk_redshift::client::fluent_builders::DescribeClusterParameters

pub struct DescribeClusterParameters { /* private fields */ }

Fluent builder constructing a request to DescribeClusterParameters.

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Implementations

impl DescribeClusterParameters

pub async fn send(
    self
) -> Result<DescribeClusterParametersOutput, SdkError<DescribeClusterParametersError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeClusterParametersPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn parameter_group_name(self, input: impl Into<String>) -> Self

The name of a cluster parameter group for which to return details.

pub fn set_parameter_group_name(self, input: Option<String>) -> Self

The name of a cluster parameter group for which to return details.

pub fn source(self, input: impl Into<String>) -> Self

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

pub fn set_source(self, input: Option<String>) -> Self

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

pub fn max_records(self, input: i32) -> Self

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

pub fn set_max_records(self, input: Option<i32>) -> Self

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

pub fn marker(self, input: impl Into<String>) -> Self

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

pub fn set_marker(self, input: Option<String>) -> Self

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Trait Implementations

impl Clone for DescribeClusterParameters

fn clone(&self) -> DescribeClusterParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeClusterParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.