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)


20021
20022
20023
20024
20025
20026
20027
20028
20029
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20021

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)


20021
20022
20023
20024
20025
20026
20027
20028
20029
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20021

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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Returns:

  • (String)


20021
20022
20023
20024
20025
20026
20027
20028
20029
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20021

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)


20021
20022
20023
20024
20025
20026
20027
20028
20029
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20021

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)


20021
20022
20023
20024
20025
20026
20027
20028
20029
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20021

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