Class: Aws::RDS::Types::UserAuthConfig

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::UserAuthConfig

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auth_scheme ⇒ String

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

• #client_password_auth_type ⇒ String

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

• #description ⇒ String

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

• #iam_auth ⇒ String

  A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.

• #user_name ⇒ String

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

Instance Attribute Details

#auth_scheme ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 28826

class UserAuthConfig < Struct.new(
  :description,
  :user_name,
  :auth_scheme,
  :secret_arn,
  :iam_auth,
  :client_password_auth_type)
  SENSITIVE = []
  include Aws::Structure
end

#client_password_auth_type ⇒ String

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`

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 28826

class UserAuthConfig < Struct.new(
  :description,
  :user_name,
  :auth_scheme,
  :secret_arn,
  :iam_auth,
  :client_password_auth_type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 28826

class UserAuthConfig < Struct.new(
  :description,
  :user_name,
  :auth_scheme,
  :secret_arn,
  :iam_auth,
  :client_password_auth_type)
  SENSITIVE = []
  include Aws::Structure
end

#iam_auth ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 28826

class UserAuthConfig < Struct.new(
  :description,
  :user_name,
  :auth_scheme,
  :secret_arn,
  :iam_auth,
  :client_password_auth_type)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 28826

class UserAuthConfig < Struct.new(
  :description,
  :user_name,
  :auth_scheme,
  :secret_arn,
  :iam_auth,
  :client_password_auth_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 28826

class UserAuthConfig < Struct.new(
  :description,
  :user_name,
  :auth_scheme,
  :secret_arn,
  :iam_auth,
  :client_password_auth_type)
  SENSITIVE = []
  include Aws::Structure
end