-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Api.ts
1702 lines (1612 loc) · 45 KB
/
Api.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { Construct } from "constructs";
import {
Role,
ServicePrincipal,
PolicyDocument,
PolicyStatement,
} from "aws-cdk-lib/aws-iam";
import {
CfnApi,
CfnRoute,
CfnStage,
DomainName,
HttpApi,
HttpApiProps,
HttpMethod,
HttpNoneAuthorizer,
HttpRoute,
HttpRouteIntegration,
HttpRouteKey,
HttpStage,
HttpStageProps,
IHttpApi,
IHttpRouteAuthorizer,
IntegrationCredentials,
PayloadFormatVersion,
} from "aws-cdk-lib/aws-apigatewayv2";
import {
HttpUrlIntegration,
HttpUrlIntegrationProps,
HttpAlbIntegration,
HttpAlbIntegrationProps,
HttpNlbIntegration,
HttpNlbIntegrationProps,
HttpLambdaIntegration,
} from "aws-cdk-lib/aws-apigatewayv2-integrations";
import {
HttpIamAuthorizer,
HttpJwtAuthorizer,
HttpLambdaAuthorizer,
HttpLambdaResponseType,
HttpUserPoolAuthorizer,
} from "aws-cdk-lib/aws-apigatewayv2-authorizers";
import {
HttpAwsIntegration,
HttpAwsIntegrationProps,
} from "./cdk/HttpAwsIntegration.js";
import { App } from "./App.js";
import { Stack } from "./Stack.js";
import { getFunctionRef, SSTConstruct, isCDKConstruct } from "./Construct.js";
import {
Function as Fn,
FunctionProps,
FunctionInlineDefinition,
FunctionDefinition,
} from "./Function.js";
import { BindingResource, BindingProps } from "./util/binding.js";
import { Duration, toCdkDuration } from "./util/duration.js";
import { Permissions } from "./util/permission.js";
import * as apigV2Cors from "./util/apiGatewayV2Cors.js";
import * as apigV2Domain from "./util/apiGatewayV2Domain.js";
import * as apigV2AccessLog from "./util/apiGatewayV2AccessLog.js";
import { IFunction } from "aws-cdk-lib/aws-lambda";
import {
IApplicationListener,
INetworkListener,
} from "aws-cdk-lib/aws-elasticloadbalancingv2";
import { LogGroup } from "aws-cdk-lib/aws-logs";
import { Certificate } from "aws-cdk-lib/aws-certificatemanager";
import { UserPool, UserPoolClient } from "aws-cdk-lib/aws-cognito";
const PayloadFormatVersions = ["1.0", "2.0"] as const;
export type ApiPayloadFormatVersion = (typeof PayloadFormatVersions)[number];
type ApiHttpMethod = keyof typeof HttpMethod;
export interface CdkHttpAwsIntegrationProps extends HttpAwsIntegrationProps {}
/////////////////////
// Interfaces
/////////////////////
export type ApiAuthorizer =
| ApiUserPoolAuthorizer
| ApiJwtAuthorizer
| ApiLambdaAuthorizer;
interface ApiBaseAuthorizer {
/**
* The name of the authorizer.
*/
name?: string;
/**
* The identity source for which authorization is requested.
* @default `["$request.header.Authorization"]`
*/
identitySource?: string[];
}
/**
* Specify a user pool authorizer and configure additional options.
*
* @example
* ```js
* new Api(stack, "Api", {
* authorizers: {
* Authorizer: {
* type: "user_pool",
* userPool: {
* id: userPool.userPoolId,
* clientIds: [userPoolClient.userPoolClientId],
* },
* },
* },
* });
* ```
*/
export interface ApiUserPoolAuthorizer extends ApiBaseAuthorizer {
/**
* String li any shot and having even a miniscule shotteral to signify that the authorizer is user pool authorizer.
*/
type: "user_pool";
userPool?: {
/**
* The id of the user pool to use for authorization.
*/
id: string;
/**
* The ids of the user pool clients to use for authorization.
*/
clientIds?: string[];
/**
* The AWS region of the user pool.
*/
region?: string;
};
cdk?: {
/**
* This allows you to override the default settings this construct uses internally to create the authorizer.
*/
authorizer: HttpUserPoolAuthorizer;
};
}
/**
* Specify a JWT authorizer and configure additional options.
*
* @example
* ```js
* new Api(stack, "Api", {
* authorizers: {
* Authorizer: {
* type: "jwt",
* userPool: {
* issuer: "https://abc.us.auth0.com",
* audience: ["123"],
* },
* },
* },
* });
* ```
*/
export interface ApiJwtAuthorizer extends ApiBaseAuthorizer {
/**
* String literal to signify that the authorizer is JWT authorizer.
*/
type: "jwt";
jwt?: {
/**
* The base domain of the identity provider that issues JWT.
*/
issuer: string;
/**
* A list of the intended recipients of the JWT.
*/
audience: string[];
};
cdk?: {
/**
* This allows you to override the default settings this construct uses internally to create the authorizer.
*/
authorizer: HttpJwtAuthorizer;
};
}
/**
* Specify a Lambda authorizer and configure additional options.
*
* @example
* ```js
* new Api(stack, "Api", {
* authorizers: {
* Authorizer: {
* type: "lambda",
* function: new Function(stack, "Authorizer", {
* handler: "test/lambda.handler",
* }),
* },
* },
* });
* ```
*/
export interface ApiLambdaAuthorizer extends ApiBaseAuthorizer {
/**
* String literal to signify that the authorizer is Lambda authorizer.
*/
type: "lambda";
/**
* Used to create the authorizer function
*/
function?: Fn;
/**
* The types of responses the lambda can return.
*
* If `simple` is included then response format 2.0 will be used.
* @default ["iam"]
*/
responseTypes?: Lowercase<keyof typeof HttpLambdaResponseType>[];
/**
* The amount of time the results are cached.
* @default Not cached
*/
resultsCacheTtl?: Duration;
cdk?: {
/**
* This allows you to override the default settings this construct uses internally to create the authorizer.
*/
authorizer: HttpLambdaAuthorizer;
};
}
export interface ApiCorsProps extends apigV2Cors.CorsProps {}
export interface ApiDomainProps extends apigV2Domain.CustomDomainProps {}
export interface ApiAccessLogProps extends apigV2AccessLog.AccessLogProps {}
export interface ApiProps<
Authorizers extends Record<string, ApiAuthorizer> = Record<
string,
ApiAuthorizer
>,
AuthorizerKeys = keyof Authorizers
> {
/**
* Define the routes for the API. Can be a function, proxy to another API, or point to an load balancer
*
* @example
*
* ```js
* new Api(stack, "api", {
* routes: {
* "GET /notes" : "src/list.main",
* "GET /notes/{id}" : "src/get.main",
* "$default": "src/default.main"
* }
* })
* ```
*/
routes?: Record<string, ApiRouteProps<AuthorizerKeys>>;
/**
* CORS support applied to all endpoints in this API
*
* @default true
*
* @example
*
* ```js
* new Api(stack, "Api", {
* cors: {
* allowMethods: ["GET"],
* },
* });
* ```
*
*/
cors?: boolean | ApiCorsProps;
/**
* Enable CloudWatch access logs for this API. Defaults to true.
*
* @default true
*
* @example
* ```js
* new Api(stack, "Api", {
* accessLog: true
* });
* ```
*
* ```js
* new Api(stack, "Api", {
* accessLog: {
* retention: "one_week",
* },
* });
* ```
*/
accessLog?: boolean | string | ApiAccessLogProps;
/**
* Specify a custom domain to use in addition to the automatically generated one. SST currently supports domains that are configured using [Route 53](https://aws.amazon.com/route53/)
*
* @example
* ```js
* new Api(stack, "Api", {
* customDomain: "api.example.com"
* })
* ```
*
* ```js
* new Api(stack, "Api", {
* customDomain: {
* domainName: "api.example.com",
* hostedZone: "domain.com",
* path: "v1"
* }
* })
* ```
*/
customDomain?: string | ApiDomainProps;
/**
* Define the authorizers for the API. Can be a user pool, JWT, or Lambda authorizers.
*
* @example
* ```js
* new Api(stack, "Api", {
* authorizers: {
* Authorizer: {
* type: "user_pool",
* userPool: {
* id: userPool.userPoolId,
* clientIds: [userPoolClient.userPoolClientId],
* },
* },
* },
* });
* ```
*/
authorizers?: Authorizers;
defaults?: {
/**
* The default function props to be applied to all the Lambda functions in the API. The `environment`, `permissions` and `layers` properties will be merged with per route definitions if they are defined.
*
* @example
* ```js
* new Api(stack, "Api", {
* defaults: {
* function: {
* timeout: 20,
* environment: { tableName: table.tableName },
* permissions: [table],
* }
* }
* });
* ```
*/
function?: FunctionProps;
/**
* The default authorizer for all the routes in the API.
*
* @example
* ```js
* new Api(stack, "Api", {
* defaults: {
* authorizer: "iam",
* }
* });
* ```
*
* @example
* ```js
* new Api(stack, "Api", {
* authorizers: {
* Authorizer: {
* type: "user_pool",
* userPool: {
* id: userPool.userPoolId,
* clientIds: [userPoolClient.userPoolClientId],
* },
* },
* },
* defaults: {
* authorizer: "Authorizer",
* }
* });
* ```
*/
authorizer?:
| "none"
| "iam"
| (string extends AuthorizerKeys
? Omit<AuthorizerKeys, "none" | "iam">
: AuthorizerKeys);
/**
* An array of scopes to include in the authorization when using `user_pool` or `jwt` authorizers. These will be merged with the scopes from the attached authorizer.
* @default []
*/
authorizationScopes?: string[];
/**
* The [payload format version](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html#http-api-develop-integrations-lambda.proxy-format) for all the endpoints in the API.
* @default "2.0"
*/
payloadFormatVersion?: ApiPayloadFormatVersion;
throttle?: {
/**
* The [burst rate](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-throttling.html) of the number of concurrent request for all the routes in the API.
*
* @example
* ```js
* new Api(stack, "Api", {
* defaults: {
* throttle: {
* burst: 100
* }
* }
* })
* ```
*/
burst?: number;
/**
* The [steady-state rate](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-throttling.html) of the number of concurrent request for all the routes in the API.
*
* @example
* ```js
* new Api(stack, "Api", {
* defaults: {
* throttle: {
* rate: 10
* }
* }
* })
* ```
*/
rate?: number;
};
};
cdk?: {
/**
* Allows you to override default id for this construct.
*/
id?: string;
/**
* Import the underlying HTTP API or override the default configuration
*
* @example
* ```js
* import { HttpApi } from "aws-cdk-lib/aws-apigatewayv2";
*
* new Api(stack, "Api", {
* cdk: {
* httpApi: HttpApi.fromHttpApiAttributes(stack, "MyHttpApi", {
* httpApiId,
* }),
* }
* });
* ```
*/
httpApi?: IHttpApi | HttpApiProps;
/**
* Configures the stages to create for the HTTP API.
*
* Note that, a default stage is automatically created, unless the `cdk.httpApi.createDefaultStage` is set to `false.
*
* @example
* ```js
* import { HttpApi } from "aws-cdk-lib/aws-apigatewayv2";
*
* new Api(stack, "Api", {
* cdk: {
* httpStages: [{
* stageName: "dev",
* autoDeploy: false,
* }],
* }
* });
* ```
*/
httpStages?: Omit<HttpStageProps, "httpApi">[];
};
}
export type ApiRouteProps<AuthorizerKeys> =
| FunctionInlineDefinition
| ApiFunctionRouteProps<AuthorizerKeys>
| ApiAwsRouteProps<AuthorizerKeys>
| ApiHttpRouteProps<AuthorizerKeys>
| ApiAlbRouteProps<AuthorizerKeys>
| ApiNlbRouteProps<AuthorizerKeys>
| ApiGraphQLRouteProps<AuthorizerKeys>;
interface ApiBaseRouteProps<AuthorizerKeys = string> {
authorizer?:
| "none"
| "iam"
| (string extends AuthorizerKeys
? Omit<AuthorizerKeys, "none" | "iam">
: AuthorizerKeys);
authorizationScopes?: string[];
}
/**
* Specify a function route handler and configure additional options
*
* @example
* ```js
* api.addRoutes(stack, {
* "GET /notes/{id}": {
* type: "function",
* function: "src/get.main",
* payloadFormatVersion: "1.0",
* }
* });
* ```
*/
export interface ApiFunctionRouteProps<AuthorizersKeys = string>
extends ApiBaseRouteProps<AuthorizersKeys> {
type?: "function";
/**
*The function definition used to create the function for this route.
*/
function?: FunctionDefinition;
/**
* The payload format version for the route.
*
* @default "2.0"
*/
payloadFormatVersion?: ApiPayloadFormatVersion;
cdk?: {
/**
* Use an existing Lambda function.
*/
function?: IFunction;
};
}
/**
* Specify a function route handler and configure additional options
*
* @example
* ```js
* api.addRoutes(stack, {
* "GET /notes/{id}": {
* type: "aws",
* cdk: {
* integration: {
* subtype: apig.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
* parameterMapping: ParameterMapping.fromObject({
* Source: MappingValue.custom("$request.body.source"),
* DetailType: MappingValue.custom("$request.body.detailType"),
* Detail: MappingValue.custom("$request.body.detail"),
* }),
* }
* }
* }
* });
* ```
*/
export interface ApiAwsRouteProps<AuthorizersKeys>
extends ApiBaseRouteProps<AuthorizersKeys> {
/**
* This is a constant
*/
type: "aws";
cdk: {
integration: Omit<CdkHttpAwsIntegrationProps, "credentials">;
};
}
/**
* Specify a route handler that forwards to another URL
*
* @example
* ```js
* api.addRoutes(stack, {
* "GET /notes/{id}": {
* type: "url",
* url: "https://example.com/notes/{id}",
* }
* });
* ```
*/
export interface ApiHttpRouteProps<AuthorizersKeys>
extends ApiBaseRouteProps<AuthorizersKeys> {
/**
* This is a constant
*/
type: "url";
/**
* The URL to forward to
*/
url: string;
cdk?: {
/**
* Override the underlying CDK integration
*/
integration: HttpUrlIntegrationProps;
};
}
/**
* Specify a route handler that forwards to an ALB
*
* @example
* ```js
* api.addRoutes(stack, {
* "GET /notes/{id}": {
* type: "alb",
* cdk: {
* albListener: listener,
* }
* }
* });
* ```
*/
export interface ApiAlbRouteProps<AuthorizersKeys>
extends ApiBaseRouteProps<AuthorizersKeys> {
type: "alb";
cdk: {
/**
* The listener to the application load balancer used for the integration.
*/
albListener: IApplicationListener;
integration?: HttpAlbIntegrationProps;
};
}
/**
* Specify a route handler that forwards to an NLB
*
* @example
* ```js
* api.addRoutes(stack, {
* "GET /notes/{id}": {
* type: "nlb",
* cdk: {
* nlbListener: listener,
* }
* }
* });
* ```
*/
export interface ApiNlbRouteProps<AuthorizersKeys>
extends ApiBaseRouteProps<AuthorizersKeys> {
type: "nlb";
cdk: {
/**
* The listener to the application load balancer used for the integration.
*/
nlbListener: INetworkListener;
integration?: HttpNlbIntegrationProps;
};
}
/**
* Specify a route handler that handles GraphQL queries using Pothos
*
* @example
* ```js
* api.addRoutes(stack, {
* "POST /graphql": {
* type: "graphql",
* function: {
* handler: "functions/graphql/graphql.ts",
* },
* pothos: {
* schema: "backend/functions/graphql/schema.ts",
* output: "graphql/schema.graphql",
* commands: [
* "./genql graphql/graphql.schema graphql/
* ]
* }
* }
* })
* ```
*/
export interface ApiGraphQLRouteProps<AuthorizerKeys>
extends ApiBaseRouteProps<AuthorizerKeys> {
type: "graphql";
/**
* The function definition used to create the function for this route. Must be a graphql handler
*/
function: FunctionDefinition;
pothos?: {
/**
* Path to pothos schema
*/
schema?: string;
/**
* File to write graphql schema to
*/
output?: string;
/**
* Commands to run after generating schema. Useful for code generation steps
*/
commands?: string[];
/**
* List of packages that should be considered internal during schema generation
*/
internalPackages?: string[];
};
}
/////////////////////
// Construct
/////////////////////
/**
* The Api construct is a higher level CDK construct that makes it easy to create an API.
*
* @example
*
* ```ts
* import { Api } from "sst/constructs";
*
* new Api(stack, "Api", {
* routes: {
* "GET /notes": "src/list.main",
* "POST /notes": "src/create.main",
* "GET /notes/{id}": "src/get.main",
* "PUT /notes/{id}": "src/update.main",
* "DELETE /notes/{id}": "src/delete.main",
* },
* });
* ```
*/
export class Api<
Authorizers extends Record<string, ApiAuthorizer> = Record<
string,
ApiAuthorizer
>
>
extends Construct
implements SSTConstruct
{
public readonly id: string;
public readonly cdk: {
/**
* The internally created CDK HttpApi instance.
*/
httpApi: HttpApi;
/**
* If access logs are enabled, this is the internally created CDK LogGroup instance.
*/
accessLogGroup?: LogGroup;
/**
* If custom domain is enabled, this is the internally created CDK DomainName instance.
*/
domainName?: DomainName;
/**
* If custom domain is enabled, this is the internally created CDK Certificate instance.
*/
certificate?: Certificate;
};
private props: ApiProps<Authorizers>;
private _customDomainUrl?: string;
private routesData: {
[key: string]:
| { type: "function"; function: Fn }
| { type: "lambda_function"; function: IFunction }
| { type: "aws" }
| ({
type: "graphql";
function: Fn;
} & ApiGraphQLRouteProps<any>["pothos"])
| { type: "url"; url: string }
| { type: "alb"; alb: IApplicationListener }
| { type: "nlb"; nlb: INetworkListener };
};
private authorizersData: Record<string, IHttpRouteAuthorizer>;
private bindingForAllRoutes: BindingResource[] = [];
private permissionsAttachedForAllRoutes: Permissions[] = [];
constructor(scope: Construct, id: string, props?: ApiProps<Authorizers>) {
super(scope, props?.cdk?.id || id);
this.id = id;
this.props = props || {};
this.cdk = {} as any;
this.routesData = {};
this.authorizersData = {};
this.createHttpApi();
this.addAuthorizers(this.props.authorizers || ({} as Authorizers));
this.addRoutes(this, this.props.routes || {});
const app = this.node.root as App;
app.registerTypes(this);
}
/**
* The AWS generated URL of the Api.
*/
public get url(): string {
const app = this.node.root as App;
return this.cdk.httpApi instanceof HttpApi
? this.cdk.httpApi.apiEndpoint
: `https://${(this.cdk.httpApi as IHttpApi).apiId}.execute-api.${
app.region
}.amazonaws.com`;
}
/**
* If custom domain is enabled, this is the custom domain URL of the Api.
*
* :::note
* If you are setting the base mapping for the custom domain, you need to include the trailing slash while using the custom domain URL. For example, if the [`domainName`](#domainname) is set to `api.domain.com` and the [`path`](#path) is `v1`, the custom domain URL of the API will be `https://api.domain.com/v1/`.
* :::
*/
public get customDomainUrl(): string | undefined {
return this._customDomainUrl;
}
/**
* The routes for the Api
*/
public get routes(): string[] {
return Object.keys(this.routesData);
}
/**
* The ARN of the internally created API Gateway HTTP API
*/
public get httpApiArn(): string {
const stack = Stack.of(this);
return `arn:${stack.partition}:apigateway:${stack.region}::/apis/${this.cdk.httpApi.apiId}`;
}
/**
* The id of the internally created API Gateway HTTP API
*/
public get httpApiId(): string {
return this.cdk.httpApi.apiId;
}
/**
* Adds routes to the Api after it has been created.
*
* @example
* ```js
* api.addRoutes(stack, {
* "GET /notes/{id}": "src/get.main",
* "PUT /notes/{id}": "src/update.main",
* "DELETE /notes/{id}": "src/delete.main",
* });
* ```
*/
public addRoutes(
scope: Construct,
routes: Record<string, ApiRouteProps<keyof Authorizers>>
): void {
Object.keys(routes).forEach((routeKey: string) => {
this.addRoute(scope, routeKey, routes[routeKey]);
});
}
/**
* Get the instance of the internally created Function, for a given route key where the `routeKey` is the key used to define a route. For example, `GET /notes`.
*
* @example
* ```js
* const api = new Api(stack, "Api", {
* routes: {
* "GET /notes": "src/list.main",
* },
* });
*
* const listFunction = api.getFunction("GET /notes");
* ```
*/
public getFunction(routeKey: string): Fn | undefined {
const route = this.routesData[this.normalizeRouteKey(routeKey)];
if (!route) return;
if (route.type === "function" || route.type === "graphql") {
return route.function;
}
}
/**
* Binds the given list of resources to all the routes.
*
* @example
*
* ```js
* api.bind([STRIPE_KEY, bucket]);
* ```
*/
public bind(constructs: BindingResource[]) {
for (const route of Object.values(this.routesData)) {
if (route.type === "function" || route.type === "graphql") {
route.function.bind(constructs);
}
}
this.bindingForAllRoutes.push(...constructs);
}
/**
* Binds the given list of resources to a specific route.
*
* @example
* ```js
* const api = new Api(stack, "Api", {
* routes: {
* "GET /notes": "src/list.main",
* },
* });
*
* api.bindToRoute("GET /notes", [STRIPE_KEY, bucket]);
* ```
*
*/
public bindToRoute(routeKey: string, constructs: BindingResource[]): void {
const fn = this.getFunction(routeKey);
if (!fn) {
throw new Error(
`Failed to bind resources. Route "${routeKey}" does not exist.`
);
}
fn.bind(constructs);
}
/**
* Attaches the given list of permissions to all the routes. This allows the functions to access other AWS resources.
*
* @example
*
* ```js
* api.attachPermissions(["s3"]);
* ```
*/
public attachPermissions(permissions: Permissions): void {
for (const route of Object.values(this.routesData)) {
if (route.type === "function" || route.type === "graphql") {
route.function.attachPermissions(permissions);
}
}
this.permissionsAttachedForAllRoutes.push(permissions);
}
/**
* Attaches the given list of permissions to a specific route. This allows that function to access other AWS resources.
*
* @example
* ```js
* const api = new Api(stack, "Api", {
* routes: {
* "GET /notes": "src/list.main",
* },
* });
*
* api.attachPermissionsToRoute("GET /notes", ["s3"]);
* ```
*
*/
public attachPermissionsToRoute(
routeKey: string,
permissions: Permissions
): void {
const fn = this.getFunction(routeKey);
if (!fn) {
throw new Error(
`Failed to attach permissions. Route "${routeKey}" does not exist.`
);
}
fn.attachPermissions(permissions);
}
public getConstructMetadata() {
return {
type: "Api" as const,
data: {
graphql: false,
url: this.cdk.httpApi.url,
httpApiId: this.cdk.httpApi.apiId,
customDomainUrl: this._customDomainUrl,
routes: Object.entries(this.routesData).map(([key, data]) => {
if (data.type === "function")
return {
type: "function" as const,
route: key,
fn: getFunctionRef(data.function),
};
if (data.type === "graphql")
return {
type: "graphql" as const,
route: key,
fn: getFunctionRef(data.function),
schema: data.schema,
internalPackages: data.internalPackages,
output: data.output,
commands: data.commands,
};
return { type: data.type, route: key };
}),
},
};
}
/** @internal */
public getBindings(): BindingProps {
return {
clientPackage: "api",