Network.AWS.SecretsManager.GetRandomPassword

Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Minimum permissions

To run this command, you must have the following permissions:

• secretsmanager:GetRandomPassword

Creating a Request

getRandomPassword :: GetRandomPassword

Creates a value of GetRandomPassword with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• grpIncludeSpace - Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
• grpExcludeNumbers - Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
• grpExcludeLowercase - Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
• grpExcludeCharacters - A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
• grpExcludePunctuation - Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
• grpRequireEachIncludedType - A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
• grpExcludeUppercase - Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
• grpPasswordLength - The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

data GetRandomPassword

See: getRandomPassword smart constructor.

Instances

Eq GetRandomPassword

Methods

(==) :: GetRandomPassword -> GetRandomPassword -> Bool

(/=) :: GetRandomPassword -> GetRandomPassword -> Bool

Data GetRandomPassword

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetRandomPassword -> c GetRandomPassword

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetRandomPassword

toConstr :: GetRandomPassword -> Constr

dataTypeOf :: GetRandomPassword -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetRandomPassword)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetRandomPassword)

gmapT :: (forall b. Data b => b -> b) -> GetRandomPassword -> GetRandomPassword

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetRandomPassword -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetRandomPassword -> r

gmapQ :: (forall d. Data d => d -> u) -> GetRandomPassword -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetRandomPassword -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetRandomPassword -> m GetRandomPassword

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRandomPassword -> m GetRandomPassword

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRandomPassword -> m GetRandomPassword

Read GetRandomPassword

Methods

readsPrec :: Int -> ReadS GetRandomPassword

readList :: ReadS [GetRandomPassword]

readPrec :: ReadPrec GetRandomPassword

readListPrec :: ReadPrec [GetRandomPassword]

Show GetRandomPassword

Methods

showsPrec :: Int -> GetRandomPassword -> ShowS

show :: GetRandomPassword -> String

showList :: [GetRandomPassword] -> ShowS

Generic GetRandomPassword

Associated Types

type Rep GetRandomPassword :: * -> *

Methods

from :: GetRandomPassword -> Rep GetRandomPassword x

to :: Rep GetRandomPassword x -> GetRandomPassword

Hashable GetRandomPassword

Methods

hashWithSalt :: Int -> GetRandomPassword -> Int

hash :: GetRandomPassword -> Int

ToJSON GetRandomPassword

Methods

toJSON :: GetRandomPassword -> Value

toEncoding :: GetRandomPassword -> Encoding

toJSONList :: [GetRandomPassword] -> Value

toEncodingList :: [GetRandomPassword] -> Encoding

NFData GetRandomPassword

Methods

rnf :: GetRandomPassword -> ()

AWSRequest GetRandomPassword

Associated Types

type Rs GetRandomPassword :: *

Methods

request :: GetRandomPassword -> Request GetRandomPassword

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetRandomPassword -> ClientResponse -> m (Response GetRandomPassword)

ToHeaders GetRandomPassword

Methods

toHeaders :: GetRandomPassword -> [Header]

ToPath GetRandomPassword

Methods

toPath :: GetRandomPassword -> ByteString

ToQuery GetRandomPassword

Methods

toQuery :: GetRandomPassword -> QueryString

type Rep GetRandomPassword

type Rep GetRandomPassword = D1 * (MetaData "GetRandomPassword" "Network.AWS.SecretsManager.GetRandomPassword" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "GetRandomPassword'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_grpIncludeSpace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_grpExcludeNumbers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_grpExcludeLowercase") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_grpExcludeCharacters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_grpExcludePunctuation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_grpRequireEachIncludedType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_grpExcludeUppercase") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_grpPasswordLength") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))))

type Rs GetRandomPassword

type Rs GetRandomPassword = GetRandomPasswordResponse

Request Lenses

grpIncludeSpace :: Lens' GetRandomPassword (Maybe Bool)

Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.

grpExcludeNumbers :: Lens' GetRandomPassword (Maybe Bool)

Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.

grpExcludeLowercase :: Lens' GetRandomPassword (Maybe Bool)

Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.

grpExcludeCharacters :: Lens' GetRandomPassword (Maybe Text)

A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.

grpExcludePunctuation :: Lens' GetRandomPassword (Maybe Bool)

Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

grpRequireEachIncludedType :: Lens' GetRandomPassword (Maybe Bool)

A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.

grpExcludeUppercase :: Lens' GetRandomPassword (Maybe Bool)

Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.

grpPasswordLength :: Lens' GetRandomPassword (Maybe Natural)

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

Destructuring the Response

getRandomPasswordResponse

Arguments

:: Int

grprsResponseStatus

-> GetRandomPasswordResponse

Creates a value of GetRandomPasswordResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• grprsRandomPassword - A string with the generated password.
• grprsResponseStatus - -- | The response status code.

data GetRandomPasswordResponse

See: getRandomPasswordResponse smart constructor.

Instances

Eq GetRandomPasswordResponse

Methods

(==) :: GetRandomPasswordResponse -> GetRandomPasswordResponse -> Bool

(/=) :: GetRandomPasswordResponse -> GetRandomPasswordResponse -> Bool

Data GetRandomPasswordResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetRandomPasswordResponse -> c GetRandomPasswordResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetRandomPasswordResponse

toConstr :: GetRandomPasswordResponse -> Constr

dataTypeOf :: GetRandomPasswordResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetRandomPasswordResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetRandomPasswordResponse)

gmapT :: (forall b. Data b => b -> b) -> GetRandomPasswordResponse -> GetRandomPasswordResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetRandomPasswordResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetRandomPasswordResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetRandomPasswordResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetRandomPasswordResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetRandomPasswordResponse -> m GetRandomPasswordResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRandomPasswordResponse -> m GetRandomPasswordResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRandomPasswordResponse -> m GetRandomPasswordResponse

Read GetRandomPasswordResponse

Methods

readsPrec :: Int -> ReadS GetRandomPasswordResponse

readList :: ReadS [GetRandomPasswordResponse]

readPrec :: ReadPrec GetRandomPasswordResponse

readListPrec :: ReadPrec [GetRandomPasswordResponse]

Show GetRandomPasswordResponse

Methods

showsPrec :: Int -> GetRandomPasswordResponse -> ShowS

show :: GetRandomPasswordResponse -> String

showList :: [GetRandomPasswordResponse] -> ShowS

Generic GetRandomPasswordResponse

Associated Types

type Rep GetRandomPasswordResponse :: * -> *

Methods

from :: GetRandomPasswordResponse -> Rep GetRandomPasswordResponse x

to :: Rep GetRandomPasswordResponse x -> GetRandomPasswordResponse

NFData GetRandomPasswordResponse

Methods

rnf :: GetRandomPasswordResponse -> ()

type Rep GetRandomPasswordResponse

type Rep GetRandomPasswordResponse = D1 * (MetaData "GetRandomPasswordResponse" "Network.AWS.SecretsManager.GetRandomPassword" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "GetRandomPasswordResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_grprsRandomPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_grprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

grprsRandomPassword :: Lens' GetRandomPasswordResponse (Maybe Text)

A string with the generated password.

grprsResponseStatus :: Lens' GetRandomPasswordResponse Int

• - | The response status code.