Skip to content

Commit 9876f61

Browse files
committedDec 26, 2024··
docs: add docs about name expansion
1 parent b190ddf commit 9876f61

File tree

4 files changed

+55
-0
lines changed

4 files changed

+55
-0
lines changed
 

‎docs/features/name-expansion.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Name Expansion
2+
3+
This allows you to use wildcards in the resource names to match multiple resources. This is primarily useful when you
4+
want to target a group of resource type for either inclusion or exclusion.
5+
6+
Resource Name expansion is valid for use in the following areas:
7+
8+
!!! warning
9+
This feature is currently **NOT** supported in filters.
10+
11+
- cli includes/excludes
12+
- config resource types includes/excludes
13+
- account resource types includes/excludes
14+
15+
## Examples
16+
17+
### CLI
18+
19+
```console
20+
aws-nuke run --config config.yaml --include "Cognito*"
21+
```
22+
23+
This can also be used with `resource-types` subcommand to see what resource types are available, and you can specify
24+
multiple wildcard arguments.
25+
26+
```console
27+
aws-nuke resource-types "Cognito*" "IAM*"
28+
```
29+
30+
### Config
31+
32+
```yaml
33+
resource-types:
34+
includes:
35+
- "Cognito*"
36+
excludes:
37+
- "OpsWorks*"
38+
```
39+
40+
### Account Config
41+
42+
```yaml
43+
accounts:
44+
'012345678912':
45+
resource-types:
46+
includes:
47+
- "Cognito*"
48+
excludes:
49+
- "OpsWorks*"
50+
```
51+

‎docs/features/overview.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Some of the new features include:
66
- [Run Against All Enabled Regions](enabled-regions.md)
77
- [Bypass Alias Check - Allow the skip of an alias on an account](bypass-alias-check.md)
88
- [Signed Binaries](signed-binaries.md)
9+
- [Filter Groups (Experimental)](filter-groups.md)
10+
- [Name Expansion](name-expansion.md)
911

1012
Additionally, there are a few new sub commands to the tool to help with setup and debugging purposes:
1113

‎docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This is not a comprehensive list, but here are some of the highlights:
1818
* New Feature: [Run Against All Enabled Regions](features/enabled-regions.md)
1919
* New Feature: [Bypass Alias Check - Allow the skip of an alias on an account](features/bypass-alias-check.md)
2020
* New Feature: [Filter Groups (Experimental)](features/filter-groups.md)
21+
* New Feature: [Name Expansion](features/name-expansion.md)
2122
* Breaking Change: `root` command no longer triggers the run, must use subcommand `run` (alias: `nuke`)
2223
* Completely rewrote the core of the tool as a dedicated library [libnuke](https://github.com/ekristen/libnuke)
2324
* This library has over 95% test coverage which makes iteration and new features easier to implement.

‎mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ nav:
7979
- Global Filters: features/global-filters.md
8080
- Filter Groups: features/filter-groups.md
8181
- Enabled Regions: features/enabled-regions.md
82+
- Name Expansion: features/name-expansion.md
8283
- Signed Binaries: features/signed-binaries.md
8384
- CLI:
8485
- Usage: cli-usage.md

0 commit comments

Comments
 (0)
Please sign in to comment.