ekristen/aws-nuke

View on GitHub
docs/resources/api-gateway-usage-plan.md

Summary

Maintainability
Test Coverage
---
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.