feat(schema): Improve SAM Global support (awslabs#376)

BREAKING CHANGE: Improved implementation of Globals (in SAM tempates) This PR introduces a new implementation for both defining SAM templates with `Global` values, as well as parsing templates containing them. Note: Globals only apply to SAM templates - if you are using regular CloudFormation templates this breaking change should not impact you. The only impact you might see is if you are creating `cloudFormation.Template` structs manually rather than using the `cloudformation.NewTemplate()` constructor. As part of this change, a new field (`Globals`) was added to the `Template{}` struct. If you are not using the constructor, your compiler will probably complain that this field is missing from the struct instantiation in your code. For more information about what `Globals` are in SAM templates, see this link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification-template-anatomy-globals.html In previous versions of Goformation (before v5), goformation was able to parse SAM templates that contained a `Globals` section, however the implementation just overwrote the resource properties in the template, with the global values at parse time. This meant that: - It was not possible to compose a template in Go that had a Globals section. - The JSON Schema generated by this repo, had no concept of Globals. **This new implementation DOES NOT does not overwrite the values in the template, like the previous implementation did**. It replaces the old implementation completely, and exposes Globals as a series of structs that are marshalled/unmarshalled to/from JSON/YAML. This allows you to compose a template: ```go template := cloudformation.NewTemplate() template.Globals["Function"] = &global.Function{ Timeout: 1800, } ``` As well as parse a JSON/YAML template, and inspect the global properties: ```go template, err := goformation.Open("../some-template-with-globals.yml") if err != nil { fmt.Printf("failed to open template: %s\n", err) os.Exit(1) } fmt.Printf("%v", template.Globals["Function"]) // You can view the global as above, however it's type is downcast to a basic interface. // If you want to inspect properties specific to the global type (e.g. the timeout for a Lambda function) // then use the following helper methods to get the various global types from the template: globalAPI, _:= template.GetServerlessGlobalApi() globalFunction, _ := template.GetServerlessGlobalFunction() globalHttpApi, _ := template.GetServerlessGlobalHttpApi() globalSimpleTable, _ := template.GetServerlessGlobalSimpleTable() fmt.Printf("Global Function Timeout: %d\n", globalFunction.Timeout) ``` *Issue #, if available:* Fixes issues awslabs#199 and awslabs#305
mcblair · Jun 20, 2021 · d56929b · d56929b
1 parent 8da07d9
commit d56929b
Show file tree

Hide file tree

Showing 3,588 changed files with 8,856 additions and 4,916 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@
 As with other Go libraries, GoFormation can be installed with `go get`.
 
 ```
-$ go get github.com/awslabs/goformation/v4
+$ go get github.com/awslabs/goformation/v5
 ```
 
 ## Usage
@@ -46,8 +46,8 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/awslabs/goformation/v4/cloudformation"
-	"github.com/awslabs/goformation/v4/cloudformation/sns"
+	"github.com/awslabs/goformation/v5/cloudformation"
+	"github.com/awslabs/goformation/v5/cloudformation/sns"
 
 
 )
@@ -161,7 +161,7 @@ package main
 import (
 	"log"
 
-	"github.com/awslabs/goformation/v4"
+	"github.com/awslabs/goformation/v5"
 )
 
 func main() {

diff --git a/cloudformation/accessanalyzer/aws-accessanalyzer-analyzer.go b/cloudformation/accessanalyzer/aws-accessanalyzer-analyzer.go
@@ -5,8 +5,8 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
-	"github.com/awslabs/goformation/v4/cloudformation/tags"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/tags"
 )
 
 // Analyzer AWS CloudFormation Resource (AWS::AccessAnalyzer::Analyzer)

diff --git a/cloudformation/accessanalyzer/aws-accessanalyzer-analyzer_archiverule.go b/cloudformation/accessanalyzer/aws-accessanalyzer-analyzer_archiverule.go
@@ -1,7 +1,7 @@
 package accessanalyzer
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Analyzer_ArchiveRule AWS CloudFormation Resource (AWS::AccessAnalyzer::Analyzer.ArchiveRule)

