aws_sdk_lightsail/client/get_relational_database_master_user_password.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 [`GetRelationalDatabaseMasterUserPassword`](crate::operation::get_relational_database_master_user_password::builders::GetRelationalDatabaseMasterUserPasswordFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`relational_database_name(impl Into<String>)`](crate::operation::get_relational_database_master_user_password::builders::GetRelationalDatabaseMasterUserPasswordFluentBuilder::relational_database_name) / [`set_relational_database_name(Option<String>)`](crate::operation::get_relational_database_master_user_password::builders::GetRelationalDatabaseMasterUserPasswordFluentBuilder::set_relational_database_name):<br>required: **true**<br><p>The name of your database for which to get the master user password.</p><br>
7 /// - [`password_version(RelationalDatabasePasswordVersion)`](crate::operation::get_relational_database_master_user_password::builders::GetRelationalDatabaseMasterUserPasswordFluentBuilder::password_version) / [`set_password_version(Option<RelationalDatabasePasswordVersion>)`](crate::operation::get_relational_database_master_user_password::builders::GetRelationalDatabaseMasterUserPasswordFluentBuilder::set_password_version):<br>required: **false**<br><p>The password version to return.</p> <p>Specifying <code>CURRENT</code> or <code>PREVIOUS</code> returns the current or previous passwords respectively. Specifying <code>PENDING</code> returns the newest version of the password that will rotate to <code>CURRENT</code>. After the <code>PENDING</code> password rotates to <code>CURRENT</code>, the <code>PENDING</code> password is no longer available.</p> <p>Default: <code>CURRENT</code></p><br>
8 /// - On success, responds with [`GetRelationalDatabaseMasterUserPasswordOutput`](crate::operation::get_relational_database_master_user_password::GetRelationalDatabaseMasterUserPasswordOutput) with field(s):
9 /// - [`master_user_password(Option<String>)`](crate::operation::get_relational_database_master_user_password::GetRelationalDatabaseMasterUserPasswordOutput::master_user_password): <p>The master user password for the <code>password version</code> specified.</p>
10 /// - [`created_at(Option<DateTime>)`](crate::operation::get_relational_database_master_user_password::GetRelationalDatabaseMasterUserPasswordOutput::created_at): <p>The timestamp when the specified version of the master user password was created.</p>
11 /// - On failure, responds with [`SdkError<GetRelationalDatabaseMasterUserPasswordError>`](crate::operation::get_relational_database_master_user_password::GetRelationalDatabaseMasterUserPasswordError)
12 pub fn get_relational_database_master_user_password(
13 &self,
14 ) -> crate::operation::get_relational_database_master_user_password::builders::GetRelationalDatabaseMasterUserPasswordFluentBuilder {
15 crate::operation::get_relational_database_master_user_password::builders::GetRelationalDatabaseMasterUserPasswordFluentBuilder::new(
16 self.handle.clone(),
17 )
18 }
19}