Declaring resources in multiple files in Serverless framework

Question

Is there any way to split the resource definitions in serverless framework into multiple files? Something like:

resources:
  - ${resources/base.yml}
  - ${resources/foo.yml}

I have been trying multiple combinations but I keep getting errors about references not being found.

Jesuspc · Accepted Answer · 2019-01-10 09:33:58Z

22

Even though dashmug's answer is correct, I found that the way I was trying to make it work was quite close to a valid solution too. As explained in this github comment it is possible to reference other files in the resources section:

resources:
   - ${file(resources/first-cf-resources.yml)}
   - ${file(resources/second-cf-resources.yml)}

Provided that each those files defines a "Resources" key of its own, like:

---
Resources:
  MyCFResource:
    Type:.....

What I didn't manage is to have a mixed approach such as:

resources:
  - ${file(resources/first-cf-resources.yml)}
  - ${file(resources/second-cf-resources.yml)}
  SomeResource:
    Type: ...

So I just have a resources/base.yml for that instead.

edited Jan 10, 2019 at 9:33

answered Dec 18, 2017 at 11:10

Jesuspc

1,7441 gold badge11 silver badges26 bronze badges

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

4 Comments

Techrocket9 Over a year ago

PSA: This will fail horribly if you have an empty .yml file included this way (where empty means having the "Resources:" header and nothing else.

cyberwombat Over a year ago

"horribly" is right. It took me hours to figure this out - kept having instance of Fn::GetAtt references undefined resource errors for no apparent reason with no errors shown - a file with just "Resources" (I had commented stuff out) will silently corrupt your setup. Thank you @Techrocket9

Joshua Schlichting Over a year ago

The mixed approach is possible, but requires precise (and seemingly inconsistent) indentation (needing 4 spaces where 2 is expected). The error messages that result of incorrect indentation will not be helpful either.

morgents Over a year ago

@Techrocket9: The horrible failing part can be avoided by using a fallback 'empty string'; example - ${file(resources/NonExistingFile-cf-resources.yml), ''}

Niv-Mizzet · Accepted Answer · 2019-08-28 09:13:50Z

17

I can't comment but I'd like to extend Jesuspc's answer.

There is a way to achieve that 'mixed' approach, in serverless.yml:

resources:
  - ${file(resources/first-cf-resources.yml)}
  - ${file(resources/second-cf-resources.yml)}
  - Resources:
      SomeResource:
        Type: ...

In this case files first-cf-resources.yml and second-cf-resources.yml must have the next structure:

Resources:
  SomeResourceA:
    ...
  AnotherResourceB:
    ...

edited Aug 28, 2019 at 9:13

answered Jun 26, 2018 at 8:57

Niv-Mizzet

3713 silver badges6 bronze badges

2 Comments

Niv-Mizzet Over a year ago

@DeusProx first-cf-resources.yml should also start from Resources:

DeusProx Over a year ago

I always do "resources: Resources: ..." and reference them like "- ${file(./resourcefile.yml):resources}", but it only works when just using references.

Noel Llevares · Accepted Answer · 2017-12-15 15:54:23Z

4

Take note that the resources property has to be an object containing a Resources property, NOT an array of resources like what you wanted in your code snippet.

So, to use external file references, you can do something like...

resources
    Resources:
        UsersTable: ${file(../resources/base.yml):UsersTable}
        FooTable: ${file(../resources/foo.yml):FooTable}

Reference: Reference variables in other files

answered Dec 15, 2017 at 15:54

Noel Llevares

16.2k5 gold badges60 silver badges87 bronze badges

Collectives™ on Stack Overflow

Declaring resources in multiple files in Serverless framework

3 Answers 3

4 Comments

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

4 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related