| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword
Description
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
The GetRelationalDatabaseMasterUserPassword operation supports
tag-based access control via resource tags applied to the resource
identified by relationalDatabaseName.
Synopsis
- data GetRelationalDatabaseMasterUserPassword = GetRelationalDatabaseMasterUserPassword' {}
- newGetRelationalDatabaseMasterUserPassword :: Text -> GetRelationalDatabaseMasterUserPassword
- getRelationalDatabaseMasterUserPassword_passwordVersion :: Lens' GetRelationalDatabaseMasterUserPassword (Maybe RelationalDatabasePasswordVersion)
- getRelationalDatabaseMasterUserPassword_relationalDatabaseName :: Lens' GetRelationalDatabaseMasterUserPassword Text
- data GetRelationalDatabaseMasterUserPasswordResponse = GetRelationalDatabaseMasterUserPasswordResponse' {
- masterUserPassword :: Maybe (Sensitive Text)
- createdAt :: Maybe POSIX
- httpStatus :: Int
- newGetRelationalDatabaseMasterUserPasswordResponse :: Int -> GetRelationalDatabaseMasterUserPasswordResponse
- getRelationalDatabaseMasterUserPasswordResponse_masterUserPassword :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe Text)
- getRelationalDatabaseMasterUserPasswordResponse_createdAt :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe UTCTime)
- getRelationalDatabaseMasterUserPasswordResponse_httpStatus :: Lens' GetRelationalDatabaseMasterUserPasswordResponse Int
Creating a Request
data GetRelationalDatabaseMasterUserPassword Source #
See: newGetRelationalDatabaseMasterUserPassword smart constructor.
Constructors
| GetRelationalDatabaseMasterUserPassword' | |
Fields
| |
Instances
newGetRelationalDatabaseMasterUserPassword Source #
Arguments
| :: Text |
|
| -> GetRelationalDatabaseMasterUserPassword |
Create a value of GetRelationalDatabaseMasterUserPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:passwordVersion:GetRelationalDatabaseMasterUserPassword', getRelationalDatabaseMasterUserPassword_passwordVersion - The password version to return.
Specifying CURRENT or PREVIOUS returns the current or previous
passwords respectively. Specifying PENDING returns the newest version
of the password that will rotate to CURRENT. After the PENDING
password rotates to CURRENT, the PENDING password is no longer
available.
Default: CURRENT
$sel:relationalDatabaseName:GetRelationalDatabaseMasterUserPassword', getRelationalDatabaseMasterUserPassword_relationalDatabaseName - The name of your database for which to get the master user password.
Request Lenses
getRelationalDatabaseMasterUserPassword_passwordVersion :: Lens' GetRelationalDatabaseMasterUserPassword (Maybe RelationalDatabasePasswordVersion) Source #
The password version to return.
Specifying CURRENT or PREVIOUS returns the current or previous
passwords respectively. Specifying PENDING returns the newest version
of the password that will rotate to CURRENT. After the PENDING
password rotates to CURRENT, the PENDING password is no longer
available.
Default: CURRENT
getRelationalDatabaseMasterUserPassword_relationalDatabaseName :: Lens' GetRelationalDatabaseMasterUserPassword Text Source #
The name of your database for which to get the master user password.
Destructuring the Response
data GetRelationalDatabaseMasterUserPasswordResponse Source #
See: newGetRelationalDatabaseMasterUserPasswordResponse smart constructor.
Constructors
| GetRelationalDatabaseMasterUserPasswordResponse' | |
Fields
| |
Instances
newGetRelationalDatabaseMasterUserPasswordResponse Source #
Arguments
| :: Int |
|
| -> GetRelationalDatabaseMasterUserPasswordResponse |
Create a value of GetRelationalDatabaseMasterUserPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:masterUserPassword:GetRelationalDatabaseMasterUserPasswordResponse', getRelationalDatabaseMasterUserPasswordResponse_masterUserPassword - The master user password for the password version specified.
$sel:createdAt:GetRelationalDatabaseMasterUserPasswordResponse', getRelationalDatabaseMasterUserPasswordResponse_createdAt - The timestamp when the specified version of the master user password was
created.
$sel:httpStatus:GetRelationalDatabaseMasterUserPasswordResponse', getRelationalDatabaseMasterUserPasswordResponse_httpStatus - The response's http status code.
Response Lenses
getRelationalDatabaseMasterUserPasswordResponse_masterUserPassword :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe Text) Source #
The master user password for the password version specified.
getRelationalDatabaseMasterUserPasswordResponse_createdAt :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe UTCTime) Source #
The timestamp when the specified version of the master user password was created.
getRelationalDatabaseMasterUserPasswordResponse_httpStatus :: Lens' GetRelationalDatabaseMasterUserPasswordResponse Int Source #
The response's http status code.