[PR #1756/c535e630 backport][stable-8] Create droppath option in ssm_parameter.py

[patchback]

This is a backport of PR #1756 as merged into main (c535e63).

SUMMARY

In the event that there exists two parameters in Parameter Store path/to/params/foo/bar/param and path/to/params/x/y/param, a user attempting to recursively pull all parameters under the path/to/params path with the command {{ lookup('amazon.aws.aws_ssm', '/PATH/to/params', region='ap-southeast-2', shortnames=true, bypath=true, recursive=true ) }}" will be unable to use the shortnames argument without creating a conflict between the two param results. Only one param key will exist in the resulting dictionary.

This is problematic for users that wish to lookup a parameter hierarchy with repetitive names in the final value of the parameter path. In this scenario, users are currently forced to use the fully qualified parameter name when interacting with their dictionary results.

This pull request introduces the droppath option, which will drop the common lookup path from the names of all parameters. In the scenario above, the resulting dictionary would contain both a foo/bar/param and a /x/y/param allowing users to refer to them by their minimally differentiated name.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

• lookup

ADDITIONAL INFORMATION

Step by step

Setup

• Create parameter path/to/params/foo/bar/param with value abc
• Create parameter path/to/params/x/y/param with value 123

Run shortnames

• • name: return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/param)
    debug: msg="{{ lookup('amazon.aws.aws_ssm', '/PATH/to/params', region='ap-southeast-2', shortnames=true, bypath=true, recursive=true ) }}"
• Observe result {'param': '123'}

Run droppath

• • name: return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/param)
    debug: msg="{{ lookup('amazon.aws.aws_ssm', '/PATH/to/params', region='ap-southeast-2', droppath=true, bypath=true, recursive=true ) }}"
• Observe result {'/foo/bar/param': 'abc', '/x/y/param': '123'}

Run both

• • name: return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/param)
    debug: msg="{{ lookup('amazon.aws.aws_ssm', '/PATH/to/params', region='ap-southeast-2', droppath=true, shortnames = true, bypath=true, recursive=true ) }}"
• Observe error shortnames and droppath are mutually exclusive. They cannot both be set to true.

[github-actions]

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

[softwarefactory-project-zuul]

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/648eb61524ed439b87821ae22db2edb7

✔️ ansible-galaxy-importer SUCCESS in 5m 02s
✔️ build-ansible-collection SUCCESS in 10m 49s
✔️ ansible-test-splitter SUCCESS in 4m 23s
✔️ integration-amazon.aws-1 SUCCESS in 11m 02s
Skipped 43 jobs