Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: properties, refactors, and cloudformation stack cleanup #495

Merged
merged 18 commits into from
Jan 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/resources/cloud-formation-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@ generated: true
CloudFormationStack
```

## Properties


- `CreationTime`: No Description
- `LastUpdatedTime`: No Description
- `Name`: No Description
- `Status`: No Description
- `tag:<key>:`: This resource has tags with property `Tags`. These are key/value pairs that are
added as their own property with the prefix of `tag:` (e.g. [tag:example: "value"])

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.
Expand All @@ -28,6 +36,7 @@ The string value is always what is used in the output of the log format when a r
## Settings

- `DisableDeletionProtection`
- `CreateRoleToDeleteStack`


### DisableDeletionProtection
Expand All @@ -40,3 +49,14 @@ The string value is always what is used in the output of the log format when a r
DisableDeletionProtection
```


### CreateRoleToDeleteStack

!!! note
There is currently no description for this setting. Often times settings are fairly self-explanatory. However, we
are working on adding descriptions for all settings.

```text
CreateRoleToDeleteStack
```

6 changes: 6 additions & 0 deletions docs/resources/cloud-watch-alarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,14 @@ generated: true
CloudWatchAlarm
```

## Properties


- `Name`: No Description
- `Type`: No Description
- `tag:<key>:`: This resource has tags with property `Tags`. These are key/value pairs that are
added as their own property with the prefix of `tag:` (e.g. [tag:example: "value"])

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.
Expand Down
5 changes: 5 additions & 0 deletions docs/resources/cloud-watch-events-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,13 @@ generated: true
CloudWatchEventsTarget
```

## Properties


- `BusName`: The name of the event bus the rule applies to
- `Name`: The name of the rule
- `TargetID`: The ID of the target for the rule

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.
Expand Down
7 changes: 7 additions & 0 deletions docs/resources/ec2-tgw.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,15 @@ generated: true
EC2TGW
```

## Properties


- `ID`: The ID of the transit gateway.
- `OwnerId`: The ID of the AWS account that owns the transit gateway.
- `State`: The state of the transit gateway.
- `tag:<key>:`: This resource has tags with property `Tags`. These are key/value pairs that are
added as their own property with the prefix of `tag:` (e.g. [tag:example: "value"])

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.
Expand Down
2 changes: 2 additions & 0 deletions docs/resources/neptune-snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ NeptuneSnapshot
## Properties


- `CreateTime`: No Description
- `ID`: No Description
- `Status`: No Description

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
Expand Down
4 changes: 4 additions & 0 deletions docs/resources/resource-explorer-2index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,12 @@ generated: true
ResourceExplorer2Index
```

## Properties


- `ARN`: No Description
- `Type`: No Description

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.
Expand Down
3 changes: 3 additions & 0 deletions docs/resources/resource-explorer-2view.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ generated: true
ResourceExplorer2View
```

## Properties


- `ARN`: The ARN of the Resource Explorer View

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.
Expand Down
7 changes: 7 additions & 0 deletions docs/resources/route-53-resource-record-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,15 @@ generated: true
Route53ResourceRecordSet
```

## Properties


- `HostedZoneName`: The name of the zone to which the record belongs
- `Name`: The name of the record
- `Type`: The type of the record
- `tag:<key>:`: This resource has tags with property `Tags`. These are key/value pairs that are
added as their own property with the prefix of `tag:` (e.g. [tag:example: "value"])

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.
Expand Down
34 changes: 34 additions & 0 deletions docs/resources/s3-access-grants-grant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
generated: true
---

# S3AccessGrantsGrant


## Resource

```text
S3AccessGrantsGrant
```

## Properties


- `CreatedAt`: The date and time the access grant was created.
- `GrantScope`: The scope of the access grant.
- `GranteeID`: The ARN of the grantee.
- `GranteeType`: The type of the grantee, (e.g. IAM).
- `ID`: The ID of the access grant.

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.

### String Property

The string representation of a resource is generally the value of the Name, ID or ARN field of the resource. Not all
resources support properties. To write a filter against the string representation, simply omit the `property` field in
the filter.

The string value is always what is used in the output of the log format when a resource is identified.

31 changes: 31 additions & 0 deletions docs/resources/s3-access-grants-instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
generated: true
---

# S3AccessGrantsInstance


## Resource

```text
S3AccessGrantsInstance
```

## Properties


- `CreatedAt`: The time the access grants instance was created.
- `ID`: The ID of the access grants instance.

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.

### String Property

