
Apache Flink TriggerSavepoint
CertifiedCreate a savepoint for a running Flink job
Apache Flink TriggerSavepoint
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.
type: io.kestra.plugin.flink.TriggerSavepointExamples
Trigger savepoint with specific directory
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
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
jobId *Requiredstring
Job ID
ID of the Flink job to snapshot.
restUrl *Requiredstring
Flink REST API URL
Base URL of the Flink REST API (e.g., http://flink-jobmanager: 8081).
cancelJob booleanstring
falseCancel job after savepoint
Cancel the job after the savepoint completes; defaults to false.
formatType string
CANONICALFormat type
Savepoint format type: CANONICAL or NATIVE. Defaults to CANONICAL for broader compatibility.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
savepointTimeout integerstring
300Savepoint timeout
Maximum wait time for savepoint completion in seconds; defaults to 300.
targetDirectory string
Target directory
Target directory for the savepoint; falls back to the cluster default when omitted.
Outputs
jobId string
Job ID
ID of the Flink job for which the savepoint was created.
requestId string
Request ID
Savepoint request ID used for status polling.
savepointPath string
Savepoint path
Path returned by Flink for the created savepoint.