Skip to content

modify_db_proxy_endpoint async

modify_db_proxy_endpoint(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_proxy_endpoint_name: Optional[DBProxyEndpointName] = None,
    new_db_proxy_endpoint_name: Optional[DBProxyEndpointName] = None,
    vpc_security_group_ids: Optional[StringList] = None,
) -> ModifyDBProxyEndpointResponse

Changes the settings for an existing DB proxy endpoint.

Parameters:

  • db_proxy_endpoint_name (Optional[DBProxyEndpointName], default: None ) –

    The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

  • new_db_proxy_endpoint_name (Optional[DBProxyEndpointName], default: None ) –

    The new identifier for the DBProxyEndpoint. 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.

  • vpc_security_group_ids (Optional[StringList], default: None ) –

    The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.

Raises:

Source code in docs_src/capo_rds/_services/async_rds.py
async def modify_db_proxy_endpoint(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_proxy_endpoint_name: Optional[
        "capo_rds.types.db_proxy_endpoint_name.DBProxyEndpointName"
    ] = None,
    new_db_proxy_endpoint_name: Optional[
        "capo_rds.types.db_proxy_endpoint_name.DBProxyEndpointName"
    ] = None,
    vpc_security_group_ids: Optional[
        "capo_rds.types.string_list.StringList"
    ] = None,
) -> (
    "capo_rds.types.modify_db_proxy_endpoint_response.ModifyDBProxyEndpointResponse"
):
    """<p>Changes the settings for an existing DB proxy endpoint.</p>

    Args:
        db_proxy_endpoint_name: <p>The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.</p>
        new_db_proxy_endpoint_name: <p>The new identifier for the <code>DBProxyEndpoint</code>. 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.</p>
        vpc_security_group_ids: <p>The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.</p>

    Raises:
        capo_rds.errors.db_proxy_endpoint_already_exists_fault.DBProxyEndpointAlreadyExistsFault: <p>The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
        capo_rds.errors.db_proxy_endpoint_not_found_fault.DBProxyEndpointNotFoundFault: <p>The DB proxy endpoint doesn't exist.</p>
        capo_rds.errors.invalid_db_proxy_endpoint_state_fault.InvalidDBProxyEndpointStateFault: <p>You can't perform this operation while the DB proxy endpoint is in a particular state.</p>
        capo_rds.errors.invalid_db_proxy_state_fault.InvalidDBProxyStateFault: <p>The requested operation can't be performed while the proxy is in this state.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.modify_db_proxy_endpoint_request.ModifyDBProxyEndpointRequest]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.modify_db_proxy_endpoint_response.ModifyDBProxyEndpointResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.modify_db_proxy_endpoint

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.modify_db_proxy_endpoint.async_modify_db_proxy_endpoint(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyDBProxyEndpoint")
    )
    input_: capo_rds.types.modify_db_proxy_endpoint_request.ModifyDBProxyEndpointRequest = {}
    if db_proxy_endpoint_name is not None:
        input_["db_proxy_endpoint_name"] = db_proxy_endpoint_name
    if new_db_proxy_endpoint_name is not None:
        input_["new_db_proxy_endpoint_name"] = new_db_proxy_endpoint_name
    if vpc_security_group_ids is not None:
        input_["vpc_security_group_ids"] = vpc_security_group_ids

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output