OpenSearch/docs/reference/ilm/actions/ilm-wait-for-snapshot.asciidoc
debadair 8a662c7e62
ILM update backports (#55902)
* [DOCS] Rework conceptual info for ILM. (#52181)

* [DOCS] Rework conceptual info for ILM.

* Split the actions out of concepts.

* Added xpack role to actions.

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Apply suggestions from code review

* Edit actions for consistency and add action template. (#55632)

* Edit actions for consistency and add action template.

* Update docs/reference/ilm/actions/ilm-readonly.asciidoc

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Apply suggestions from code review
2020-04-28 16:38:01 -07:00

36 lines
762 B
Plaintext

[role="xpack"]
[[ilm-wait-for-snapshot]]
=== Wait for snapshot
Phases allowed: delete.
Waits for the specified {slm-init} policy to be executed before removing the index.
This ensures that a snapshot of the deleted index is available.
[[ilm-wait-for-snapshot-options]]
==== Options
`policy`::
(Required, string)
Name of the {slm-init} policy that the delete action should wait for.
[[ilm-wait-for-snapshot-ex]]
==== Example
[source,console]
--------------------------------------------------
PUT _ilm/policy/my_policy
{
"policy": {
"phases": {
"delete": {
"actions": {
"wait_for_snapshot" : {
"policy": "slm-policy-name"
}
}
}
}
}
}
--------------------------------------------------