Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Creating a Request

data GetRelationalDatabaseMasterUserPassword Source #

See: newGetRelationalDatabaseMasterUserPassword smart constructor.

Constructors

GetRelationalDatabaseMasterUserPassword'

Fields

passwordVersion :: Maybe RelationalDatabasePasswordVersion
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
relationalDatabaseName :: Text
The name of your database for which to get the master user password.

Instances

Instances details

ToJSON GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods toJSON :: GetRelationalDatabaseMasterUserPassword -> Value # toEncoding :: GetRelationalDatabaseMasterUserPassword -> Encoding # toJSONList :: [GetRelationalDatabaseMasterUserPassword] -> Value # toEncodingList :: [GetRelationalDatabaseMasterUserPassword] -> Encoding #
ToHeaders GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods toHeaders :: GetRelationalDatabaseMasterUserPassword -> [Header] #
ToPath GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods toPath :: GetRelationalDatabaseMasterUserPassword -> ByteString #
ToQuery GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods toQuery :: GetRelationalDatabaseMasterUserPassword -> QueryString #
AWSRequest GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Associated Types type AWSResponse GetRelationalDatabaseMasterUserPassword # Methods request :: (Service -> Service) -> GetRelationalDatabaseMasterUserPassword -> Request GetRelationalDatabaseMasterUserPassword # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRelationalDatabaseMasterUserPassword -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRelationalDatabaseMasterUserPassword))) #
Generic GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Associated Types type Rep GetRelationalDatabaseMasterUserPassword :: Type -> Type # Methods from :: GetRelationalDatabaseMasterUserPassword -> Rep GetRelationalDatabaseMasterUserPassword x # to :: Rep GetRelationalDatabaseMasterUserPassword x -> GetRelationalDatabaseMasterUserPassword #
Read GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods readsPrec :: Int -> ReadS GetRelationalDatabaseMasterUserPassword # readList :: ReadS [GetRelationalDatabaseMasterUserPassword] # readPrec :: ReadPrec GetRelationalDatabaseMasterUserPassword # readListPrec :: ReadPrec [GetRelationalDatabaseMasterUserPassword] #
Show GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods showsPrec :: Int -> GetRelationalDatabaseMasterUserPassword -> ShowS # show :: GetRelationalDatabaseMasterUserPassword -> String # showList :: [GetRelationalDatabaseMasterUserPassword] -> ShowS #
NFData GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods rnf :: GetRelationalDatabaseMasterUserPassword -> () #
Eq GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods (==) :: GetRelationalDatabaseMasterUserPassword -> GetRelationalDatabaseMasterUserPassword -> Bool # (/=) :: GetRelationalDatabaseMasterUserPassword -> GetRelationalDatabaseMasterUserPassword -> Bool #
Hashable GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods hashWithSalt :: Int -> GetRelationalDatabaseMasterUserPassword -> Int # hash :: GetRelationalDatabaseMasterUserPassword -> Int #
type AWSResponse GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword type AWSResponse GetRelationalDatabaseMasterUserPassword = GetRelationalDatabaseMasterUserPasswordResponse
type Rep GetRelationalDatabaseMasterUserPassword Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword type Rep GetRelationalDatabaseMasterUserPassword = D1 ('MetaData "GetRelationalDatabaseMasterUserPassword" "Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetRelationalDatabaseMasterUserPassword'" 'PrefixI 'True) (S1 ('MetaSel ('Just "passwordVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelationalDatabasePasswordVersion)) :*: S1 ('MetaSel ('Just "relationalDatabaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetRelationalDatabaseMasterUserPassword Source #

Arguments

:: Text	`$sel:relationalDatabaseName:GetRelationalDatabaseMasterUserPassword'`
-> 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 createdAt :: Maybe POSIX The timestamp when the specified version of the master user password was created. masterUserPassword :: Maybe (Sensitive Text) The master user password for the `password version` specified. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetRelationalDatabaseMasterUserPasswordResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Associated Types type Rep GetRelationalDatabaseMasterUserPasswordResponse :: Type -> Type # Methods from :: GetRelationalDatabaseMasterUserPasswordResponse -> Rep GetRelationalDatabaseMasterUserPasswordResponse x # to :: Rep GetRelationalDatabaseMasterUserPasswordResponse x -> GetRelationalDatabaseMasterUserPasswordResponse #
Show GetRelationalDatabaseMasterUserPasswordResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods showsPrec :: Int -> GetRelationalDatabaseMasterUserPasswordResponse -> ShowS # show :: GetRelationalDatabaseMasterUserPasswordResponse -> String # showList :: [GetRelationalDatabaseMasterUserPasswordResponse] -> ShowS #
NFData GetRelationalDatabaseMasterUserPasswordResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods rnf :: GetRelationalDatabaseMasterUserPasswordResponse -> () #
Eq GetRelationalDatabaseMasterUserPasswordResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword Methods (==) :: GetRelationalDatabaseMasterUserPasswordResponse -> GetRelationalDatabaseMasterUserPasswordResponse -> Bool # (/=) :: GetRelationalDatabaseMasterUserPasswordResponse -> GetRelationalDatabaseMasterUserPasswordResponse -> Bool #
type Rep GetRelationalDatabaseMasterUserPasswordResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword type Rep GetRelationalDatabaseMasterUserPasswordResponse = D1 ('MetaData "GetRelationalDatabaseMasterUserPasswordResponse" "Amazonka.Lightsail.GetRelationalDatabaseMasterUserPassword" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetRelationalDatabaseMasterUserPasswordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRelationalDatabaseMasterUserPasswordResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRelationalDatabaseMasterUserPasswordResponse'`
-> 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:

GetRelationalDatabaseMasterUserPasswordResponse, getRelationalDatabaseMasterUserPasswordResponse_createdAt - The timestamp when the specified version of the master user password was created.

GetRelationalDatabaseMasterUserPasswordResponse, getRelationalDatabaseMasterUserPasswordResponse_masterUserPassword - The master user password for the password version specified.

$sel:httpStatus:GetRelationalDatabaseMasterUserPasswordResponse', getRelationalDatabaseMasterUserPasswordResponse_httpStatus - The response's http status code.

Response Lenses

getRelationalDatabaseMasterUserPasswordResponse_createdAt :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe UTCTime) Source #

The timestamp when the specified version of the master user password was created.

getRelationalDatabaseMasterUserPasswordResponse_masterUserPassword :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe Text) Source #

The master user password for the password version specified.

getRelationalDatabaseMasterUserPasswordResponse_httpStatus :: Lens' GetRelationalDatabaseMasterUserPasswordResponse Int Source #

The response's http status code.