The string representation of a resource is generally the value of the Name, ID or ARN field of the resource. Not all
resources support properties. To write a filter against the string representation, simply omit the `property` field in
the filter.

The string value is always what is used in the output of the log format when a resource is identified.

32 changes: 32 additions & 0 deletions docs/resources/s3-access-grants-location.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
generated: true
---

# S3AccessGrantsLocation


## Resource

```text
S3AccessGrantsLocation
```

## Properties


- `CreatedAt`: The time the access grants location was created.
- `ID`: The ID of the access grants location.
- `LocationScope`: The scope of the access grants location.

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.

### String Property

The string representation of a resource is generally the value of the Name, ID or ARN field of the resource. Not all
resources support properties. To write a filter against the string representation, simply omit the `property` field in
the filter.

The string value is always what is used in the output of the log format when a resource is identified.

30 changes: 30 additions & 0 deletions docs/resources/transfer-web-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
generated: true
---

# TransferWebApp


## Resource

```text
TransferWebApp
```

## Properties


- `ID`: No Description

!!! note - Using Properties
Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
names to write filters for what you want to **keep** and omit from the nuke process.

### String Property

The string representation of a resource is generally the value of the Name, ID or ARN field of the resource. Not all
resources support properties. To write a filter against the string representation, simply omit the `property` field in
the filter.

The string value is always what is used in the output of the log format when a resource is identified.

