Skip to content

Commit

Permalink
[Resolves Sceptre#605] Fix documentation mismatch regarding protected…
Browse files Browse the repository at this point in the history
… Stacks

- Now the documentation is 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 7, 2019
1 parent a7124c4 commit 496a7da
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/docs/stack_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ a particular Stack. The available keys are listed below.
* [notifications](#notifications) _(optional)_
* [on_failure](#on_failure) _(optional)_
* [parameters](#parameters) _(optional)_
* [protected](#protected) _(optional)_
* [protect](#protect) _(optional)_
* [role_arn](#role_arn) _(optional)_
* [sceptre_user_data](#sceptre_user_data) _(optional)_
* [stack_name](#stack_name) _(optional)_
Expand Down Expand Up @@ -119,7 +119,7 @@ parameters:
- !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:

```yaml
protect: true
```

### role_arn

The ARN of a [CloudFormation Service
Expand Down

0 comments on commit 496a7da

Please sign in to comment.