ClusterSnapshotSettings

edit

`ClusterSnapshotSettings`

edit

The snapshot configuration settings for an Elasticsearch cluster.

Properties

edit

cron_expression (string): Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present
enabled (boolean): Indicates if Snapshotting is enabled
interval (string): Interval between snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes
pending_interval (string): Interval between snapshot progress checks, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute
repository (ClusterSnapshotRepositoryInfo): Snapshot repository configuration
retention (ClusterSnapshotRetention): Cluster snapshot retention information
slm (boolean): When set to true, the deployment will have SLM enabled. Default value is true.
suspended (array[string]): List of temporary snapshot suspensions
wait_time_after_snapshotting (string): The time to wait between snapshot phases (snapshot, purge), with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes

Example

edit

{
   "cron_expression" : "string",
   "enabled" : true,
   "interval" : "string",
   "pending_interval" : "string",
   "repository" : {
      "default" : {},
      "reference" : {
         "repository_name" : "string"
      },
      "static" : {
         "repository_type" : "string",
         "settings" : {}
      }
   },
   "retention" : {
      "max_age" : "string",
      "snapshots" : 0
   },
   "slm" : true,
   "suspended" : [
      "string"
   ],
   "wait_time_after_snapshotting" : "string"
}

« ClusterSnapshotRetention ClusterSystemAlert »