Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Put Custom Response Headers into [Responses] #5862

Merged
merged 2 commits into from
Feb 25, 2019
Merged

Put Custom Response Headers into [Responses] #5862

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c572d1
Put `Custom Response Headers` into `[Responses]`
etc-tiago Feb 22, 2019
a0160c4
Fix headline and markdown formatting
pmuens Feb 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 18 additions & 18 deletions docs/providers/aws/events/apigateway.md
View file
Open in desktop
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ layout: Doc
- [Pass Through Behavior](#pass-through-behavior) - [Pass Through Behavior](#pass-through-behavior)
- [Responses](#responses) - [Responses](#responses)
- [Custom Response Headers](#custom-response-headers) - [Custom Response Headers](#custom-response-headers)
- [Custom Response Templates](#custom-response-templates) - [Custom Response Templates](#custom-response-templates)
- [Status Codes](#status-codes) - [Status Codes](#status-codes)
- [Available Status Codes](#available-status-codes) - [Available Status Codes](#available-status-codes)
- [Using Status Codes](#using-status-codes) - [Using Status Codes](#using-status-codes)
Expand Down Expand Up @@ -803,7 +803,7 @@ functions:
for your header values. Headers are passed to API Gateway exactly like you define them. Passing the `Cache-Control` header for your header values. Headers are passed to API Gateway exactly like you define them. Passing the `Cache-Control` header
as `"'max-age=120'"` means API Gateway will receive the value as `'max-age=120'` (enclosed with single quotes). as `"'max-age=120'"` means API Gateway will receive the value as `'max-age=120'` (enclosed with single quotes).


### Custom Response Templates #### Custom Response Templates


Sometimes you'll want to define a custom response template API Gateway should use to transform your lambdas output. Sometimes you'll want to define a custom response template API Gateway should use to transform your lambdas output.
Here's an example which will transform the return value of your lambda so that the browser renders it as HTML: Here's an example which will transform the return value of your lambda so that the browser renders it as HTML:
Expand Down Expand Up @@ -988,7 +988,7 @@ functions:
``` ```




If your application has many nested paths, you might also want to break them out into smaller services. If your application has many nested paths, you might also want to break them out into smaller services.


```yml ```yml
service: service-a service: service-a
Expand Down Expand Up @@ -1152,9 +1152,9 @@ functions:
You can use this method to share your API Gateway across services in same region. Read about this limitation [here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html). You can use this method to share your API Gateway across services in same region. Read about this limitation [here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html).




### Manually Configuring shared API Gateway ### Manually Configuring shared API Gateway


Use AWS console on browser, navigate to the API Gateway console. Select your already existing API Gateway. Use AWS console on browser, navigate to the API Gateway console. Select your already existing API Gateway.
Top Navbar should look like this Top Navbar should look like this


``` ```
Expand All @@ -1165,7 +1165,7 @@ Here xxxxxxxxx is your restApiId and yyyyyyyyyy the restApiRootResourceId.


#### Note while using authorizers with shared API Gateway #### Note while using authorizers with shared API Gateway


AWS API Gateway allows only 1 Authorizer for 1 ARN, This is okay when you use conventional serverless setup, because each stage and service will create different API Gateway. But this can cause problem when using authorizers with shared API Gateway. If we use the same authorizer directly in different services like this. AWS API Gateway allows only 1 Authorizer for 1 ARN, This is okay when you use conventional serverless setup, because each stage and service will create different API Gateway. But this can cause problem when using authorizers with shared API Gateway. If we use the same authorizer directly in different services like this.


```yml ```yml
service: service-c service: service-c
Expand All @@ -1183,7 +1183,7 @@ functions:
- http: - http:
path: /users/{userId} path: /users/{userId}
authorizer: authorizer:
arn: xxxxxxxxxxxxxxxxx #cognito/custom authorizer arn arn: xxxxxxxxxxxxxxxxx #cognito/custom authorizer arn
``` ```




Expand All @@ -1203,16 +1203,16 @@ functions:
- http: - http:
path: /project/{projectId} path: /project/{projectId}
authorizer: authorizer:
arn: xxxxxxxxxxxxxxxxx #cognito/custom authorizer arn arn: xxxxxxxxxxxxxxxxx #cognito/custom authorizer arn
``` ```


we encounter error from cloudformation as reported [here](https://github.com/serverless/serverless/issues/4711). we encounter error from cloudformation as reported [here](https://github.com/serverless/serverless/issues/4711).


A proper fix for this is work is using [Share Authorizer](#share-authorizer) or you can add a unique `name` attribute to `authorizer` in each function. This creates different API Gateway authorizer for each function, bound to the same API Gateway. However, there is a limit of 10 authorizers per RestApi, and they are forced to contact AWS to request a limit increase to unblock development. A proper fix for this is work is using [Share Authorizer](#share-authorizer) or you can add a unique `name` attribute to `authorizer` in each function. This creates different API Gateway authorizer for each function, bound to the same API Gateway. However, there is a limit of 10 authorizers per RestApi, and they are forced to contact AWS to request a limit increase to unblock development.


## Share Authorizer ## Share Authorizer


Auto-created Authorizer is convenient for conventional setup. However, when you need to define your custom Authorizer, or use `COGNITO_USER_POOLS` authorizer with shared API Gateway, it is painful because of AWS limitation. Sharing Authorizer is a better way to do. Auto-created Authorizer is convenient for conventional setup. However, when you need to define your custom Authorizer, or use `COGNITO_USER_POOLS` authorizer with shared API Gateway, it is painful because of AWS limitation. Sharing Authorizer is a better way to do.


```yml ```yml
functions: functions:
Expand All @@ -1225,7 +1225,7 @@ functions:
authorizer: authorizer:
# Provide both type and authorizerId # Provide both type and authorizerId
type: COGNITO_USER_POOLS # TOKEN or COGNITO_USER_POOLS, same as AWS Cloudformation documentation type: COGNITO_USER_POOLS # TOKEN or COGNITO_USER_POOLS, same as AWS Cloudformation documentation
authorizerId: authorizerId:
Ref: ApiGatewayAuthorizer # or hard-code Authorizer ID Ref: ApiGatewayAuthorizer # or hard-code Authorizer ID


deleteUser: deleteUser:
Expand All @@ -1236,23 +1236,23 @@ functions:
... ...
# Provide both type and authorizerId # Provide both type and authorizerId
type: COGNITO_USER_POOLS # TOKEN or COGNITO_USER_POOLS, same as AWS Cloudformation documentation type: COGNITO_USER_POOLS # TOKEN or COGNITO_USER_POOLS, same as AWS Cloudformation documentation
authorizerId: authorizerId:
Ref: ApiGatewayAuthorizer # or hard-code Authorizer ID Ref: ApiGatewayAuthorizer # or hard-code Authorizer ID


resources: resources:
Resources: Resources:
ApiGatewayAuthorizer: ApiGatewayAuthorizer:
Type: AWS::ApiGateway::Authorizer Type: AWS::ApiGateway::Authorizer
Properties: Properties:
AuthorizerResultTtlInSeconds: 300 AuthorizerResultTtlInSeconds: 300
IdentitySource: method.request.header.Authorization IdentitySource: method.request.header.Authorization
Name: Cognito Name: Cognito
RestApiId: RestApiId:
Ref: YourApiGatewayName Ref: YourApiGatewayName
Type: COGNITO_USER_POOLS Type: COGNITO_USER_POOLS
ProviderARNs: ProviderARNs:
- arn:aws:cognito-idp:${self:provider.region}:xxxxxx:userpool/abcdef - arn:aws:cognito-idp:${self:provider.region}:xxxxxx:userpool/abcdef

``` ```


## Resource Policy ## Resource Policy
Expand Down