5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,20 @@ require (
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.26 // indirect
github.com/aws/aws-sdk-go-v2/internal/ini v1.8.1 // indirect
github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.26 // indirect
github.com/aws/aws-sdk-go-v2/service/iam v1.38.3 // indirect
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1 // indirect
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.4.7 // indirect
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.7 // indirect
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.7 // indirect
github.com/aws/aws-sdk-go-v2/service/s3control v1.52.1 // indirect
github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.3.2 // indirect
github.com/aws/aws-sdk-go-v2/service/sso v1.24.8 // indirect
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.28.7 // indirect
github.com/aws/aws-sdk-go-v2/service/transfer v1.55.1 // indirect
github.com/benbjohnson/clock v1.3.0 // indirect
github.com/cpuguy83/go-md2man/v2 v2.0.5 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/iancoleman/strcase v0.3.0 // indirect
github.com/jmespath/go-jmespath v0.4.0 // indirect
github.com/kr/pretty v0.3.1 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
Expand Down
10 changes: 8 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ github.com/aws/aws-sdk-go-v2/internal/ini v1.8.1 h1:VaRN3TlFdd6KxX1x3ILT5ynH6HvK
github.com/aws/aws-sdk-go-v2/internal/ini v1.8.1/go.mod h1:FbtygfRFze9usAadmnGJNc8KsP346kEe+y2/oyhGAGc=
github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.26 h1:GeNJsIFHB+WW5ap2Tec4K6dzcVTsRbsT1Lra46Hv9ME=
github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.26/go.mod h1:zfgMpwHDXX2WGoG84xG2H+ZlPTkJUU4YUvx2svLQYWo=
github.com/aws/aws-sdk-go-v2/service/iam v1.38.3 h1:2sFIoFzU1IEL9epJWubJm9Dhrn45aTNEJuwsesaCGnk=
github.com/aws/aws-sdk-go-v2/service/iam v1.38.3/go.mod h1:KzlNINwfr/47tKkEhgk0r10/OZq3rjtyWy0txL3lM+I=
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1 h1:iXtILhvDxB6kPvEXgsDhGaZCSC6LQET5ZHSdJozeI0Y=
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1/go.mod h1:9nu0fVANtYiAePIBh2/pFUSwtJ402hLnp854CNoDOeE=
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.4.7 h1:tB4tNw83KcajNAzaIMhkhVI2Nt8fAZd5A5ro113FEMY=
Expand All @@ -26,8 +28,8 @@ github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.7 h1:8eUsivBQz
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.7/go.mod h1:kLPQvGUmxn/fqiCrDeohwG33bq2pQpGeY62yRO6Nrh0=
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.7 h1:Hi0KGbrnr57bEHWM0bJ1QcBzxLrL/k2DHvGYhb8+W1w=
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.7/go.mod h1:wKNgWgExdjjrm4qvfbTorkvocEstaoDl4WCvGfeCy9c=
github.com/aws/aws-sdk-go-v2/service/s3 v1.71.1 h1:aOVVZJgWbaH+EJYPvEgkNhCEbXXvH7+oML36oaPK3zE=
github.com/aws/aws-sdk-go-v2/service/s3 v1.71.1/go.mod h1:r+xl5yzMk9083rMR+sJ5TYj9Tihvf/l1oxzZXDgGj2Q=
github.com/aws/aws-sdk-go-v2/service/s3control v1.52.1 h1:xxGbXbGtO/VMz2JqB1UwEDlSchryUss0KmQJSZ0oTUE=
github.com/aws/aws-sdk-go-v2/service/s3control v1.52.1/go.mod h1:6BuUa52of67a+ri/poTH82XiL+rTGQWUPZCmf2cfVHI=
github.com/aws/aws-sdk-go-v2/service/s3 v1.72.0 h1:SAfh4pNx5LuTafKKWR02Y+hL3A+3TX8cTKG1OIAJaBk=
github.com/aws/aws-sdk-go-v2/service/s3 v1.72.0/go.mod h1:r+xl5yzMk9083rMR+sJ5TYj9Tihvf/l1oxzZXDgGj2Q=
github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.3.2 h1:4siT1z3nEVxJq1jZYu1SRoct5xgbKen+ammCuZBZ2zI=
Expand All @@ -38,6 +40,8 @@ github.com/aws/aws-sdk-go-v2/service/ssooidc v1.28.7 h1:F2rBfNAL5UyswqoeWv9zs74N
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.28.7/go.mod h1:JfyQ0g2JG8+Krq0EuZNnRwX0mU0HrwY/tG6JNfcqh4k=
github.com/aws/aws-sdk-go-v2/service/sts v1.33.3 h1:Xgv/hyNgvLda/M9l9qxXc4UFSgppnRczLxlMs5Ae/QY=
github.com/aws/aws-sdk-go-v2/service/sts v1.33.3/go.mod h1:5Gn+d+VaaRgsjewpMvGazt0WfcFO+Md4wLOuBfGR9Bc=
github.com/aws/aws-sdk-go-v2/service/transfer v1.55.1 h1:bENkaFtA6rxHAwNPjYbgwYxUHGJbL7QocCt8nKZ7d10=
github.com/aws/aws-sdk-go-v2/service/transfer v1.55.1/go.mod h1:C7x9hpm90ZocJ9GbauHMkVMU0m7knEiKhOaa4um9tBU=
github.com/aws/smithy-go v1.22.1 h1:/HPHZQ0g7f4eUeK6HKglFz8uwVfZKgoI25rb/J+dnro=
github.com/aws/smithy-go v1.22.1/go.mod h1:irrKGvNn1InZwb2d7fkIRNucdfwR8R+Ts3wxYa/cJHg=
github.com/benbjohnson/clock v1.3.0 h1:ip6w0uFQkncKQ979AypyG0ER7mqUSBdKLOgAle/AT8A=
Expand Down Expand Up @@ -82,6 +86,8 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gotidy/ptr v1.4.0 h1:7++suUs+HNHMnyz6/AW3SE+4EnBhupPSQTSI7QNijVc=
github.com/gotidy/ptr v1.4.0/go.mod h1:MjRBG6/IETiiZGWI8LrRtISXEji+8b/jigmj2q0mEyM=
github.com/iancoleman/strcase v0.3.0 h1:nTXanmYxhfFAMjZL34Ov6gkzEsSJZ5DbhxWjvSASxEI=
github.com/iancoleman/strcase v0.3.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho=
github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg=
github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=
Expand Down
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,9 @@ nav:
- Route 53 Resolver Rule: resources/route-53-resolver-rule.md
- Route 53 Resource Record Set: resources/route-53-resource-record-set.md
- Route 53 Traffic Policy: resources/route-53-traffic-policy.md
- S3 Access Grants Grant: resources/s3-access-grants-grant.md
- S3 Access Grants Instance: resources/s3-access-grants-instance.md
- S3 Access Grants Location: resources/s3-access-grants-location.md
- S3 Access Point: resources/s3-access-point.md
- S3 Bucket: resources/s3-bucket.md
- S3 Multipart Upload: resources/s3-multipart-upload.md
Expand Down Expand Up @@ -607,6 +610,7 @@ nav:
- Transcribe Vocabulary: resources/transcribe-vocabulary.md
- Transfer Server User: resources/transfer-server-user.md
- Transfer Server: resources/transfer-server.md
- Transfer Web App: resources/transfer-web-app.md
- WAF Regional Byte Match Set Ip: resources/waf-regional-byte-match-set-ip.md
- WAF Regional Byte Match Set: resources/waf-regional-byte-match-set.md
- WAF Regional Ip Set Ip: resources/waf-regional-ip-set-ip.md
Expand Down
Loading
Loading