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.

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

Docs for Api DefinitionUri do not match examples #39

Closed
stuartstevenson opened this issue Dec 15, 2016 · 1 comment
Closed

Docs for Api DefinitionUri do not match examples #39

stuartstevenson opened this issue Dec 15, 2016 · 1 comment

Comments

@stuartstevenson
Copy link

The docs say that the fields should be

Required S3 URI to the Swagger document describing the API.

Yet the example is of a local file:

DefinitionUri: swagger.yml

Can it be made clear whether the S3 format is enforced or if local files are also accepted, or an example of both provided if both are valid

@sanathkr
Copy link
Contributor

  1. Example should be fixed to have s3 path. Valid SAM templates must have S3 URI for CodeUri & DefinitionUri
  2. However if you use aws cloudformation package command (http://docs.aws.amazon.com/cli/latest/reference/cloudformation/package.html), you can have local paths in your template. This command will upload the file to S3 and output a template with local paths replaced by S3 URI of uploaded artifacts. You can use this in conjunction with aws cloudformation deploy command or native create-change-set & execute-change-set APIs to deploy your template

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants