AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::Model::UserAuthConfig Class Reference

#include <UserAuthConfig.h>

Public Member Functions

 UserAuthConfig ()
 
 UserAuthConfig (const Aws::Utils::Xml::XmlNode &xmlNode)
 
UserAuthConfigoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UserAuthConfigWithDescription (const Aws::String &value)
 
UserAuthConfigWithDescription (Aws::String &&value)
 
UserAuthConfigWithDescription (const char *value)
 
const Aws::StringGetUserName () const
 
bool UserNameHasBeenSet () const
 
void SetUserName (const Aws::String &value)
 
void SetUserName (Aws::String &&value)
 
void SetUserName (const char *value)
 
UserAuthConfigWithUserName (const Aws::String &value)
 
UserAuthConfigWithUserName (Aws::String &&value)
 
UserAuthConfigWithUserName (const char *value)
 
const AuthSchemeGetAuthScheme () const
 
bool AuthSchemeHasBeenSet () const
 
void SetAuthScheme (const AuthScheme &value)
 
void SetAuthScheme (AuthScheme &&value)
 
UserAuthConfigWithAuthScheme (const AuthScheme &value)
 
UserAuthConfigWithAuthScheme (AuthScheme &&value)
 
const Aws::StringGetSecretArn () const
 
bool SecretArnHasBeenSet () const
 
void SetSecretArn (const Aws::String &value)
 
void SetSecretArn (Aws::String &&value)
 
void SetSecretArn (const char *value)
 
UserAuthConfigWithSecretArn (const Aws::String &value)
 
UserAuthConfigWithSecretArn (Aws::String &&value)
 
UserAuthConfigWithSecretArn (const char *value)
 
const IAMAuthModeGetIAMAuth () const
 
bool IAMAuthHasBeenSet () const
 
void SetIAMAuth (const IAMAuthMode &value)
 
void SetIAMAuth (IAMAuthMode &&value)
 
UserAuthConfigWithIAMAuth (const IAMAuthMode &value)
 
