Added module to find Launch Configurations (#1023)

* Added module to find Launch Configurations

* Simplified parameters to search

cloud/amazon/ec2_lc_find.py

@@ -0,0 +1,224 @@
+#!/usr/bin/python
+# encoding: utf-8
+
+# (c) 2015, Jose Armesto <jose@armesto.net>
+#
+# This file is part of Ansible
+#
+# This module is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This software is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this software.  If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = """
+---
+module: ec2_lc_find
+short_description: Find AWS Autoscaling Launch Configurations
+description:
+  - Returns list of matching Launch Configurations for a given name, along with other useful information
+  - Results can be sorted and sliced
+  - It depends on boto
+  - Based on the work by Tom Bamford (https://github.com/tombamford)
+
+version_added: "2.2"
+author: "Jose Armesto (@fiunchinho)"
+options:
+  region:
+    description:
+      - The AWS region to use.
+    required: true
+    aliases: ['aws_region', 'ec2_region']
+  name_regex:
+    description:
+      - A Launch Configuration to match
+      - It'll be compiled as regex
+    required: True
+  sort_order:
+    description:
+      - Order in which to sort results.
+    choices: ['ascending', 'descending']
+    default: 'ascending'
+    required: false
+  limit:
+    description:
+      - How many results to show.
+      - Corresponds to Python slice notation like list[:limit].
+    default: null
+    required: false
+requirements:
+  - "python >= 2.6"
+  - boto3
+"""
+
+EXAMPLES = '''
+# Note: These examples do not set authentication details, see the AWS Guide for details.
+
+# Search for the Launch Configurations that start with "app"
+- ec2_lc_find:
+    name_regex: app.*
+    sort_order: descending
+    limit: 2
+'''
+
+RETURN = '''
+image_id:
+    description: AMI id
+    returned: when Launch Configuration was found
+    type: string
+    sample: "ami-0d75df7e"
+user_data:
+    description: User data used to start instance
+    returned: when Launch Configuration was found
+    type: string
+    user_data: "ZXhwb3J0IENMT1VE"
+name:
+    description: Name of the AMI
+    returned: when Launch Configuration was found
+    type: string
+    sample: "myapp-v123"
+arn:
+    description: Name of the AMI
+    returned: when Launch Configuration was found
+    type: string
+    sample: "arn:aws:autoscaling:eu-west-1:12345:launchConfiguration:d82f050e-e315:launchConfigurationName/yourproject"
+instance_type:
+    description: Type of ec2 instance
+    returned: when Launch Configuration was found
+    type: string
+    sample: "t2.small"
+created_time:
+    description: When it was created
+    returned: when Launch Configuration was found
+    type: string
+    sample: "2016-06-29T14:59:22.222000+00:00"
+ebs_optimized:
+    description: Launch Configuration EBS optimized property
+    returned: when Launch Configuration was found
+    type: boolean
+    sample: False
+instance_monitoring:
+    description: Launch Configuration instance monitoring property
+    returned: when Launch Configuration was found
+    type: string
+    sample: {"Enabled": false}
+classic_link_vpc_security_groups:
+    description: Launch Configuration classic link vpc security groups property
+    returned: when Launch Configuration was found
+    type: list
+    sample: []
+block_device_mappings:
+    description: Launch Configuration block device mappings property
+    returned: when Launch Configuration was found
+    type: list
+    sample: []
+keyname:
+    description: Launch Configuration ssh key
+    returned: when Launch Configuration was found
+    type: string
+    sample: mykey
+security_groups:
+    description: Launch Configuration security groups
+    returned: when Launch Configuration was found
+    type: list
+    sample: []
+kernel_id:
+    description: Launch Configuration kernel to use
+    returned: when Launch Configuration was found
+    type: string
+    sample: ''
+ram_disk_id:
+    description: Launch Configuration ram disk property
+    returned: when Launch Configuration was found
+    type: string
+    sample: ''
+associate_public_address:
+    description: Assign public address or not
+    returned: when Launch Configuration was found
+    type: boolean
+    sample: True
+...
+'''
+
+
+def find_launch_configs(client, module):
+    name_regex = module.params.get('name_regex')
+    sort_order = module.params.get('sort_order')
+    limit = module.params.get('limit')
+
+    paginator = client.get_paginator('describe_launch_configurations')
+
+    response_iterator = paginator.paginate(
+        PaginationConfig={
+            'MaxItems': 1000,
+            'PageSize': 100
+        }
+    )
+
+    for response in response_iterator:
+        response['LaunchConfigurations'] = filter(lambda lc: re.compile(name_regex).match(lc['LaunchConfigurationName']),
+                                                  response['LaunchConfigurations'])
+
+    results = []
+    for lc in response['LaunchConfigurations']:
+        data = {
+            'name': lc['LaunchConfigurationName'],
+            'arn': lc['LaunchConfigurationARN'],
+            'created_time': lc['CreatedTime'],
+            'user_data': lc['UserData'],
+            'instance_type': lc['InstanceType'],
+            'image_id': lc['ImageId'],
+            'ebs_optimized': lc['EbsOptimized'],
+            'instance_monitoring': lc['InstanceMonitoring'],
+            'classic_link_vpc_security_groups': lc['ClassicLinkVPCSecurityGroups'],
+            'block_device_mappings': lc['BlockDeviceMappings'],
+            'keyname': lc['KeyName'],
+            'security_groups': lc['SecurityGroups'],
+            'kernel_id': lc['KernelId'],
+            'ram_disk_id': lc['RamdiskId'],
+            'associate_public_address': lc['AssociatePublicIpAddress'],
+        }
+
+        results.append(data)
+
+    results.sort(key=lambda e: e['name'], reverse=(sort_order == 'descending'))
+
+    if limit:
+        results = results[:int(limit)]
+
+    module.exit_json(changed=False, results=results)
+
+
+def main():
+    argument_spec = ec2_argument_spec()
+    argument_spec.update(dict(
+        region=dict(required=True, aliases=['aws_region', 'ec2_region']),
+        name_regex=dict(required=True),
+        sort_order=dict(required=False, default='ascending', choices=['ascending', 'descending']),
+        limit=dict(required=False, type='int'),
+    )
+    )
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+    )
+
+    region, ec2_url, aws_connect_params = get_aws_connection_info(module, True)
+
+    client = boto3_conn(module=module, conn_type='client', resource='autoscaling', region=region, **aws_connect_params)
+    find_launch_configs(client, module)
+
+
+# import module snippets
+from ansible.module_utils.basic import *
+from ansible.module_utils.ec2 import *
+
+if __name__ == '__main__':
+    main()