Skip to content

Stack Configuration File Anatomy

ServerlessSam edited this page Jan 31, 2023 · 4 revisions

Below is an example BetterCF stack configuration file.

{
    "Version" : "1.0",
    "Template" : {
        "Name" : "foo",
        "Version" : "0.1"
    },
    "EnvType" : "Prod",
    "Region" : "eu-west-2",
    "Identifier" : "bar",
    "RoleArn" : null,
    "TemplateParameters" : {
        "Parameter_One" : "Value_1"
    },
    "ResourceOverrides" : {}
}
  • Version: The version to assign to this stack. Of the form X.Y or X.Y.Z.
  • Template:
    • Name: The name of the template this stack uses. This must be the same name used when pushing the template to the BetterCF template repository.
    • Version: The specific version of the template to use. Of the form X.Y or X.Y.Z.
  • EnvType: The type/grouping of environment this stack represents, e.g Production, Staging, QA etc
  • Region: The AWS region to deploy this stack to. Value must be the valid name of an AWS region e.g us-east-1
  • Identifier: An identifier used to differentiate this stack to all other stacks of the same EnvType.
  • RoleArn (Optional): If you would like to pass an AWS IAM role to CloudFormation when creating the template's resources, you can put the role's ARN here. Otherwise set it to null.
  • TemplateParameters: The parameter key/value pairs to pass to CloudFormation when deploying the stack.
  • ResourceOverrides: Not Implamented yet! Coming soon!

Clone this wiki locally