UserAuthConfigWithIAMAuth (IAMAuthMode &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file UserAuthConfig.h.

Constructor & Destructor Documentation

◆ UserAuthConfig() [1/2]

Aws::RDS::Model::UserAuthConfig::UserAuthConfig ( )

◆ UserAuthConfig() [2/2]

Aws::RDS::Model::UserAuthConfig::UserAuthConfig ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AuthSchemeHasBeenSet()

bool Aws::RDS::Model::UserAuthConfig::AuthSchemeHasBeenSet ( ) const
inline

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

Definition at line 145 of file UserAuthConfig.h.

◆ DescriptionHasBeenSet()

bool Aws::RDS::Model::UserAuthConfig::DescriptionHasBeenSet ( ) const
inline

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

Definition at line 55 of file UserAuthConfig.h.

◆ GetAuthScheme()

const AuthScheme& Aws::RDS::Model::UserAuthConfig::GetAuthScheme ( ) const
inline

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

Definition at line 139 of file UserAuthConfig.h.

◆ GetDescription()

const Aws::String& Aws::RDS::Model::UserAuthConfig::GetDescription ( ) const
inline

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

Definition at line 49 of file UserAuthConfig.h.

◆ GetIAMAuth()

const IAMAuthMode& Aws::RDS::Model::UserAuthConfig::GetIAMAuth ( ) const
inline

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Definition at line 233 of file UserAuthConfig.h.

◆ GetSecretArn()

const Aws::String& Aws::RDS::Model::UserAuthConfig::GetSecretArn ( ) const
inline

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.

Definition at line 177 of file UserAuthConfig.h.

◆ GetUserName()

const Aws::String& Aws::RDS::Model::UserAuthConfig::GetUserName ( ) const
inline

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

Definition at line 97 of file UserAuthConfig.h.

◆ IAMAuthHasBeenSet()

bool Aws::RDS::Model::UserAuthConfig::IAMAuthHasBeenSet ( ) const
inline

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Definition at line 239 of file UserAuthConfig.h.

◆ operator=()

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::RDS::Model::UserAuthConfig::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::RDS::Model::UserAuthConfig::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SecretArnHasBeenSet()

bool Aws::RDS::Model::UserAuthConfig::SecretArnHasBeenSet ( ) const
inline

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.

Definition at line 184 of file UserAuthConfig.h.

◆ SetAuthScheme() [1/2]

void Aws::RDS::Model::UserAuthConfig::SetAuthScheme ( const AuthScheme value)
inline

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

Definition at line 151 of file UserAuthConfig.h.

◆ SetAuthScheme() [2/2]

void Aws::RDS::Model::UserAuthConfig::SetAuthScheme ( AuthScheme &&  value)
inline

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

Definition at line 157 of file UserAuthConfig.h.

◆ SetDescription() [1/3]

void Aws::RDS::Model::UserAuthConfig::SetDescription ( const Aws::String value)
inline

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

Definition at line 61 of file UserAuthConfig.h.

◆ SetDescription() [2/3]

void Aws::RDS::Model::UserAuthConfig::SetDescription ( Aws::String &&  value)
inline

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

Definition at line 67 of file UserAuthConfig.h.

◆ SetDescription() [3/3]

void Aws::RDS::Model::UserAuthConfig::SetDescription ( const char *  value)
inline

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

Definition at line 73 of file UserAuthConfig.h.

◆ SetIAMAuth() [1/2]

void Aws::RDS::Model::UserAuthConfig::SetIAMAuth ( const IAMAuthMode value)
inline

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Definition at line 245 of file UserAuthConfig.h.

◆ SetIAMAuth() [2/2]

void Aws::RDS::Model::UserAuthConfig::SetIAMAuth ( IAMAuthMode &&  value)
inline

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Definition at line 251 of file UserAuthConfig.h.

◆ SetSecretArn() [1/3]

void Aws::RDS::Model::UserAuthConfig::SetSecretArn ( const Aws::String value)
inline

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.

Definition at line 191 of file UserAuthConfig.h.

◆ SetSecretArn() [2/3]

void Aws::RDS::Model::UserAuthConfig::SetSecretArn ( Aws::String &&  value)
inline

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.

Definition at line 198 of file UserAuthConfig.h.

◆ SetSecretArn() [3/3]

void Aws::RDS::Model::UserAuthConfig::SetSecretArn ( const char *  value)
inline

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.

Definition at line 205 of file UserAuthConfig.h.

◆ SetUserName() [1/3]

void Aws::RDS::Model::UserAuthConfig::SetUserName ( const Aws::String value)
inline

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

Definition at line 107 of file UserAuthConfig.h.

◆ SetUserName() [2/3]

void Aws::RDS::Model::UserAuthConfig::SetUserName ( Aws::String &&  value)
inline

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

Definition at line 112 of file UserAuthConfig.h.

◆ SetUserName() [3/3]

void Aws::RDS::Model::UserAuthConfig::SetUserName ( const char *  value)
inline

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

Definition at line 117 of file UserAuthConfig.h.

◆ UserNameHasBeenSet()

bool Aws::RDS::Model::UserAuthConfig::UserNameHasBeenSet ( ) const
inline

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

Definition at line 102 of file UserAuthConfig.h.

◆ WithAuthScheme() [1/2]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithAuthScheme ( const AuthScheme value)
inline

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

Definition at line 163 of file UserAuthConfig.h.

◆ WithAuthScheme() [2/2]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithAuthScheme ( AuthScheme &&  value)
inline

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

Definition at line 169 of file UserAuthConfig.h.

◆ WithDescription() [1/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithDescription ( const Aws::String value)
inline

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

Definition at line 79 of file UserAuthConfig.h.

◆ WithDescription() [2/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithDescription ( Aws::String &&  value)
inline

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

Definition at line 85 of file UserAuthConfig.h.

◆ WithDescription() [3/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithDescription ( const char *  value)
inline

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

Definition at line 91 of file UserAuthConfig.h.

◆ WithIAMAuth() [1/2]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithIAMAuth ( const IAMAuthMode value)
inline

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Definition at line 257 of file UserAuthConfig.h.

◆ WithIAMAuth() [2/2]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithIAMAuth ( IAMAuthMode &&  value)
inline

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Definition at line 263 of file UserAuthConfig.h.

◆ WithSecretArn() [1/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithSecretArn ( const Aws::String value)
inline

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.

Definition at line 212 of file UserAuthConfig.h.

◆ WithSecretArn() [2/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithSecretArn ( Aws::String &&  value)
inline

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.

Definition at line 219 of file UserAuthConfig.h.

◆ WithSecretArn() [3/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithSecretArn ( const char *  value)
inline

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.

Definition at line 226 of file UserAuthConfig.h.

◆ WithUserName() [1/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithUserName ( const Aws::String value)
inline

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

Definition at line 122 of file UserAuthConfig.h.

◆ WithUserName() [2/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithUserName ( Aws::String &&  value)
inline

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

Definition at line 127 of file UserAuthConfig.h.

◆ WithUserName() [3/3]

UserAuthConfig& Aws::RDS::Model::UserAuthConfig::WithUserName ( const char *  value)
inline

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

Definition at line 132 of file UserAuthConfig.h.


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