#include <UserAuthConfigInfo.h>
Returns 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 UserAuthConfigInfo.h.
◆ UserAuthConfigInfo() [1/2]
Aws::RDS::Model::UserAuthConfigInfo::UserAuthConfigInfo |
( |
| ) |
|
◆ UserAuthConfigInfo() [2/2]
◆ AuthSchemeHasBeenSet()
bool Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ DescriptionHasBeenSet()
bool Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ GetAuthScheme()
const AuthScheme& Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ GetDescription()
const Aws::String& Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ GetIAMAuth()
const IAMAuthMode& Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ GetSecretArn()
const Aws::String& Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ GetUserName()
const Aws::String& Aws::RDS::Model::UserAuthConfigInfo::GetUserName |
( |
| ) |
const |
|
inline |
The name of the database user to which the proxy connects.
Definition at line 97 of file UserAuthConfigInfo.h.
◆ IAMAuthHasBeenSet()
bool Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ operator=()
◆ OutputToStream() [1/2]
void Aws::RDS::Model::UserAuthConfigInfo::OutputToStream |
( |
Aws::OStream & |
oStream, |
|
|
const char * |
location |
|
) |
| const |
◆ OutputToStream() [2/2]
void Aws::RDS::Model::UserAuthConfigInfo::OutputToStream |
( |
Aws::OStream & |
ostream, |
|
|
const char * |
location, |
|
|
unsigned |
index, |
|
|
const char * |
locationValue |
|
) |
| const |
◆ SecretArnHasBeenSet()
bool Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetAuthScheme() [1/2]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetAuthScheme() [2/2]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetDescription() [1/3]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetDescription() [2/3]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetDescription() [3/3]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetIAMAuth() [1/2]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetIAMAuth() [2/2]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetSecretArn() [1/3]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetSecretArn() [2/3]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetSecretArn() [3/3]
void Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ SetUserName() [1/3]
void Aws::RDS::Model::UserAuthConfigInfo::SetUserName |
( |
Aws::String && |
value | ) |
|
|
inline |
◆ SetUserName() [2/3]
void Aws::RDS::Model::UserAuthConfigInfo::SetUserName |
( |
const Aws::String & |
value | ) |
|
|
inline |
◆ SetUserName() [3/3]
void Aws::RDS::Model::UserAuthConfigInfo::SetUserName |
( |
const char * |
value | ) |
|
|
inline |
◆ UserNameHasBeenSet()
bool Aws::RDS::Model::UserAuthConfigInfo::UserNameHasBeenSet |
( |
| ) |
const |
|
inline |
◆ WithAuthScheme() [1/2]
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
Definition at line 169 of file UserAuthConfigInfo.h.
◆ WithAuthScheme() [2/2]
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
Definition at line 163 of file UserAuthConfigInfo.h.
◆ WithDescription() [1/3]
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 UserAuthConfigInfo.h.
◆ WithDescription() [2/3]
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 UserAuthConfigInfo.h.
◆ WithDescription() [3/3]
UserAuthConfigInfo& Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ WithIAMAuth() [1/2]
Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
Definition at line 257 of file UserAuthConfigInfo.h.
◆ WithIAMAuth() [2/2]
Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
Definition at line 263 of file UserAuthConfigInfo.h.
◆ WithSecretArn() [1/3]
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 UserAuthConfigInfo.h.
◆ WithSecretArn() [2/3]
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 UserAuthConfigInfo.h.
◆ WithSecretArn() [3/3]
UserAuthConfigInfo& Aws::RDS::Model::UserAuthConfigInfo::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 UserAuthConfigInfo.h.
◆ WithUserName() [1/3]
◆ WithUserName() [2/3]
◆ WithUserName() [3/3]
UserAuthConfigInfo& Aws::RDS::Model::UserAuthConfigInfo::WithUserName |
( |
const char * |
value | ) |
|
|
inline |
The documentation for this class was generated from the following file: