Struct aws_sdk_redshiftdata::operation::list_databases::builders::ListDatabasesFluentBuilder

pub struct ListDatabasesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListDatabases.

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Implementations

impl ListDatabasesFluentBuilder

pub fn as_input(&self) -> &ListDatabasesInputBuilder

Access the ListDatabases as a reference.

pub async fn send( self ) -> Result<ListDatabasesOutput, SdkError<ListDatabasesError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<ListDatabasesOutput, ListDatabasesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListDatabasesPaginator

Create a paginator for this request

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

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

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

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

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

pub fn get_cluster_identifier(&self) -> &Option<String>

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

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

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

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

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

pub fn get_database(&self) -> &Option<String>

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

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

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

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

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

pub fn get_secret_arn(&self) -> &Option<String>

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

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

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

pub fn get_db_user(&self) -> &Option<String>

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

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

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

pub fn get_next_token(&self) -> &Option<String>

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

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

The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

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

The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

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

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

pub fn get_workgroup_name(&self) -> &Option<String>

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Trait Implementations

impl Clone for ListDatabasesFluentBuilder

fn clone(&self) -> ListDatabasesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListDatabasesFluentBuilder

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

Formats the value using the given formatter.