Changes the settings for an existing DB proxy¶

Description¶

Changes the settings for an existing DB proxy.

Usage¶

rds_modify_db_proxy(DBProxyName, NewDBProxyName, DefaultAuthScheme,
  Auth, RequireTLS, IdleClientTimeout, DebugLogging, RoleArn,
  SecurityGroups)

Arguments¶

DBProxyName

[required] The identifier for the DBProxy to modify.
NewDBProxyName

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.
DefaultAuthScheme

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.
Auth

The new authentication settings for the DBProxy.
RequireTLS

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.
IdleClientTimeout

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.
DebugLogging

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
RoleArn

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

The new list of security groups for the DBProxy.

Value¶

A list with the following syntax:

list(
  DBProxy = list(
    DBProxyName = "string",
    DBProxyArn = "string",
    Status = "available"|"modifying"|"incompatible-network"|"insufficient-resource-limits"|"creating"|"deleting"|"suspended"|"suspending"|"reactivating",
    EngineFamily = "string",
    VpcId = "string",
    VpcSecurityGroupIds = list(
      "string"
    ),
    VpcSubnetIds = list(
      "string"
    ),
    DefaultAuthScheme = "string",
    Auth = list(
      list(
        Description = "string",
        UserName = "string",
        AuthScheme = "SECRETS",
        SecretArn = "string",
        IAMAuth = "DISABLED"|"REQUIRED"|"ENABLED",
        ClientPasswordAuthType = "MYSQL_NATIVE_PASSWORD"|"MYSQL_CACHING_SHA2_PASSWORD"|"POSTGRES_SCRAM_SHA_256"|"POSTGRES_MD5"|"SQL_SERVER_AUTHENTICATION"
      )
    ),
    RoleArn = "string",
    Endpoint = "string",
    RequireTLS = TRUE|FALSE,
    IdleClientTimeout = 123,
    DebugLogging = TRUE|FALSE,
    CreatedDate = as.POSIXct(
      "2015-01-01"
    ),
    UpdatedDate = as.POSIXct(
      "2015-01-01"
    ),
    EndpointNetworkType = "IPV4"|"IPV6"|"DUAL",
    TargetConnectionNetworkType = "IPV4"|"IPV6"
  )
)

Request syntax¶

svc$modify_db_proxy(
  DBProxyName = "string",
  NewDBProxyName = "string",
  DefaultAuthScheme = "IAM_AUTH"|"NONE",
  Auth = list(
    list(
      Description = "string",
      UserName = "string",
      AuthScheme = "SECRETS",
      SecretArn = "string",
      IAMAuth = "DISABLED"|"REQUIRED"|"ENABLED",
      ClientPasswordAuthType = "MYSQL_NATIVE_PASSWORD"|"MYSQL_CACHING_SHA2_PASSWORD"|"POSTGRES_SCRAM_SHA_256"|"POSTGRES_MD5"|"SQL_SERVER_AUTHENTICATION"
    )
  ),
  RequireTLS = TRUE|FALSE,
  IdleClientTimeout = 123,
  DebugLogging = TRUE|FALSE,
  RoleArn = "string",
  SecurityGroups = list(
    "string"
  )
)