/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace SecretsManager { namespace Model { /** */ class GetRandomPasswordRequest : public SecretsManagerRequest { public: AWS_SECRETSMANAGER_API GetRandomPasswordRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetRandomPassword"; } AWS_SECRETSMANAGER_API Aws::String SerializePayload() const override; AWS_SECRETSMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The length of the password. If you don't include this parameter, the default * length is 32 characters.

*/ inline long long GetPasswordLength() const{ return m_passwordLength; } /** *

The length of the password. If you don't include this parameter, the default * length is 32 characters.

*/ inline bool PasswordLengthHasBeenSet() const { return m_passwordLengthHasBeenSet; } /** *

The length of the password. If you don't include this parameter, the default * length is 32 characters.

*/ inline void SetPasswordLength(long long value) { m_passwordLengthHasBeenSet = true; m_passwordLength = value; } /** *

The length of the password. If you don't include this parameter, the default * length is 32 characters.

*/ inline GetRandomPasswordRequest& WithPasswordLength(long long value) { SetPasswordLength(value); return *this;} /** *

A string of the characters that you don't want in the password.

*/ inline const Aws::String& GetExcludeCharacters() const{ return m_excludeCharacters; } /** *

A string of the characters that you don't want in the password.

*/ inline bool ExcludeCharactersHasBeenSet() const { return m_excludeCharactersHasBeenSet; } /** *

A string of the characters that you don't want in the password.

*/ inline void SetExcludeCharacters(const Aws::String& value) { m_excludeCharactersHasBeenSet = true; m_excludeCharacters = value; } /** *

A string of the characters that you don't want in the password.

*/ inline void SetExcludeCharacters(Aws::String&& value) { m_excludeCharactersHasBeenSet = true; m_excludeCharacters = std::move(value); } /** *

A string of the characters that you don't want in the password.

*/ inline void SetExcludeCharacters(const char* value) { m_excludeCharactersHasBeenSet = true; m_excludeCharacters.assign(value); } /** *

A string of the characters that you don't want in the password.

*/ inline GetRandomPasswordRequest& WithExcludeCharacters(const Aws::String& value) { SetExcludeCharacters(value); return *this;} /** *

A string of the characters that you don't want in the password.

*/ inline GetRandomPasswordRequest& WithExcludeCharacters(Aws::String&& value) { SetExcludeCharacters(std::move(value)); return *this;} /** *

A string of the characters that you don't want in the password.

*/ inline GetRandomPasswordRequest& WithExcludeCharacters(const char* value) { SetExcludeCharacters(value); return *this;} /** *

Specifies whether to exclude numbers from the password. If you don't include * this switch, the password can contain numbers.

*/ inline bool GetExcludeNumbers() const{ return m_excludeNumbers; } /** *

Specifies whether to exclude numbers from the password. If you don't include * this switch, the password can contain numbers.

*/ inline bool ExcludeNumbersHasBeenSet() const { return m_excludeNumbersHasBeenSet; } /** *

Specifies whether to exclude numbers from the password. If you don't include * this switch, the password can contain numbers.

*/ inline void SetExcludeNumbers(bool value) { m_excludeNumbersHasBeenSet = true; m_excludeNumbers = value; } /** *

Specifies whether to exclude numbers from the password. If you don't include * this switch, the password can contain numbers.

*/ inline GetRandomPasswordRequest& WithExcludeNumbers(bool value) { SetExcludeNumbers(value); return *this;} /** *

Specifies whether to exclude the following punctuation characters from the * password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ * ` { | } ~. If you don't include this switch, the password can contain * punctuation.

*/ inline bool GetExcludePunctuation() const{ return m_excludePunctuation; } /** *

Specifies whether to exclude the following punctuation characters from the * password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ * ` { | } ~. If you don't include this switch, the password can contain * punctuation.

*/ inline bool ExcludePunctuationHasBeenSet() const { return m_excludePunctuationHasBeenSet; } /** *

Specifies whether to exclude the following punctuation characters from the * password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ * ` { | } ~. If you don't include this switch, the password can contain * punctuation.

*/ inline void SetExcludePunctuation(bool value) { m_excludePunctuationHasBeenSet = true; m_excludePunctuation = value; } /** *

Specifies whether to exclude the following punctuation characters from the * password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ * ` { | } ~. If you don't include this switch, the password can contain * punctuation.

*/ inline GetRandomPasswordRequest& WithExcludePunctuation(bool value) { SetExcludePunctuation(value); return *this;} /** *

Specifies whether to exclude uppercase letters from the password. If you * don't include this switch, the password can contain uppercase letters.

*/ inline bool GetExcludeUppercase() const{ return m_excludeUppercase; } /** *

Specifies whether to exclude uppercase letters from the password. If you * don't include this switch, the password can contain uppercase letters.

*/ inline bool ExcludeUppercaseHasBeenSet() const { return m_excludeUppercaseHasBeenSet; } /** *

Specifies whether to exclude uppercase letters from the password. If you * don't include this switch, the password can contain uppercase letters.

*/ inline void SetExcludeUppercase(bool value) { m_excludeUppercaseHasBeenSet = true; m_excludeUppercase = value; } /** *

Specifies whether to exclude uppercase letters from the password. If you * don't include this switch, the password can contain uppercase letters.

*/ inline GetRandomPasswordRequest& WithExcludeUppercase(bool value) { SetExcludeUppercase(value); return *this;} /** *

Specifies whether to exclude lowercase letters from the password. If you * don't include this switch, the password can contain lowercase letters.

*/ inline bool GetExcludeLowercase() const{ return m_excludeLowercase; } /** *

Specifies whether to exclude lowercase letters from the password. If you * don't include this switch, the password can contain lowercase letters.

*/ inline bool ExcludeLowercaseHasBeenSet() const { return m_excludeLowercaseHasBeenSet; } /** *

Specifies whether to exclude lowercase letters from the password. If you * don't include this switch, the password can contain lowercase letters.

*/ inline void SetExcludeLowercase(bool value) { m_excludeLowercaseHasBeenSet = true; m_excludeLowercase = value; } /** *

Specifies whether to exclude lowercase letters from the password. If you * don't include this switch, the password can contain lowercase letters.

*/ inline GetRandomPasswordRequest& WithExcludeLowercase(bool value) { SetExcludeLowercase(value); return *this;} /** *

Specifies whether to include the space character. If you include this switch, * the password can contain space characters.

*/ inline bool GetIncludeSpace() const{ return m_includeSpace; } /** *

Specifies whether to include the space character. If you include this switch, * the password can contain space characters.

*/ inline bool IncludeSpaceHasBeenSet() const { return m_includeSpaceHasBeenSet; } /** *

Specifies whether to include the space character. If you include this switch, * the password can contain space characters.

*/ inline void SetIncludeSpace(bool value) { m_includeSpaceHasBeenSet = true; m_includeSpace = value; } /** *

Specifies whether to include the space character. If you include this switch, * the password can contain space characters.

*/ inline GetRandomPasswordRequest& WithIncludeSpace(bool value) { SetIncludeSpace(value); return *this;} /** *

Specifies whether to include at least one upper and lowercase letter, one * number, and one punctuation. If you don't include this switch, the password * contains at least one of every character type.

*/ inline bool GetRequireEachIncludedType() const{ return m_requireEachIncludedType; } /** *

Specifies whether to include at least one upper and lowercase letter, one * number, and one punctuation. If you don't include this switch, the password * contains at least one of every character type.

*/ inline bool RequireEachIncludedTypeHasBeenSet() const { return m_requireEachIncludedTypeHasBeenSet; } /** *

Specifies whether to include at least one upper and lowercase letter, one * number, and one punctuation. If you don't include this switch, the password * contains at least one of every character type.

*/ inline void SetRequireEachIncludedType(bool value) { m_requireEachIncludedTypeHasBeenSet = true; m_requireEachIncludedType = value; } /** *

Specifies whether to include at least one upper and lowercase letter, one * number, and one punctuation. If you don't include this switch, the password * contains at least one of every character type.

*/ inline GetRandomPasswordRequest& WithRequireEachIncludedType(bool value) { SetRequireEachIncludedType(value); return *this;} private: long long m_passwordLength; bool m_passwordLengthHasBeenSet = false; Aws::String m_excludeCharacters; bool m_excludeCharactersHasBeenSet = false; bool m_excludeNumbers; bool m_excludeNumbersHasBeenSet = false; bool m_excludePunctuation; bool m_excludePunctuationHasBeenSet = false; bool m_excludeUppercase; bool m_excludeUppercaseHasBeenSet = false; bool m_excludeLowercase; bool m_excludeLowercaseHasBeenSet = false; bool m_includeSpace; bool m_includeSpaceHasBeenSet = false; bool m_requireEachIncludedType; bool m_requireEachIncludedTypeHasBeenSet = false; }; } // namespace Model } // namespace SecretsManager } // namespace Aws