Skip to content

Commit

Permalink
Merge pull request #445 from ekristen/docs-resources
Browse files Browse the repository at this point in the history
docs: auto-generated resources
  • Loading branch information
ekristen authored Dec 8, 2024
2 parents 303b7da + 03bede0 commit 6bcc038
Show file tree
Hide file tree
Showing 1,033 changed files with 18,377 additions and 1,830 deletions.
3 changes: 3 additions & 0 deletions docs/config-cloud-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Config - Cloud Control

Coming Soon
4 changes: 2 additions & 2 deletions docs/resources/access-analyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ AWS::AccessAnalyzer::Analyzer
- `ARN`: The ARN of the analyzer
- `Name`: The name of the analyzer
- `Status`: The status of the analyzer
- `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"])
- `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
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/acm-certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ ACMCertificate
- `CreatedAt`: The creation time of the certificate
- `DomainName`: The domain name of the certificate
- `Status`: The status of the certificate
- `tag:&lt;key&gt;:`: 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: &#34;value&#34;])
- `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
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/acmpca-certificate-authority-state.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ ACMPCACertificateAuthorityState

- `ARN`: The Amazon Resource Name (ARN) that was assigned to the CA when it was created.
- `Status`: The status of the CA, indicating whether it is active, creating, pending_certificate, disabled, or deleted.
- `tag:&lt;key&gt;:`: 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: &#34;value&#34;])
- `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
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/acmpca-certificate-authority.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ AWS::ACMPCA::CertificateAuthority

- `ARN`: The Amazon Resource Name (ARN) of the private CA.
- `Status`: Status of the private CA.
- `tag:&lt;key&gt;:`: 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: &#34;value&#34;])
- `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
Expand Down
27 changes: 27 additions & 0 deletions docs/resources/amg-workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
generated: true
---

# AMGWorkspace


## Resource

```text
AMGWorkspace
```



!!! 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.

27 changes: 27 additions & 0 deletions docs/resources/amp-workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
generated: true
---

# AMPWorkspace


## Resource

```text
AMPWorkspace
```



!!! 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.

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

# AmplifyApp


## Resource

```text
AmplifyApp
```

## Properties


- `AppID`: No Description
- `Name`: 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.

### 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.

42 changes: 42 additions & 0 deletions docs/resources/api-gateway-api-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
generated: true
---

# APIGatewayAPIKey


## Resource

```text
APIGatewayAPIKey
```

### Alternative Resource

!!! note - Cloud Control API - Alternative Resource
This resource can also be controlled and used via Cloud Control API. Please refer to the documentation for
[Cloud Control Resources](../config-cloud-control.md) for more information.

```text
AWS::ApiGateway::ApiKey
```
## Properties


- `CreatedDate`: No Description
- `Name`: 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.

### 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.

36 changes: 36 additions & 0 deletions docs/resources/api-gateway-client-certificate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
generated: true
---

# APIGatewayClientCertificate


## Resource

```text
APIGatewayClientCertificate
```

### Alternative Resource

!!! note - Cloud Control API - Alternative Resource
This resource can also be controlled and used via Cloud Control API. Please refer to the documentation for
[Cloud Control Resources](../config-cloud-control.md) for more information.

```text
AWS::ApiGateway::ClientCertificate
```


!!! 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.

27 changes: 27 additions & 0 deletions docs/resources/api-gateway-domain-name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
generated: true
---

# APIGatewayDomainName


## Resource

```text
APIGatewayDomainName
```



!!! 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.

27 changes: 27 additions & 0 deletions docs/resources/api-gateway-rest-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
generated: true
---

# APIGatewayRestAPI


## Resource

```text
APIGatewayRestAPI
```



!!! 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.

42 changes: 42 additions & 0 deletions docs/resources/api-gateway-usage-plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
generated: true
---

# APIGatewayUsagePlan


## Resource

```text
APIGatewayUsagePlan
```

### Alternative Resource

!!! note - Cloud Control API - Alternative Resource
This resource can also be controlled and used via Cloud Control API. Please refer to the documentation for
[Cloud Control Resources](../config-cloud-control.md) for more information.

```text
AWS::ApiGateway::UsagePlan
```
## Properties


- `Name`: No Description
- `UsagePlanID`: 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.

### 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.

27 changes: 27 additions & 0 deletions docs/resources/api-gateway-v2-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
generated: true
---

# APIGatewayV2API


## Resource

```text
APIGatewayV2API
```



!!! 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.

27 changes: 27 additions & 0 deletions docs/resources/api-gateway-v2-vpc-link.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
generated: true
---

# APIGatewayV2VpcLink


## Resource

```text
APIGatewayV2VpcLink
```



!!! 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.

Loading

0 comments on commit 6bcc038

Please sign in to comment.