Rename ssm_parameter_store module and ssm lookup to be prefixed with aws (#31662)

lib/ansible/plugins/lookup/aws_ssm.py

@@ -0,0 +1,85 @@
+# (c) 2016, Bill Wang <ozbillwang(at)gmail.com>
+# (c) 2017 Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from ansible.module_utils.ec2 import HAS_BOTO3
+from ansible.errors import AnsibleError
+from ansible.plugins.lookup import LookupBase
+
+try:
+    from botocore.exceptions import ClientError
+    import boto3
+except ImportError:
+    pass  # will be captured by imported HAS_BOTO3
+
+
+class LookupModule(LookupBase):
+    def run(self, terms, variables, **kwargs):
+        '''
+        # lookup sample:
+        - name: lookup ssm parameter store in the current region
+          debug: msg="{{ lookup('aws_ssm', 'Hello' ) }}"
+
+        - name: lookup a key which doesn't exist, return ""
+          debug: msg="{{ lookup('aws_ssm', 'NoKey') }}"
+
+        - name: lookup ssm parameter store in nominated region
+          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' ) }}"
+
+        - name: lookup ssm parameter store with all options.
+          debug: msg="{{ lookup('aws_ssm', 'Hello', 'decrypt=false', 'region=us-east-2', 'aws_profile=myprofile') }}"
+        '''
+
+        ret = {}
+        response = {}
+        session = {}
+        ssm_dict = {}
+
+        if not HAS_BOTO3:
+            raise AnsibleError('botocore and boto3 are required.')
+
+        ssm_dict['WithDecryption'] = True
+        ssm_dict['Names'] = [terms[0]]
+
+        if len(terms) > 1:
+            for param in terms[1:]:
+                if "=" in param:
+                    key, value = param.split('=')
+                else:
+                    raise AnsibleError("ssm parameter store plugin needs key=value pairs, but received %s" % param)
+
+                if key == "region" or key == "aws_profile":
+                    session[key] = value
+
+                # decrypt the value or not
+                if key == "decrypt" and value.lower() == "false":
+                    ssm_dict['WithDecryption'] = False
+
+        if "aws_profile" in session:
+            boto3.setup_default_session(profile_name=session['aws_profile'])
+
+        if "region" in session:
+            client = boto3.client('ssm', region_name=session['region'])
+        else:
+            client = boto3.client('ssm')
+
+        try:
+            response = client.get_parameters(**ssm_dict)
+        except ClientError as e:
+            raise AnsibleError("SSM lookup exception: {0}".format(e))
+
+        ret.update(response)
+
+        if ret['Parameters']:
+            return [ret['Parameters'][0]['Value']]
+        else:
+            return None