delete_client_vpn_route ¶

def delete_client_vpn_route(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ] = None,
    target_vpc_subnet_id: Optional["capo_ec2.types.subnet_id.SubnetId"] = None,
    destination_cidr_block: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_client_vpn_route_result.DeleteClientVpnRouteResult":
    """<p>Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the <b>CreateClientVpnRoute</b> action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.</p>

    Args:
        client_vpn_endpoint_id: <p>The ID of the Client VPN endpoint from which the route is to be deleted.</p>
        target_vpc_subnet_id: <p>The ID of the target subnet used by the route.</p>
        destination_cidr_block: <p>The IPv4 address range, in CIDR notation, of the route to be deleted.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_client_vpn_route_request.DeleteClientVpnRouteRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_client_vpn_route_result.DeleteClientVpnRouteResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_client_vpn_route

        output, http_response = (
            capo_ec2._operations.amazon_ec2.delete_client_vpn_route.delete_client_vpn_route(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteClientVpnRoute")
    )
    input_: capo_ec2.types.delete_client_vpn_route_request.DeleteClientVpnRouteRequest = {}
    if client_vpn_endpoint_id is not None:
        input_["client_vpn_endpoint_id"] = client_vpn_endpoint_id
    if target_vpc_subnet_id is not None:
        input_["target_vpc_subnet_id"] = target_vpc_subnet_id
    if destination_cidr_block is not None:
        input_["destination_cidr_block"] = destination_cidr_block
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output