diff --git a/cloudformation/accessanalyzer/aws-accessanalyzer-analyzer_filter.go b/cloudformation/accessanalyzer/aws-accessanalyzer-analyzer_filter.go
@@ -1,7 +1,7 @@
 package accessanalyzer
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Analyzer_Filter AWS CloudFormation Resource (AWS::AccessAnalyzer::Analyzer.Filter)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate.go b/cloudformation/acmpca/aws-acmpca-certificate.go
@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate AWS CloudFormation Resource (AWS::ACMPCA::Certificate)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_apipassthrough.go b/cloudformation/acmpca/aws-acmpca-certificate_apipassthrough.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_ApiPassthrough AWS CloudFormation Resource (AWS::ACMPCA::Certificate.ApiPassthrough)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_certificatepolicylist.go b/cloudformation/acmpca/aws-acmpca-certificate_certificatepolicylist.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_CertificatePolicyList AWS CloudFormation Resource (AWS::ACMPCA::Certificate.CertificatePolicyList)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_edipartyname.go b/cloudformation/acmpca/aws-acmpca-certificate_edipartyname.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_EdiPartyName AWS CloudFormation Resource (AWS::ACMPCA::Certificate.EdiPartyName)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_extendedkeyusage.go b/cloudformation/acmpca/aws-acmpca-certificate_extendedkeyusage.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_ExtendedKeyUsage AWS CloudFormation Resource (AWS::ACMPCA::Certificate.ExtendedKeyUsage)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_extendedkeyusagelist.go b/cloudformation/acmpca/aws-acmpca-certificate_extendedkeyusagelist.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_ExtendedKeyUsageList AWS CloudFormation Resource (AWS::ACMPCA::Certificate.ExtendedKeyUsageList)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_extensions.go b/cloudformation/acmpca/aws-acmpca-certificate_extensions.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_Extensions AWS CloudFormation Resource (AWS::ACMPCA::Certificate.Extensions)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_generalname.go b/cloudformation/acmpca/aws-acmpca-certificate_generalname.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_GeneralName AWS CloudFormation Resource (AWS::ACMPCA::Certificate.GeneralName)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_generalnamelist.go b/cloudformation/acmpca/aws-acmpca-certificate_generalnamelist.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_GeneralNameList AWS CloudFormation Resource (AWS::ACMPCA::Certificate.GeneralNameList)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_keyusage.go b/cloudformation/acmpca/aws-acmpca-certificate_keyusage.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_KeyUsage AWS CloudFormation Resource (AWS::ACMPCA::Certificate.KeyUsage)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_othername.go b/cloudformation/acmpca/aws-acmpca-certificate_othername.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_OtherName AWS CloudFormation Resource (AWS::ACMPCA::Certificate.OtherName)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_policyinformation.go b/cloudformation/acmpca/aws-acmpca-certificate_policyinformation.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_PolicyInformation AWS CloudFormation Resource (AWS::ACMPCA::Certificate.PolicyInformation)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_policyqualifierinfo.go b/cloudformation/acmpca/aws-acmpca-certificate_policyqualifierinfo.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_PolicyQualifierInfo AWS CloudFormation Resource (AWS::ACMPCA::Certificate.PolicyQualifierInfo)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_policyqualifierinfolist.go b/cloudformation/acmpca/aws-acmpca-certificate_policyqualifierinfolist.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_PolicyQualifierInfoList AWS CloudFormation Resource (AWS::ACMPCA::Certificate.PolicyQualifierInfoList)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_qualifier.go b/cloudformation/acmpca/aws-acmpca-certificate_qualifier.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_Qualifier AWS CloudFormation Resource (AWS::ACMPCA::Certificate.Qualifier)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_subject.go b/cloudformation/acmpca/aws-acmpca-certificate_subject.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_Subject AWS CloudFormation Resource (AWS::ACMPCA::Certificate.Subject)

diff --git a/cloudformation/acmpca/aws-acmpca-certificate_validity.go b/cloudformation/acmpca/aws-acmpca-certificate_validity.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // Certificate_Validity AWS CloudFormation Resource (AWS::ACMPCA::Certificate.Validity)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority.go b/cloudformation/acmpca/aws-acmpca-certificateauthority.go
@@ -5,8 +5,8 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
-	"github.com/awslabs/goformation/v4/cloudformation/tags"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/tags"
 )
 
 // CertificateAuthority AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_accessdescription.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_accessdescription.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_AccessDescription AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.AccessDescription)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_accessmethod.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_accessmethod.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_AccessMethod AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.AccessMethod)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_crlconfiguration.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_crlconfiguration.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_CrlConfiguration AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.CrlConfiguration)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_csrextensions.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_csrextensions.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_CsrExtensions AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.CsrExtensions)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_edipartyname.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_edipartyname.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_EdiPartyName AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.EdiPartyName)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_generalname.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_generalname.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_GeneralName AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.GeneralName)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_keyusage.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_keyusage.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_KeyUsage AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.KeyUsage)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_othername.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_othername.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_OtherName AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.OtherName)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_revocationconfiguration.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_revocationconfiguration.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_RevocationConfiguration AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.RevocationConfiguration)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_subject.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_subject.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_Subject AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.Subject)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthority_subjectinformationaccess.go b/cloudformation/acmpca/aws-acmpca-certificateauthority_subjectinformationaccess.go
@@ -1,7 +1,7 @@
 package acmpca
 
 import (
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthority_SubjectInformationAccess AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthority.SubjectInformationAccess)

diff --git a/cloudformation/acmpca/aws-acmpca-certificateauthorityactivation.go b/cloudformation/acmpca/aws-acmpca-certificateauthorityactivation.go
@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/awslabs/goformation/v4/cloudformation/policies"
+	"github.com/awslabs/goformation/v5/cloudformation/policies"
 )
 
 // CertificateAuthorityActivation AWS CloudFormation Resource (AWS::ACMPCA::CertificateAuthorityActivation)