Skip to main content

Usage Plan Key

Manages an API Gateway Usage Plan.

Sample code​

exports.createResources = () => [
  {
    type: "UsagePlanKey",
    group: "APIGateway",
    properties: ({}) => ({
      name: "apigw-dynamodb-terraform-api-key",
    }),
    dependencies: ({}) => ({
      usagePlan: "apigw-dynamodb-terraform-usage-plan",
      apiKey: "apigw-dynamodb-terraform-api-key",
    }),
  },
];

Properties​

Dependencies​

Full Examples​

List​

The user plan keys can be filtered with the APIGateway::UsagePlanKey type:

gc l -t APIGateway::UsagePlanKey
Listing resources on 1 provider: aws
✓ aws us-east-1
  ✓ Initialising
  ✓ Listing 2/2
┌───────────────────────────────────────────────────────────────────────────────────────┐
│ 1 APIGateway::UsagePlanKey from aws                                                   │
├───────────────────────────────────────────────────────────────────────────────────────┤
│ name: apigw-dynamodb-terraform-api-key                                                │
│ managedByUs: Yes                                                                      │
│ live:                                                                                 │
│   keyId: jpbzsnsj3g                                                                   │
│   keyType: API_KEY                                                                    │
│   id: MdD7yuZNMRtDSMQ8zdaT2jfd4MdPaXY7gsA4MyFd                                        │
│   name: apigw-dynamodb-terraform-api-key                                              │
│   usagePlanId: 51i8nl                                                                 │
│                                                                                       │
└───────────────────────────────────────────────────────────────────────────────────────┘


List Summary:
Provider: aws
┌──────────────────────────────────────────────────────────────────────────────────────┐
│ aws                                                                                  │
├──────────────────────────┬───────────────────────────────────────────────────────────┤
│ APIGateway::UsagePlanKey │ apigw-dynamodb-terraform-api-key                          │
└──────────────────────────┴───────────────────────────────────────────────────────────┘
1 resource, 1 type, 1 provider
Command "gc l -t APIGateway::UsagePlanKey" executed in 7s, 109 MB