You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ModifyDBProxyRequest as input to an Aws::Client method, you can use a vanilla 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"],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auth ⇒ Array<Types::UserAuthConfig>

The new authentication settings for the DBProxy.

Returns:

#db_proxy_name ⇒ String

The identifier for the DBProxy to modify.

Returns:

  • (String) —

    The identifier for the DBProxy to modify.

#debug_logging ⇒ Boolean

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

    Whether the proxy includes detailed information about SQL statements in its logs.

#idle_client_timeout ⇒ Integer

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

    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

#new_db_proxy_name ⇒ String

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

    The new identifier for the DBProxy.

#require_tls ⇒ Boolean

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

    Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

#role_arn ⇒ String

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

Returns:

  • (String) —

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

#security_groups ⇒ Array<String>

The new list of security groups for the DBProxy.

Returns:

  • (Array<String>) —

    The new list of security groups for the DBProxy.