/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace RDS { namespace Model { /** *

Specifies the details of authentication used by a proxy to log in as a * specific database user.

See Also:

AWS * API Reference

*/ class UserAuthConfig { public: AWS_RDS_API UserAuthConfig(); AWS_RDS_API UserAuthConfig(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_RDS_API UserAuthConfig& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_RDS_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_RDS_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline UserAuthConfig& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline UserAuthConfig& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A user-specified description about the authentication used by a proxy to log * in as a specific database user.

*/ inline UserAuthConfig& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The name of the database user to which the proxy connects.

*/ inline const Aws::String& GetUserName() const{ return m_userName; } /** *

The name of the database user to which the proxy connects.

*/ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** *

The name of the database user to which the proxy connects.

*/ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** *

The name of the database user to which the proxy connects.

*/ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** *

The name of the database user to which the proxy connects.

*/ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** *

The name of the database user to which the proxy connects.

*/ inline UserAuthConfig& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** *

The name of the database user to which the proxy connects.

*/ inline UserAuthConfig& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** *

The name of the database user to which the proxy connects.

*/ inline UserAuthConfig& WithUserName(const char* value) { SetUserName(value); return *this;} /** *

The type of authentication that the proxy uses for connections from the proxy * to the underlying database.

*/ inline const AuthScheme& GetAuthScheme() const{ return m_authScheme; } /** *

The type of authentication that the proxy uses for connections from the proxy * to the underlying database.

*/ inline bool AuthSchemeHasBeenSet() const { return m_authSchemeHasBeenSet; } /** *

The type of authentication that the proxy uses for connections from the proxy * to the underlying database.

*/ inline void SetAuthScheme(const AuthScheme& value) { m_authSchemeHasBeenSet = true; m_authScheme = value; } /** *

The type of authentication that the proxy uses for connections from the proxy * to the underlying database.

*/ inline void SetAuthScheme(AuthScheme&& value) { m_authSchemeHasBeenSet = true; m_authScheme = std::move(value); } /** *

The type of authentication that the proxy uses for connections from the proxy * to the underlying database.

*/ inline UserAuthConfig& WithAuthScheme(const AuthScheme& value) { SetAuthScheme(value); return *this;} /** *

The type of authentication that the proxy uses for connections from the proxy * to the underlying database.

*/ inline UserAuthConfig& WithAuthScheme(AuthScheme&& value) { SetAuthScheme(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline const Aws::String& GetSecretArn() const{ return m_secretArn; } /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline bool SecretArnHasBeenSet() const { return m_secretArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline void SetSecretArn(const Aws::String& value) { m_secretArnHasBeenSet = true; m_secretArn = value; } /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline void SetSecretArn(Aws::String&& value) { m_secretArnHasBeenSet = true; m_secretArn = std::move(value); } /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline void SetSecretArn(const char* value) { m_secretArnHasBeenSet = true; m_secretArn.assign(value); } /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline UserAuthConfig& WithSecretArn(const Aws::String& value) { SetSecretArn(value); return *this;} /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline UserAuthConfig& WithSecretArn(Aws::String&& value) { SetSecretArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) representing the secret that the proxy uses to * authenticate to the RDS DB instance or Aurora DB cluster. These secrets are * stored within Amazon Secrets Manager.

*/ inline UserAuthConfig& WithSecretArn(const char* value) { SetSecretArn(value); return *this;} /** *

Whether to require or disallow Amazon Web Services Identity and Access * Management (IAM) authentication for connections to the proxy. The * ENABLED value is valid only for proxies with RDS for Microsoft SQL * Server.

*/ inline const IAMAuthMode& GetIAMAuth() const{ return m_iAMAuth; } /** *

Whether to require or disallow Amazon Web Services Identity and Access * Management (IAM) authentication for connections to the proxy. The * ENABLED value is valid only for proxies with RDS for Microsoft SQL * Server.

*/ inline bool IAMAuthHasBeenSet() const { return m_iAMAuthHasBeenSet; } /** *

Whether to require or disallow Amazon Web Services Identity and Access * Management (IAM) authentication for connections to the proxy. The * ENABLED value is valid only for proxies with RDS for Microsoft SQL * Server.

*/ inline void SetIAMAuth(const IAMAuthMode& value) { m_iAMAuthHasBeenSet = true; m_iAMAuth = value; } /** *

Whether to require or disallow Amazon Web Services Identity and Access * Management (IAM) authentication for connections to the proxy. The * ENABLED value is valid only for proxies with RDS for Microsoft SQL * Server.

*/ inline void SetIAMAuth(IAMAuthMode&& value) { m_iAMAuthHasBeenSet = true; m_iAMAuth = std::move(value); } /** *

Whether to require or disallow Amazon Web Services Identity and Access * Management (IAM) authentication for connections to the proxy. The * ENABLED value is valid only for proxies with RDS for Microsoft SQL * Server.

*/ inline UserAuthConfig& WithIAMAuth(const IAMAuthMode& value) { SetIAMAuth(value); return *this;} /** *

Whether to require or disallow Amazon Web Services Identity and Access * Management (IAM) authentication for connections to the proxy. The * ENABLED value is valid only for proxies with RDS for Microsoft SQL * Server.

*/ inline UserAuthConfig& WithIAMAuth(IAMAuthMode&& value) { SetIAMAuth(std::move(value)); return *this;} /** *

The type of authentication the proxy uses for connections from clients.

*/ inline const ClientPasswordAuthType& GetClientPasswordAuthType() const{ return m_clientPasswordAuthType; } /** *

The type of authentication the proxy uses for connections from clients.

*/ inline bool ClientPasswordAuthTypeHasBeenSet() const { return m_clientPasswordAuthTypeHasBeenSet; } /** *

The type of authentication the proxy uses for connections from clients.

*/ inline void SetClientPasswordAuthType(const ClientPasswordAuthType& value) { m_clientPasswordAuthTypeHasBeenSet = true; m_clientPasswordAuthType = value; } /** *

The type of authentication the proxy uses for connections from clients.

*/ inline void SetClientPasswordAuthType(ClientPasswordAuthType&& value) { m_clientPasswordAuthTypeHasBeenSet = true; m_clientPasswordAuthType = std::move(value); } /** *

The type of authentication the proxy uses for connections from clients.

*/ inline UserAuthConfig& WithClientPasswordAuthType(const ClientPasswordAuthType& value) { SetClientPasswordAuthType(value); return *this;} /** *

The type of authentication the proxy uses for connections from clients.

*/ inline UserAuthConfig& WithClientPasswordAuthType(ClientPasswordAuthType&& value) { SetClientPasswordAuthType(std::move(value)); return *this;} private: Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_userName; bool m_userNameHasBeenSet = false; AuthScheme m_authScheme; bool m_authSchemeHasBeenSet = false; Aws::String m_secretArn; bool m_secretArnHasBeenSet = false; IAMAuthMode m_iAMAuth; bool m_iAMAuthHasBeenSet = false; ClientPasswordAuthType m_clientPasswordAuthType; bool m_clientPasswordAuthTypeHasBeenSet = false; }; } // namespace Model } // namespace RDS } // namespace Aws