ModifyDBProxyCommand

Suggest an Edit

Changes the settings for an existing DB proxy.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RDSClient, ModifyDBProxyCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, ModifyDBProxyCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // ModifyDBProxyRequest
  DBProxyName: "STRING_VALUE", // required
  NewDBProxyName: "STRING_VALUE",
  Auth: [ // UserAuthConfigList
    { // UserAuthConfig
      Description: "STRING_VALUE",
      UserName: "STRING_VALUE",
      AuthScheme: "SECRETS",
      SecretArn: "STRING_VALUE",
      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: Number("int"),
  DebugLogging: true || false,
  RoleArn: "STRING_VALUE",
  SecurityGroups: [ // StringList
    "STRING_VALUE",
  ],
};
const command = new ModifyDBProxyCommand(input);
const response = await client.send(command);
// { // ModifyDBProxyResponse
//   DBProxy: { // DBProxy
//     DBProxyName: "STRING_VALUE",
//     DBProxyArn: "STRING_VALUE",
//     Status: "available" || "modifying" || "incompatible-network" || "insufficient-resource-limits" || "creating" || "deleting" || "suspended" || "suspending" || "reactivating",
//     EngineFamily: "STRING_VALUE",
//     VpcId: "STRING_VALUE",
//     VpcSecurityGroupIds: [ // StringList
//       "STRING_VALUE",
//     ],
//     VpcSubnetIds: [
//       "STRING_VALUE",
//     ],
//     Auth: [ // UserAuthConfigInfoList
//       { // UserAuthConfigInfo
//         Description: "STRING_VALUE",
//         UserName: "STRING_VALUE",
//         AuthScheme: "SECRETS",
//         SecretArn: "STRING_VALUE",
//         IAMAuth: "DISABLED" || "REQUIRED" || "ENABLED",
//         ClientPasswordAuthType: "MYSQL_NATIVE_PASSWORD" || "MYSQL_CACHING_SHA2_PASSWORD" || "POSTGRES_SCRAM_SHA_256" || "POSTGRES_MD5" || "SQL_SERVER_AUTHENTICATION",
//       },
//     ],
//     RoleArn: "STRING_VALUE",
//     Endpoint: "STRING_VALUE",
//     RequireTLS: true || false,
//     IdleClientTimeout: Number("int"),
//     DebugLogging: true || false,
//     CreatedDate: new Date("TIMESTAMP"),
//     UpdatedDate: new Date("TIMESTAMP"),
//   },
// };

ModifyDBProxyCommand Input

See ModifyDBProxyCommandInput for more details

Parameter
Type
Description
DBProxyName
Required
string | undefined

The identifier for the DBProxy to modify.

Auth
UserAuthConfig[] | undefined

The new authentication settings for the DBProxy.

DebugLogging
boolean | undefined

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.

IdleClientTimeout
number | undefined

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.

NewDBProxyName
string | undefined

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.

RequireTLS
boolean | undefined

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.

RoleArn
string | undefined

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

SecurityGroups
string[] | undefined

The new list of security groups for the DBProxy.

ModifyDBProxyCommand Output

See ModifyDBProxyCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DBProxy
DBProxy | undefined

The DBProxy object representing the new settings for the proxy.

Throws

Name
Fault
Details
DBProxyAlreadyExistsFault
client

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

DBProxyNotFoundFault
client

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

InvalidDBProxyStateFault
client

The requested operation can't be performed while the proxy is in this state.

RDSServiceException
Base exception class for all service exceptions from RDS service.