AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.UserAuthConfig

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class UserAuthConfig

The UserAuthConfig type exposes the following members

Constructors

NameDescription
Public Method UserAuthConfig()

Properties

NameTypeDescription
Public Property AuthScheme Amazon.RDS.AuthScheme

Gets and sets the property AuthScheme.

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

Public Property ClientPasswordAuthType Amazon.RDS.ClientPasswordAuthType

Gets and sets the property ClientPasswordAuthType.

The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:

  • RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD

  • RDS for SQL Server: SQL_SERVER_AUTHENTICATION

  • RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256

Public Property Description System.String

Gets and sets the property Description.

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

Public Property IAMAuth Amazon.RDS.IAMAuthMode

Gets and sets the property IAMAuth.

A value that indicates 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.

Public Property SecretArn System.String

Gets and sets the property 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.

Public Property UserName System.String

Gets and sets the property UserName.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5