Use serverless-{service-name}-{stage}-ServiceEndpoint as default CF export name for ServiceEndput

[mykemd]

Currently ServiceEndpoint and ImportEventLambdaFunctionQualifiedArn from CF stack are Output variables, but it would be nice to have default Export Name for them, something like sls-{service-name}-{stage}-ServiceEndpoint.

It would allow to auto-use outputs from the stack in other CF scripts by default.

We currently can do the same functionality in the custom resource section where we can introduce an output variable with export name but it would be cool to have this available by default for core output variables.

---

Proposed solution

(added by maintainers)

For each configured output in scope of the Framework, configure an export name with following naming rules:

sls-{service}-{stage}-{outputName}

I think it's unique enough to not be considered as breaking change, still if you feel it can be risky to just introduce that please elaborate.

[riquier]

That would be very useful, even better if it could export a few extra details (e.g. the API ID)

[hubsi]

Just want to clarify on what to add to the custom resource section in serverless.yml, since I was looking for it myself:

  Outputs:
    ServiceEndpointExport:
      Description: Exported Url of the endpoint
      Value:
        Fn::Join:
          - ""
          - - "https://"
            - "Ref": "ApiGatewayRestApi"
            - ".execute-api.eu-west-1.amazonaws.com/dev"
      Export:
        Name: "${self:provider.stage}:${self:service}:ServiceEndpoint"

[medikoo]

I've updated main description with implementation proposal. PR's welcome!

[js-cha]

hey @medikoo 👋 - first time OS contributor here. Just wanted to ask if this issue is still relevant and can be worked on? Would love to have a crack.

[medikoo]

@js-cha I believe that it's still relevant. Still let me confirm with @pgrzesik, @pgrzesik what do you think about this proposal?

[pgrzesik]

I think the proposal looks good, nothing to add from me 👍

[medikoo]

@js-cha it's all yours!