Apache Flink TriggerSavepoint

Apache Flink TriggerSavepoint

Certified

Create a savepoint for a running Flink job

Requests a savepoint via the Flink REST API and waits for completion. Supports optional target directory, format type, and post-savepoint cancellation.

yaml
type: io.kestra.plugin.flink.TriggerSavepoint

Trigger savepoint with specific directory

yaml
id: create-savepoint
namespace: company.team

tasks:
  - id: trigger-savepoint
    type: io.kestra.plugin.flink.TriggerSavepoint
    restUrl: "http://flink-jobmanager:8081"
    jobId: "{{ inputs.jobId }}"
    targetDirectory: "s3://flink/savepoints/backup/{{ execution.id }}"
    savepointTimeout: 300

Trigger savepoint with default directory

yaml
id: default-savepoint
namespace: company.team

tasks:
  - id: trigger-savepoint
    type: io.kestra.plugin.flink.TriggerSavepoint
    restUrl: "http://flink-jobmanager:8081"
    jobId: "{{ inputs.jobId }}"
Properties

Job ID

ID of the Flink job to snapshot.

Flink REST API URL

Base URL of the Flink REST API (e.g., http://flink-jobmanager: 8081).

Defaultfalse

Cancel job after savepoint

Cancel the job after the savepoint completes; defaults to false.

DefaultCANONICAL

Format type

Savepoint format type: CANONICAL or NATIVE. Defaults to CANONICAL for broader compatibility.

Reference (ref) of the pluginDefaults to apply to this task.

Default300

Savepoint timeout

Maximum wait time for savepoint completion in seconds; defaults to 300.

Target directory

Target directory for the savepoint; falls back to the cluster default when omitted.

Job ID

ID of the Flink job for which the savepoint was created.

Request ID

Savepoint request ID used for status polling.

Savepoint path

Path returned by Flink for the created savepoint.