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

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

Overview

Note:

When making an API call, you may pass UserAuthConfig data as a hash:

{
  description: "String",
  user_name: "String",
  auth_scheme: "SECRETS", # accepts SECRETS
  secret_arn: "String",
  iam_auth: "DISABLED", # accepts DISABLED, REQUIRED
}

Specifies 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)


19981
19982
19983
19984
19985
19986
19987
19988
19989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19981

class UserAuthConfig < 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)


19981
19982
19983
19984
19985
19986
19987
19988
19989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19981

class UserAuthConfig < 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)


19981
19982
19983
19984
19985
19986
19987
19988
19989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19981

class UserAuthConfig < 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)


19981
19982
19983
19984
19985
19986
19987
19988
19989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19981

class UserAuthConfig < 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)


19981
19982
19983
19984
19985
19986
19987
19988
19989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19981

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