Source code for runway.cfngin.lookups.handlers.ami

"""AMI lookup."""
# pylint: disable=unused-argument,arguments-differ
import operator
import re

from runway.lookups.handlers.base import LookupHandler

from ...session_cache import get_session
from ...util import read_value_from_path

TYPE_NAME = "ami"


[docs]class ImageNotFound(Exception): """Image not found.""" def __init__(self, search_string): """Instantiate class.""" self.search_string = search_string message = ("Unable to find ec2 image with search string: {}").format( search_string ) super(ImageNotFound, self).__init__(message)
[docs]class AmiLookup(LookupHandler): """AMI lookup."""
[docs] @classmethod def handle(cls, value, context=None, provider=None, **kwargs): """Fetch the most recent AMI Id using a filter. Args: value (str): Parameter(s) given to this lookup. context (:class:`runway.cfngin.context.Context`): Context instance. provider (:class:`runway.cfngin.providers.base.BaseProvider`): Provider instance. Returns: str: Looked up value. Example: .. code-block: ${ami [<region>@]owners:self,account,amazon name_regex:serverX-[0-9]+ architecture:x64,i386} The above fetches the most recent AMI where owner is self account or amazon and the ami name matches the regex described, the architecture will be either x64 or i386 You can also optionally specify the region in which to perform the AMI lookup. Valid arguments: owners (comma delimited) REQUIRED ONCE: aws_account_id | amazon | self name_regex (a regex) REQUIRED ONCE: e.g. ``my-ubuntu-server-[0-9]+`` executable_users (comma delimited) OPTIONAL ONCE: aws_account_id | amazon | self Any other arguments specified are sent as filters to the aws api For example, ``architecture:x86_64`` will add a filter """ # noqa value = read_value_from_path(value) if "@" in value: region, value = value.split("@", 1) else: region = provider.region ec2 = get_session(region).client("ec2") values = {} describe_args = {} # now find any other arguments that can be filters matches = re.findall(r"([0-9a-zA-z_-]+:[^\s$]+)", value) for match in matches: k, v = match.split(":", 1) values[k] = v if not values.get("owners"): raise Exception("'owners' value required when using ami") owners = values.pop("owners").split(",") describe_args["Owners"] = owners if not values.get("name_regex"): raise Exception("'name_regex' value required when using ami") name_regex = values.pop("name_regex") if values.get("executable_users"): executable_users = values.pop("executable_users").split(",") describe_args["ExecutableUsers"] = executable_users filters = [] for k, v in values.items(): filters.append({"Name": k, "Values": v.split(",")}) describe_args["Filters"] = filters result = ec2.describe_images(**describe_args) images = sorted( result["Images"], key=operator.itemgetter("CreationDate"), reverse=True ) for image in images: # sometimes we get ARI/AKI in response - these don't have a 'Name' if re.match("^%s$" % name_regex, image.get("Name", "")): return image["ImageId"] raise ImageNotFound(value)