Skip to content

Allow backup plans to be unset.#116

Open
TurboNHS wants to merge 1 commit into
mainfrom
turbo-allow-backup-config-to-be-unused
Open

Allow backup plans to be unset.#116
TurboNHS wants to merge 1 commit into
mainfrom
turbo-allow-backup-config-to-be-unused

Conversation

@TurboNHS

@TurboNHS TurboNHS commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

We (CDS-NDSP) for example don't use DynamoDB, EBS volumes or ParameterStore, so we have no need for those backup plans, and it seems silly to create them no matter what.

So to make sure they don't gets created, I want/need to set:

module "source" {
  [...]

  backup_plan_config                 = { "enable": false }
  backup_plan_config_dynamodb        = { "enable": false }
  backup_plan_config_ebsvol          = { "enable": false }
  backup_plan_config_parameter_store = { "enable": false }
}

All the other backup_plan_config_* resources had a count to create them or not, but not the "main" one, so add that. That lead to the resources being an array, so make sure they're moved automatically.

It also required all options in the variables to be optional(), which should (!?) be ok, since there's defaults.

HOWEVER, the default is only used if/when the variable is completely unset! NOT if/when some values are missing. As in, TF won't substitute empty/unset values with one from the default.

That unfortunately lead to those three values required (selection_tag, compliance_resource_types and rules in the case of the "main" config) can't be required anymore. Because they have defaults, there's no way to check (validation {}) if they're set or not. Because they always will, wether enable is true or false :(.

Description

Context

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

We (NDSPCDSP) for example don't use DynamoDB, EBS volumes or ParameterStore,
so we have no need for those backup plans, and it seems silly to create
them no matter what.

So to make sure they don't gets created, I want/need to set:
```
module "source" {
  [...]

  backup_plan_config                 = { "enable": false }
  backup_plan_config_dynamodb        = { "enable": false }
  backup_plan_config_ebsvol          = { "enable": false }
  backup_plan_config_parameter_store = { "enable": false }
}
```

All the other `backup_plan_config_*` resources had a `count` to
create them or not, but not the "main" one, so add that. That lead
to the resources being an array, so make sure they're `moved`
automatically.

It also required *all* options in the variables to be `optional()`,
which should (!?) be ok, since there's defaults.

HOWEVER, the `default` is only used if/when the variable is completely
unset! NOT if/when some values are missing. As in, TF won't substitute
empty/unset values with one from the `default`.

That unfortunately lead to those three values required (`selection_tag`,
`compliance_resource_types` and `rules` in the case of the "main" config)
can't be required anymore. Because they have defaults, there's no way
to check (`validation {}`) if they're set or not. Because they always will,
wether `enable` is `true` or `false` :(.
type = object({
enable = bool
selection_tag = string
selection_tag = optional(string)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can't be optional, would fail on aws_backup_framework creation as tag keys can't be null

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can, if there's a default for it (which there are). Besides, the selection_tag = optional(string) is what's in all the other configs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default would only work if backup_plan_config isn't passed, if backup_plan_config is passed but without selection_tag it would read it as null

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But that's true for all the other backup_plan_config* variables. THEY have these optional()s..

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see the requirement for optional in the scenario where the enable is set to false. some of the keys need to be set when enable is set to true, or terraform will fail. would it be possible to add those defaults on the optional. so optional(string, "default") to add that fallback

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the point of this PR, to allow these (all) to be unset, and then their enable = false.

Comment thread modules/aws-backup-source/variables.tf
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

Successfully merging this pull request may close these issues.

2 participants