aws_sdk_redshift/client/
get_cluster_credentials_with_iam.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 [`GetClusterCredentialsWithIAM`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`db_name(impl Into<String>)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::db_name) / [`set_db_name(Option<String>)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::set_db_name):<br>required: **false**<br><p>The name of the database for which you are requesting credentials. If the database name is specified, the IAM policy must allow access to the resource <code>dbname</code> for the specified database name. If the database name is not specified, access to all databases is allowed.</p><br>
7    ///   - [`cluster_identifier(impl Into<String>)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::set_cluster_identifier):<br>required: **false**<br><p>The unique identifier of the cluster that contains the database for which you are requesting credentials.</p><br>
8    ///   - [`duration_seconds(i32)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::duration_seconds) / [`set_duration_seconds(Option<i32>)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::set_duration_seconds):<br>required: **false**<br><p>The number of seconds until the returned temporary password expires.</p> <p>Range: 900-3600. Default: 900.</p><br>
9    ///   - [`custom_domain_name(impl Into<String>)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::custom_domain_name) / [`set_custom_domain_name(Option<String>)`](crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::set_custom_domain_name):<br>required: **false**<br><p>The custom domain name for the IAM message cluster credentials.</p><br>
10    /// - On success, responds with [`GetClusterCredentialsWithIamOutput`](crate::operation::get_cluster_credentials_with_iam::GetClusterCredentialsWithIamOutput) with field(s):
11    ///   - [`db_user(Option<String>)`](crate::operation::get_cluster_credentials_with_iam::GetClusterCredentialsWithIamOutput::db_user): <p>A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.</p>
12    ///   - [`db_password(Option<String>)`](crate::operation::get_cluster_credentials_with_iam::GetClusterCredentialsWithIamOutput::db_password): <p>A temporary password that you provide when you connect to a database.</p>
13    ///   - [`expiration(Option<DateTime>)`](crate::operation::get_cluster_credentials_with_iam::GetClusterCredentialsWithIamOutput::expiration): <p>The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.</p>
14    ///   - [`next_refresh_time(Option<DateTime>)`](crate::operation::get_cluster_credentials_with_iam::GetClusterCredentialsWithIamOutput::next_refresh_time): <p>Reserved for future use.</p>
15    /// - On failure, responds with [`SdkError<GetClusterCredentialsWithIAMError>`](crate::operation::get_cluster_credentials_with_iam::GetClusterCredentialsWithIAMError)
16    pub fn get_cluster_credentials_with_iam(
17        &self,
18    ) -> crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder {
19        crate::operation::get_cluster_credentials_with_iam::builders::GetClusterCredentialsWithIAMFluentBuilder::new(self.handle.clone())
20    }
21}