|
| 1 | +## |
| 2 | +# Basic inherited variables for terraformscaffold modules |
| 3 | +## |
| 4 | + |
| 5 | +variable "project" { |
| 6 | + type = string |
| 7 | + description = "The name of the terraformscaffold project calling the module" |
| 8 | +} |
| 9 | + |
| 10 | +variable "environment" { |
| 11 | + type = string |
| 12 | + description = "The name of the terraformscaffold environment the module is called for" |
| 13 | +} |
| 14 | + |
| 15 | +variable "component" { |
| 16 | + type = string |
| 17 | + description = "The name of the terraformscaffold component calling this module" |
| 18 | +} |
| 19 | + |
| 20 | +variable "aws_account_id" { |
| 21 | + type = string |
| 22 | + description = "The AWS Account ID (numeric)" |
| 23 | +} |
| 24 | + |
| 25 | +variable "group" { |
| 26 | + type = string |
| 27 | + description = "The group variables are being inherited from (often synonmous with account short-name)" |
| 28 | +} |
| 29 | + |
| 30 | +variable "description" { |
| 31 | + type = string |
| 32 | + description = "Description for the branch" |
| 33 | +} |
| 34 | + |
| 35 | +## |
| 36 | +# Module self-identification |
| 37 | +## |
| 38 | + |
| 39 | +variable "module" { |
| 40 | + type = string |
| 41 | + description = "The name of this module. This is a special variable, it should be set only here and never overridden." |
| 42 | + default = "kms" |
| 43 | +} |
| 44 | + |
| 45 | +## |
| 46 | +# Variable specific to the module |
| 47 | +## |
| 48 | + |
| 49 | +# We presume this will always be specified. The default of {} will cause an error if a valid map is not specified. |
| 50 | +# If we ever want to define this but allow it to not be specified, then we must provide a default tag keypair will be applied |
| 51 | +# as the true default. In any other case default_tags should be removed from the module. |
| 52 | +variable "default_tags" { |
| 53 | + type = map(string) |
| 54 | + description = "Default tag map for application to all taggable resources in the module" |
| 55 | + default = {} |
| 56 | +} |
| 57 | + |
| 58 | +variable "region" { |
| 59 | + type = string |
| 60 | + description = "The AWS Region" |
| 61 | +} |
| 62 | + |
| 63 | +variable "name" { |
| 64 | + type = string |
| 65 | + description = "A unique name to distinguish this module invocation from others within the same CSI scope" |
| 66 | +} |
| 67 | + |
| 68 | +variable "amplify_app_id" { |
| 69 | + type = string |
| 70 | + description = "Amplify application ID" |
| 71 | +} |
| 72 | + |
| 73 | +variable "branch" { |
| 74 | + description = "The name of the branch being deployed" |
| 75 | + type = string |
| 76 | +} |
| 77 | + |
| 78 | +variable "display_name" { |
| 79 | + description = "The display name of the branch app being deployed" |
| 80 | + type = string |
| 81 | + default = null |
| 82 | +} |
| 83 | + |
| 84 | +variable "enable_auto_build" { |
| 85 | + type = bool |
| 86 | + description = "Enable the auto build of the branch code as well as just the resources for it" |
| 87 | + default = false |
| 88 | +} |
| 89 | + |
| 90 | +variable "enable_pull_request_preview" { |
| 91 | + type = bool |
| 92 | + description = "Enable the pull request preview" |
| 93 | + default = false |
| 94 | +} |
| 95 | + |
| 96 | +variable "stage" { |
| 97 | + type = string |
| 98 | + default = null |
| 99 | + description = "Determine what stage is being deployed for" |
| 100 | +} |
| 101 | + |
| 102 | +variable "framework" { |
| 103 | + type = string |
| 104 | + default = null |
| 105 | + description = "Set what framework to use" |
| 106 | +} |
| 107 | + |
| 108 | +variable "environment_variables" { |
| 109 | + type = map(string) |
| 110 | + default = {} |
| 111 | + description = "Environment variables to be used for amplify branch" |
| 112 | +} |
0 commit comments