rds.replication-slots.delete

Drop a logical slot, declared or made in SQL; its consumer has to resynchronise

DELETE /rds/api/instances/{id}/replication-slots/{slot}IAM rds:DeleteDBReplicationSlotChanges stateDestructive

An active slot is refused (409) unless force=true, which ends the connection reading it.

Request syntax

DELETE /rds/api/instances/{id}/replication-slots/{slot}

Path parameters

  • idRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

  • slotRequired

    string

    Constraints: /^[a-z0-9_]{1,63}$/

Query parameters

  • forceOptional

    enum

    true: end the connection reading an active slot first

    One of: true, false

    Default: "false"

Response

200 with { name, deleted: true }.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • nameAlways

    string

    The slot
  • deletedAlways

    true

    It was dropped

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow rds:DeleteDBReplicationSlot on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud rds replication-slots delete id slot

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_replication-slots_delete.