modify_db_proxy¶
Operation¶
async
¶
modify_db_proxy(input: ModifyDBProxyInput, plugins: list[Plugin] | None = None) -> ModifyDBProxyOutput
Changes the settings for an existing DB proxy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyDBProxyInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyDBProxyOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyDBProxyInput structure.
Attributes¶
class-attribute
instance-attribute
¶
auth: list[UserAuthConfig] | None = ...
The new authentication settings for the DBProxy.
class-attribute
instance-attribute
¶
db_proxy_name: str | None = ...
The identifier for the DBProxy to modify.
class-attribute
instance-attribute
¶
debug_logging: bool | None = ...
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.
class-attribute
instance-attribute
¶
default_auth_scheme: str | None = ...
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.
class-attribute
instance-attribute
¶
idle_client_timeout: int | None = ...
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.
class-attribute
instance-attribute
¶
new_db_proxy_name: str | None = ...
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.
class-attribute
instance-attribute
¶
require_tls: bool | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyDBProxyOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
The DBProxy object representing the new settings for the proxy.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.