-
-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(tools/generate-docs): improve generate-docs
- Loading branch information
Showing
518 changed files
with
15,378 additions
and
5 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
generated: true | ||
--- | ||
|
||
# AmplifyApp | ||
|
||
|
||
## Resource | ||
|
||
```text | ||
AmplifyApp | ||
``` | ||
|
||
## Properties | ||
|
||
|
||
- `AppID`: | ||
- `Name`: | ||
- `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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`: | ||
- `Name`: | ||
- `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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`: | ||
- `UsagePlanID`: | ||
- `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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
generated: true | ||
--- | ||
|
||
# APIGatewayVpcLink | ||
|
||
|
||
## Resource | ||
|
||
```text | ||
APIGatewayVpcLink | ||
``` | ||
|
||
|
||
|
||
!!! 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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
generated: true | ||
--- | ||
|
||
# AppConfigApplication | ||
|
||
|
||
## Resource | ||
|
||
```text | ||
AppConfigApplication | ||
``` | ||
|
||
|
||
|
||
!!! 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. | ||
|
||
### DependsOn | ||
|
||
!!! important - Experimental Feature | ||
This resource depends on a resource using the experimental feature. This means that the resource will | ||
only be deleted if all the resources of a particular type are deleted first or reach a terminal state. | ||
|
||
- [AppConfigConfigurationProfile](./app-config-configuration-profile.md) | ||
- [AppConfigEnvironment](./app-config-environment.md) | ||
|
Oops, something went wrong.