On a related note, I've written up an ApiGateway construct that simplifies API creation massively but I'm not quite sure how to add it to the repo or how to write proper tests. Would really appreciate some feedback on whether its worth doubling down on this approach.

What I've got currently allows setting up the following API Gateway resources:

AWS::ApiGateway::Account (for enabling CloudWatch Logs for the entire account, also creates an IAM role)
AWS::ApiGateway::Deployment (for successive deployments of an API)
AWS::ApiGateway::Method (created for each Lambda)
AWS::ApiGateway::Resource (created for each Lambda, unless the path is /)
AWS::ApiGateway::RestApi (base resource for an API Gateway)
AWS::ApiGateway::Stage (only created if caching, logging or metrics is enabled)

export type MethodType = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';

export interface HttpConfig {
  path: string;
  method: MethodType;
  cors?: boolean;
}

export interface LambdaConfig {
  lambdaFn: Lambda.Function
  http: HttpConfig
}

export type EndpointType = 'EDGE' | 'REGIONAL' | 'PRIVATE';

export interface ApiGatewayProps {
  name: string;
  endpoints: LambdaConfig[];
  endpointTypes: EndpointType[];
  cacheEncrypted?: boolean;
  cacheSize?: '0.5' | '1.6' | '6.1' | '13.5' | '28.4' | '58.2' | '118' | '237';
  cacheTtl?: number;
  caching?: boolean;
  logging?: boolean;
  logLevel?: 'OFF' | 'ERROR' | 'INFO';
  metrics?: boolean;
  stageName: string;
}

new ApiGateway(this, 'MyAPI', {
  name: 'MyAPI',
  stageName: 'dev',
  endpointTypes: [ 'EDGE' ],
  logging: true,
  endpoints: [
    {
      lambdaFn: lambdaFn,
      http: {
        path: '/',
        method: 'GET'
      }
    }
  ],
});

Examples with API Gateway #602

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions