Skip to content

Commit

Permalink
[Resolve Sceptre#605] Fix docs for protected stacks
Browse files Browse the repository at this point in the history
The documentation is now aligned with the implementation and specifies
that the word "protect" should be used to protect stacks (instead of
"protected").
  • Loading branch information
jmourelos committed May 8, 2019
1 parent 2ae24ba commit f10b649
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/_source/docs/stack_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ particular Stack. The available keys are listed below.
- `notifications`_ *(optional)*
- `on_failure`_ *(optional)*
- `parameters`_ *(optional)*
- `protected`_ *(optional)*
- `protect`_ *(optional)*
- `role_arn`_ *(optional)*
- `sceptre_user_data`_ *(optional)*
- `stack_name`_ *(optional)*
Expand Down Expand Up @@ -118,8 +118,8 @@ Example:
- !stack_output security-groups::BaseSecurityGroupId
- !file_contents /file/with/security_group_id.txt
protected
~~~~~~~~~
protect
~~~~~~~

Stack protection against execution of the following commands:

Expand All @@ -132,6 +132,12 @@ Stack protection against execution of the following commands:
If a user tries to run one of these commands on a protected Stack, Sceptre will
throw an error.

Example:

.. code-block:: yaml
protect: true
role_arn
~~~~~~~~

Expand Down Expand Up @@ -294,7 +300,7 @@ Examples
.. _notifications: #notifications
.. _on_failure: #on_failure
.. _parameters: #parameters
.. _protected: #protected
.. _protect: #protect
.. _role_arn: #role_arn
.. _sceptre_user_data: #sceptre_user_data
.. _stack_name: #stack_name
Expand Down

0 comments on commit f10b649

Please sign in to comment.