rds_param_group: WARN on updating DBParameterGroupFamily (engine) #1169
Conversation
Docs Build 📝Thank you for contribution!✨ This PR has been merged and your docs changes will be incorporated when they are next published. |
ansibullbot
added
bug
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
plugins/modules/rds_param_group.py
Outdated
| db_parameter_group_family = group['DBParameterGroupFamily'] | ||
|
|
||
| if module.params.get('engine') != db_parameter_group_family: | ||
| module.fail_json(msg="The DB parameter group family (engine) can't be changed when updating a DB parameter group.") |
There was a problem hiding this comment.
It the API doesn't originally fail, wouldn't it make more sense to only warn instead of fail? It there isn't any other update to do, it would show up the warning and changed=False. This is only a suggestion.
What do you think @mandar242 @tremble @jillr ?
There was a problem hiding this comment.
@alinabuzachis that seems reasonable, I was going back and forth on this but later decided to fail on it
as there could be case where user wants to update more parameter (modifiable) along with DBParameterGroupFamily, if we give a warn instead of fail, and modify parameters that are possible, it could be easily misunderstood as original reported has mentioned that DBParameterGroupFamily is also changed.
There was a problem hiding this comment.
Let's be really clear that this is an immutable option in the docs (I added a small suggestion) and then give the user a warning, that way we don't introduce a breaking change and we're consistent with the API.
There was a problem hiding this comment.
@alinabuzachis, as @jillr suggested, changed the failure to warning, to avoid introducing breaking changes.
Now the task shows a warning as below
TASK [rds_param_group : test modifying rds parameter group engine/family] ******
[WARNING]: The DB parameter group family (engine) can't be changed when
updating a DB parameter group.
ok: [testhost] => {"changed": false .....
plugins/modules/rds_param_group.py
Outdated
| db_parameter_group_family = group['DBParameterGroupFamily'] | ||
|
|
||
| if module.params.get('engine') != db_parameter_group_family: | ||
| module.fail_json(msg="The DB parameter group family (engine) can't be changed when updating a DB parameter group.") |
There was a problem hiding this comment.
Let's be really clear that this is an immutable option in the docs (I added a small suggestion) and then give the user a warning, that way we don't introduce a breaking change and we're consistent with the API.
mandar242
changed the title
This comment was marked as outdated.
This comment was marked as outdated.
SUMMARY
Fixes #1074
Added a check to
WARNthe task while modifying/updating rds_param_group if task tries to changeDB parameter group family.As AWS Documentation specifies that,
ISSUE TYPE
COMPONENT NAME
rds_param_group
ADDITIONAL INFORMATION
Steps to reproduce