Class: Aws::RDS::Types::ModifyDBProxyRequest

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

Overview

Note:

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

{
  db_proxy_name: "String", # required
  new_db_proxy_name: "String",
  auth: [
    {
      description: "String",
      user_name: "String",
      auth_scheme: "SECRETS", # accepts SECRETS
      secret_arn: "String",
      iam_auth: "DISABLED", # accepts DISABLED, REQUIRED
    },
  ],
  require_tls: false,
  idle_client_timeout: 1,
  debug_logging: false,
  role_arn: "String",
  security_groups: ["String"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authArray<Types::UserAuthConfig>

The new authentication settings for the `DBProxy`.

Returns:


16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#db_proxy_nameString

The identifier for the `DBProxy` to modify.

Returns:

  • (String)

16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#debug_loggingBoolean

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

Returns:

  • (Boolean)

16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#idle_client_timeoutInteger

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

Returns:

  • (Integer)

16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#new_db_proxy_nameString

The new identifier for the `DBProxy`. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)

16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#require_tlsBoolean

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.

Returns:

  • (Boolean)

16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

Returns:

  • (String)

16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#security_groupsArray<String>

The new list of security groups for the `DBProxy`.

Returns:

  • (Array<String>)

16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
# File 'lib/aws-sdk-rds/types.rb', line 16510

class ModifyDBProxyRequest < Struct.new(
  :db_proxy_name,
  :new_db_proxy_name,
  :auth,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :role_arn,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end