Account

Manages an API Gateway Account.

Sample code

Update the api gateway account with a CloudWatch role:

exports.createResources = () => [
  {
    type: "Account",
    group: "APIGateway",
    dependencies: () => ({
      cloudwatchRole: "roleApiGatewayCloudWatch",
    }),
  },
];

Properties

• UpdateAccountCommandInput

Dependencies

• IAM Role

Full Examples

• RestAPI with Lambda
• serverless-patterns apigw-dynamodb-terraform
• serverless-patterns apigw-rest-api-dynamodb
• wafv2-apigateway-rest

List

The account settings can be filtered with the Account type:

gc l -t APIGateway::Account

Listing resources on 1 provider: aws
✓ aws
  ✓ Initialising
  ✓ Listing 3/3
┌─────────────────────────────────────────────────────────────────────────────┐
│ 1 APIGateway::Account from aws                                              │
├─────────────────────────────────────────────────────────────────────────────┤
│ name: default                                                               │
│ managedByUs: Yes                                                            │
│ live:                                                                       │
│   cloudwatchRoleArn: arn:aws:iam::840541460064:role/roleApiGatewayCloudWat… │
│   throttleSettings:                                                         │
│     burstLimit: 5000                                                        │
│     rateLimit: 10000                                                        │
│   features:                                                                 │
│     - "UsagePlans"                                                          │
│   apiKeyVersion: 4                                                          │
│                                                                             │
└─────────────────────────────────────────────────────────────────────────────┘


List Summary:
Provider: aws
┌────────────────────────────────────────────────────────────────────────────┐
│ aws                                                                        │
├─────────────────────┬──────────────────────────────────────────────────────┤
│ APIGateway::Account │ default                                              │
└─────────────────────┴──────────────────────────────────────────────────────┘
1 resource, 1 type, 1 provider