Create methods under / using CF for API Gateway

Question

How do I create methods under API Gateway's root / folder using CF? So for example I have a Gateway that looks like the following:

/ OPTIONS POST

However when trying to do that with CF I get: Resource's path part only allow a-zA-Z0-9._- and curly braces at the beginning and the end. So my PathPart is the offending line.

  ApiGate:
    Type: AWS::ApiGateway::Resource
    Properties:
      ParentId: !GetAtt 
        - ApiGateApi
        - RootResourceId
      PathPart: '{/}'
      RestApiId: !Ref ApiGateApi

I can change the PathPart to something else but then it creates it as a child object under / which is what I don't want.

I have tried both of those unfortunately. Braces result in:Value of property PathPart must be of type String. And when I use an empty string: [/Resources/ApiGatewayResource/Type/PathPart/] 'null' values are not allowed in templates. — mcgoosh
– mcgoosh, Commented May 4, 2019 at 13:36

mcgoosh · Accepted Answer · 2019-11-04 15:39:21Z

0

Turns out after adding the following to my AWS::ApiGateway::Method it works now.

  MyMethodOPTIONS:
    Type: 'AWS::ApiGateway::Method'
    Properties:
      ResourceId: !GetAtt MyRestApi.RootResourceId

Here is more context into my Template:

  ApiGatewayMethodOPTIONS:
    Type: 'AWS::ApiGateway::Method'
    Properties:
      ResourceId: !GetAtt ApiGatewayRestApi.RootResourceId
      RestApiId: !Ref ApiGatewayRestApi
      AuthorizationType: NONE
      HttpMethod: OPTIONS
      Integration:
        Type: MOCK
        IntegrationResponses:
          - ResponseParameters:
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token'"
              method.response.header.Access-Control-Allow-Methods: "'POST,OPTIONS'"
              method.response.header.Access-Control-Allow-Origin: "'*'"
            ResponseTemplates:
              application/json: ''
            StatusCode: '200'
        PassthroughBehavior: NEVER
        RequestTemplates:
          application/json: '{"statusCode": 200}'
      MethodResponses:
        - ResponseModels:
            application/json: Empty
          ResponseParameters:
            method.response.header.Access-Control-Allow-Headers: true
            method.response.header.Access-Control-Allow-Methods: true
            method.response.header.Access-Control-Allow-Origin: true
          StatusCode: '200'

  ApiGatewayRestApi:
    Type: AWS::ApiGateway::RestApi
    Properties:
      ApiKeySourceType: HEADER
      EndpointConfiguration:
        Types:
          - REGIONAL
      Name: SearchAPI

edited Nov 4, 2019 at 15:39

answered May 14, 2019 at 1:42

mcgoosh

591 gold badge2 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

gene_wood Over a year ago

Could you add more detail to what solved this? Maybe some more context of the surrounding CloudFormation content.

mcgoosh Over a year ago

I've added more of my template to the original solution

dantheman · Accepted Answer · 2020-05-02 00:36:39Z

0

This fixes my problem, in my case I needed to have 2 methods: 1. will respond to requests to root e.g. https://<api-url>/prod or https://<api-url>/prod/. This will use the RootResourceId of the API Gateway:

ResourceId: !GetAtt myApiGateway.RootResourceId

this will respond to requests to whatever has been set under https://<api-url>/prod/. Could be petstore or if using {proxy+} then the backend workload will try to resolve the request. It will refer to the Resource type defined in the template:

ResourceId: !Ref myResource

answered May 2, 2020 at 0:36

dantheman

1

Collectives™ on Stack Overflow

Create methods under / using CF for API Gateway

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related