Pproperty ApiKeySourceType not defined for resource of type AWS::Serverless::Api

[bitconym]

Description:
I wanted to specify the Api Key Source to AUTHORIZER in the SAM template.yaml file since I use custom Lambda authorizer but it didn't succeed.

Steps to reproduce the issue:

1. Create new SAM project and try to add a new resource that uses AWS::Serverless::Api similar to:

Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      ApiKeySourceType: AUTHORIZER
      StageName: Prod

2. run sam validate

Observed result:
When running sam validate I got the error:

Error: [InvalidResourceException('MyApi', 'property ApiKeySourceType not defined for resource of type AWS::Serverless::Api')] ('MyApi', 'property ApiKeySourceType not defined for resource of type AWS::Serverless::Api')

Expected result:

• I expect AWS::Serverless::Api to accept this parameter ApiKeySourceType because it's supported in the AWS::ApiGateway::RestApi https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype

Note: I tried to use AWS::ApiGateway::RestApi to define my API in the SAM template but it didn't work out.

[bitconym]

Any update on this?

[pedrofurlanetto90]

Is there any update on this? Without this parameter, I needed to use swagger definitions on API Gateway

[bitconym]

Almost a year has passed, do you have some update?

[pedrofurlanetto90]

We really need this feature. Do you have any update? Any information on why AWS::Serverless::Api does not support it?

@imjustd did you find some workaround?

[bitconym]

@imjustd did you find some workaround?

Currenty I use this commands after deploy:

aws apigateway update-rest-api --rest-api-id <api_id> --patch-operations op=replace,path=/apiKeySource,value=AUTHORIZER && \
aws apigateway create-deployment --rest-api-id <api_id> --stage-name Prod

I would actually try to implement this myself if I know what needs to be changed in the SAM code.

[nayaranunes]

The property 'ApiKeySourceType' isn't defined for resource of type AWS::Serverless::Api, try this:

   MyApi:
      Type: AWS::Serverless::Api
      Properties:
         StageName: Prod
         Auth:
           DefaultAuthorizer: MyAuthorizer
           Authorizers:
             MyAuthorizer:

The ApiAuth doc can be helpful:
https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-apiauth.html

[bitconym]

In the ApiAuth documentation I can't find a way to specify the key source type to AUTHORIZER. Still have to use the workaround posted above.

[nayaranunes]

It's seems that the property ApiKeySourceType is defined in type AWS::Serverless::RestApi instead of AWS::Serverless::Api

[bitconym]

Yes, I tried to use RestApi without success, so will stay with AWS::Serverless::Api

[nayaranunes]

In my test with RestApi the template was valid (screenshot above) and I don't got the error InvalidResourceException('MyApi', 'property ApiKeySourceType not defined...

[bitconym]

My question is: will the SAM lambda work same with RestApi as with Api? I will try to test it in the next days but was wondering if someone already tried this.

[nverino]

You can use the OpenAPI extension x-amazon-apigateway-api-key-source with AUTHORIZER as value in your DefinitionBody

More details here

[bitconym]

It's seems that the property ApiKeySourceType is defined in type AWS::Serverless::RestApi instead of AWS::Serverless::Api

I just tested this but it seems although the template is reported as valid AWS::Serverless::RestApi is not an existing resource for SAM template, so I get this error when trying to deploy it:

Template format error: Unrecognized resource types: [AWS::Serverless::RestApi]

Also can confirm this from the official AWS documentation (only Api and HttpApi are valid both not supporting the ApiKeySourceType property):