AWS SDK for C++  1.9.153
AWS SDK for C++
Public Member Functions | List of all members
Aws::SecretsManager::Model::GetRandomPasswordRequest Class Reference

#include <GetRandomPasswordRequest.h>

+ Inheritance diagram for Aws::SecretsManager::Model::GetRandomPasswordRequest:

Public Member Functions

 GetRandomPasswordRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
long long GetPasswordLength () const
 
bool PasswordLengthHasBeenSet () const
 
void SetPasswordLength (long long value)
 
GetRandomPasswordRequestWithPasswordLength (long long value)
 
const Aws::StringGetExcludeCharacters () const
 
bool ExcludeCharactersHasBeenSet () const
 
void SetExcludeCharacters (const Aws::String &value)
 
void SetExcludeCharacters (Aws::String &&value)
 
void SetExcludeCharacters (const char *value)
 
GetRandomPasswordRequestWithExcludeCharacters (const Aws::String &value)
 
GetRandomPasswordRequestWithExcludeCharacters (Aws::String &&value)
 
GetRandomPasswordRequestWithExcludeCharacters (const char *value)
 
bool GetExcludeNumbers () const
 
bool ExcludeNumbersHasBeenSet () const
 
void SetExcludeNumbers (bool value)
 
GetRandomPasswordRequestWithExcludeNumbers (bool value)
 
bool GetExcludePunctuation () const
 
bool ExcludePunctuationHasBeenSet () const
 
void SetExcludePunctuation (bool value)
 
GetRandomPasswordRequestWithExcludePunctuation (bool value)
 
bool GetExcludeUppercase () const
 
bool ExcludeUppercaseHasBeenSet () const
 
void SetExcludeUppercase (bool value)
 
GetRandomPasswordRequestWithExcludeUppercase (bool value)
 
bool GetExcludeLowercase () const
 
bool ExcludeLowercaseHasBeenSet () const
 
void SetExcludeLowercase (bool value)
 
GetRandomPasswordRequestWithExcludeLowercase (bool value)
 
bool GetIncludeSpace () const
 
bool IncludeSpaceHasBeenSet () const
 
void SetIncludeSpace (bool value)
 
GetRandomPasswordRequestWithIncludeSpace (bool value)
 
bool GetRequireEachIncludedType () const
 
bool RequireEachIncludedTypeHasBeenSet () const
 
void SetRequireEachIncludedType (bool value)
 
GetRandomPasswordRequestWithRequireEachIncludedType (bool value)
 
- Public Member Functions inherited from Aws::SecretsManager::SecretsManagerRequest
virtual ~SecretsManagerRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file GetRandomPasswordRequest.h.

Constructor & Destructor Documentation

◆ GetRandomPasswordRequest()

Aws::SecretsManager::Model::GetRandomPasswordRequest::GetRandomPasswordRequest ( )

Member Function Documentation

◆ ExcludeCharactersHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::ExcludeCharactersHasBeenSet ( ) const
inline

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.

Definition at line 74 of file GetRandomPasswordRequest.h.

◆ ExcludeLowercaseHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::ExcludeLowercaseHasBeenSet ( ) const
inline

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.

Definition at line 230 of file GetRandomPasswordRequest.h.

◆ ExcludeNumbersHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::ExcludeNumbersHasBeenSet ( ) const
inline

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.

Definition at line 129 of file GetRandomPasswordRequest.h.

◆ ExcludePunctuationHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::ExcludePunctuationHasBeenSet ( ) const
inline

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.

The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

Definition at line 164 of file GetRandomPasswordRequest.h.

◆ ExcludeUppercaseHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::ExcludeUppercaseHasBeenSet ( ) const
inline

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.

Definition at line 201 of file GetRandomPasswordRequest.h.

◆ GetExcludeCharacters()

const Aws::String& Aws::SecretsManager::Model::GetRandomPasswordRequest::GetExcludeCharacters ( ) const
inline

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.

Definition at line 67 of file GetRandomPasswordRequest.h.

◆ GetExcludeLowercase()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::GetExcludeLowercase ( ) const
inline

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.

Definition at line 223 of file GetRandomPasswordRequest.h.

◆ GetExcludeNumbers()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::GetExcludeNumbers ( ) const
inline

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.

Definition at line 123 of file GetRandomPasswordRequest.h.

◆ GetExcludePunctuation()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::GetExcludePunctuation ( ) const
inline

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.

The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

Definition at line 153 of file GetRandomPasswordRequest.h.

◆ GetExcludeUppercase()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::GetExcludeUppercase ( ) const
inline

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.

Definition at line 194 of file GetRandomPasswordRequest.h.

◆ GetIncludeSpace()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::GetIncludeSpace ( ) const
inline

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.

Definition at line 252 of file GetRandomPasswordRequest.h.

