ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Fix documentation for aws_ssm and aws_ssm_parameter_store (#38352)

Browse source 
Fix typos aws ssm vs aws_ssm and quotes
This commit is contained in:
Sébastien Portebois 2018-04-13 23:29:47 -04:00 committed by Will Thames
parent b4d235ca8d
commit f2b65fc5fe
2 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py
View file

@ -105,8 +105,8 @@ EXAMPLES = '''
value: "Test1234" value: "Test1234"
overwrite_value: "always" overwrite_value: "always"
- name: recommend to use with ssm lookup plugin - name: recommend to use with aws_ssm lookup plugin
debug: msg="{{ lookup('ssm', 'hello') }}" debug: msg="{{ lookup('aws_ssm', 'hello') }}"
''' '''
RETURN = ''' RETURN = '''

12
lib/ansible/plugins/lookup/aws_ssm.py
View file

@ -19,7 +19,7 @@ requirements:
- botocore - botocore
short_description: Get the value for a SSM parameter or all parameters under a path. short_description: Get the value for a SSM parameter or all parameters under a path.
description: description:
- Get the value for an Amazon Simple Systems Manager parameter or a heirarchy of parameters. - Get the value for an Amazon Simple Systems Manager parameter or a hierarchy of parameters.
The first argument you pass the lookup can either be a parameter name or a hierarchy of The first argument you pass the lookup can either be a parameter name or a hierarchy of
parameters. Hierarchies start with a forward slash and end with the parameter name. Up to parameters. Hierarchies start with a forward slash and end with the parameter name. Up to
5 layers may be specified. 5 layers may be specified.
@ -62,16 +62,16 @@ EXAMPLES = '''
debug: msg="{{ lookup('aws_ssm', 'Hello' ) }}" debug: msg="{{ lookup('aws_ssm', 'Hello' ) }}"
- name: lookup ssm parameter store in nominated region - name: lookup ssm parameter store in nominated region
debug: msg="{{ lookup('aws_ssm', 'Hello', region=us-east-2 ) }}" debug: msg="{{ lookup('aws_ssm', 'Hello', region='us-east-2' ) }}"
- name: lookup ssm parameter store without decrypted - name: lookup ssm parameter store without decrypted
debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=False ) }}" debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=False ) }}"
- name: lookup ssm parameter store in nominated aws profile - name: lookup ssm parameter store in nominated aws profile
debug: msg="{{ lookup('aws_ssm', 'Hello', aws_profile=myprofile ) }}" debug: msg="{{ lookup('aws_ssm', 'Hello', aws_profile='myprofile' ) }}"
- name: lookup ssm parameter store with all options. - name: lookup ssm parameter store with all options.
debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=false, region=us-east-2, aws_profile=myprofile') }}" debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=false, region='us-east-2', aws_profile='myprofile') }}"
- name: lookup a key which doesn't exist, returns "" - name: lookup a key which doesn't exist, returns ""
debug: msg="{{ lookup('aws_ssm', 'NoKey') }}" debug: msg="{{ lookup('aws_ssm', 'NoKey') }}"
@ -88,10 +88,10 @@ EXAMPLES = '''
debug: msg="{{ "the secret was:" ~ temp_secret | default('couldn\'t access secret') }}" debug: msg="{{ "the secret was:" ~ temp_secret | default('couldn\'t access secret') }}"
- name: return a dictionary of ssm parameters from a hierarchy path - name: return a dictionary of ssm parameters from a hierarchy path
debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region=ap-southeast-2, bypath=true, recursive=true' ) }}" debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region='ap-southeast-2', bypath=true, recursive=true ) }}"
- name: return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/param) - name: return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/param)
debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region=ap-southeast-2, shortnames=true, bypath=true, recursive=true ) }}" debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region='ap-southeast-2', shortnames=true, bypath=true, recursive=true ) }}"
- name: Iterate over a parameter hierarchy - name: Iterate over a parameter hierarchy
debug: msg='key contains {{item.Name}} with value {{item.Value}} ' debug: msg='key contains {{item.Name}} with value {{item.Value}} '