Class: Aws::RDS::Types::UserAuthConfigInfo

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_schemeString

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

Returns:

  • (String)


25095
25096
25097
25098
25099
25100
25101
25102
25103
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 25095

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

#descriptionString

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

Returns:

  • (String)


25095
25096
25097
25098
25099
25100
25101
25102
25103
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 25095

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

#iam_authString

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)


25095
25096
25097
25098
25099
25100
25101
25102
25103
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 25095

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

#secret_arnString

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)


25095
25096
25097
25098
25099
25100
25101
25102
25103
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 25095

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

#user_nameString

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

Returns:

  • (String)


25095
25096
25097
25098
25099
25100
25101
25102
25103
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 25095

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