◆ GetPasswordLength()

long long Aws::SecretsManager::Model::GetRandomPasswordRequest::GetPasswordLength ( ) const
inline

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

Definition at line 41 of file GetRandomPasswordRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SecretsManager::Model::GetRandomPasswordRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRequireEachIncludedType()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::GetRequireEachIncludedType ( ) const
inline

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.

Definition at line 282 of file GetRandomPasswordRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SecretsManager::Model::GetRandomPasswordRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetRandomPasswordRequest.h.

◆ IncludeSpaceHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::IncludeSpaceHasBeenSet ( ) const
inline

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.

Definition at line 259 of file GetRandomPasswordRequest.h.

◆ PasswordLengthHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::PasswordLengthHasBeenSet ( ) const
inline

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

Definition at line 47 of file GetRandomPasswordRequest.h.

◆ RequireEachIncludedTypeHasBeenSet()

bool Aws::SecretsManager::Model::GetRandomPasswordRequest::RequireEachIncludedTypeHasBeenSet ( ) const
inline

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.

Definition at line 290 of file GetRandomPasswordRequest.h.

◆ SerializePayload()

Aws::String Aws::SecretsManager::Model::GetRandomPasswordRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExcludeCharacters() [1/3]

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetExcludeCharacters ( Aws::String &&  value)
inline

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.

Definition at line 88 of file GetRandomPasswordRequest.h.

◆ SetExcludeCharacters() [2/3]

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetExcludeCharacters ( const Aws::String value)
inline

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.

Definition at line 81 of file GetRandomPasswordRequest.h.

◆ SetExcludeCharacters() [3/3]

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetExcludeCharacters ( const char *  value)
inline

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.

Definition at line 95 of file GetRandomPasswordRequest.h.

◆ SetExcludeLowercase()

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetExcludeLowercase ( bool  value)
inline

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.

Definition at line 237 of file GetRandomPasswordRequest.h.

◆ SetExcludeNumbers()

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetExcludeNumbers ( bool  value)
inline

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.

Definition at line 135 of file GetRandomPasswordRequest.h.

◆ SetExcludePunctuation()

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetExcludePunctuation ( bool  value)
inline

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.

The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

Definition at line 175 of file GetRandomPasswordRequest.h.

◆ SetExcludeUppercase()

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetExcludeUppercase ( bool  value)
inline

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.

Definition at line 208 of file GetRandomPasswordRequest.h.

◆ SetIncludeSpace()

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetIncludeSpace ( bool  value)
inline

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.

Definition at line 266 of file GetRandomPasswordRequest.h.

◆ SetPasswordLength()

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetPasswordLength ( long long  value)
inline

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

Definition at line 53 of file GetRandomPasswordRequest.h.

◆ SetRequireEachIncludedType()

void Aws::SecretsManager::Model::GetRandomPasswordRequest::SetRequireEachIncludedType ( bool  value)
inline

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.

Definition at line 298 of file GetRandomPasswordRequest.h.

◆ WithExcludeCharacters() [1/3]

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithExcludeCharacters ( Aws::String &&  value)
inline

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.

Definition at line 109 of file GetRandomPasswordRequest.h.

◆ WithExcludeCharacters() [2/3]

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithExcludeCharacters ( const Aws::String value)
inline

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.

Definition at line 102 of file GetRandomPasswordRequest.h.

◆ WithExcludeCharacters() [3/3]

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithExcludeCharacters ( const char *  value)
inline

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.

Definition at line 116 of file GetRandomPasswordRequest.h.

◆ WithExcludeLowercase()

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithExcludeLowercase ( bool  value)
inline

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.

Definition at line 244 of file GetRandomPasswordRequest.h.

◆ WithExcludeNumbers()

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithExcludeNumbers ( bool  value)
inline

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.

Definition at line 141 of file GetRandomPasswordRequest.h.

◆ WithExcludePunctuation()

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithExcludePunctuation ( bool  value)
inline

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.

The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

Definition at line 186 of file GetRandomPasswordRequest.h.

◆ WithExcludeUppercase()

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithExcludeUppercase ( bool  value)
inline

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.

Definition at line 215 of file GetRandomPasswordRequest.h.

◆ WithIncludeSpace()

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithIncludeSpace ( bool  value)
inline

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.

Definition at line 273 of file GetRandomPasswordRequest.h.

◆ WithPasswordLength()

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithPasswordLength ( long long  value)
inline

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

Definition at line 59 of file GetRandomPasswordRequest.h.

◆ WithRequireEachIncludedType()

GetRandomPasswordRequest& Aws::SecretsManager::Model::GetRandomPasswordRequest::WithRequireEachIncludedType ( bool  value)
inline

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.

Definition at line 306 of file GetRandomPasswordRequest.h.


The documentation for this class was generated from the following file: