From f2b65fc5fe6b17ea51bb2fdd5e151edae1b2dc4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Portebois?= Date: Fri, 13 Apr 2018 23:29:47 -0400 Subject: [PATCH] Fix documentation for aws_ssm and aws_ssm_parameter_store (#38352) Fix typos aws ssm vs aws_ssm and quotes --- .../modules/cloud/amazon/aws_ssm_parameter_store.py | 4 ++-- lib/ansible/plugins/lookup/aws_ssm.py | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py b/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py index 38afcd426a..fb9270265e 100644 --- a/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py +++ b/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py @@ -105,8 +105,8 @@ EXAMPLES = ''' value: "Test1234" overwrite_value: "always" -- name: recommend to use with ssm lookup plugin - debug: msg="{{ lookup('ssm', 'hello') }}" +- name: recommend to use with aws_ssm lookup plugin + debug: msg="{{ lookup('aws_ssm', 'hello') }}" ''' RETURN = ''' diff --git a/lib/ansible/plugins/lookup/aws_ssm.py b/lib/ansible/plugins/lookup/aws_ssm.py index 071f73d8c5..fe4bd1d8b5 100644 --- a/lib/ansible/plugins/lookup/aws_ssm.py +++ b/lib/ansible/plugins/lookup/aws_ssm.py @@ -19,7 +19,7 @@ requirements: - botocore short_description: Get the value for a SSM parameter or all parameters under a path. 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 parameters. Hierarchies start with a forward slash and end with the parameter name. Up to 5 layers may be specified. @@ -62,16 +62,16 @@ EXAMPLES = ''' debug: msg="{{ lookup('aws_ssm', 'Hello' ) }}" - 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 debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=False ) }}" - 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. - 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 "" debug: msg="{{ lookup('aws_ssm', 'NoKey') }}" @@ -88,10 +88,10 @@ EXAMPLES = ''' debug: msg="{{ "the secret was:" ~ temp_secret | default('couldn\'t access secret') }}" - 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) - 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 debug: msg='key contains {{item.Name}} with value {{item.Value}} '