from typing import Dict
from typing import List
__func_alias__ = {"list_": "list"}
[docs]async def get(
hub,
ctx,
name: str,
resource_id: str = None,
filters: List = None,
tags: Dict[str, str] = None,
) -> Dict:
"""Get a single Elastic IP address from AWS.
If more than one resource is found, the first resource returned from AWS will be used. The function returns None
when no resource is found.
Args:
name(str):
The name of the Idem state.
resource_id(str, Optional):
Public IP of the Elastic IP address.
filters(list, Optional):
One or more filters: for example, tag :<key>, tag-key. A complete list of filters can be found at
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_addresses
tags(dict, Optional):
The dict of tags to filter by. For example, to find all resources that have a tag with the key "Owner" and
the value "TeamA" , specify "tag:Owner" for the Dict key and "TeamA" for the Dict value.
"""
result = dict(comment=[], ret=None, result=True)
tags = hub.tool.aws.tag_utils.convert_tag_dict_to_list(tags)
ret = await hub.tool.aws.ec2.elastic_ip.search_raw(
ctx=ctx, resource_id=resource_id, filters=filters, tags=tags
)
if not ret["result"]:
if "InvalidAddress.NotFound" in str(ret["comment"]):
result["comment"].append(
hub.tool.aws.comment_utils.get_empty_comment(
resource_type="aws.ec2.elastic_ip", name=name
)
)
result["comment"] += list(ret["comment"])
return result
result["comment"] += list(ret["comment"])
result["result"] = False
return result
if not ret["ret"]["Addresses"]:
result["comment"].append(
hub.tool.aws.comment_utils.get_empty_comment(
resource_type="aws.ec2.elastic_ip", name=name
)
)
return result
resource = ret["ret"]["Addresses"][0]
if len(ret["ret"]["Addresses"]) > 1:
result["comment"].append(
f"More than one aws.ec2.elastic_ip resource was found. Use resource {resource.get('PublicIp')}"
)
result["ret"] = hub.tool.aws.ec2.conversion_utils.convert_raw_elastic_ip_to_present(
raw_resource=resource, idem_resource_name=name
)
return result
[docs]async def list_(
hub,
ctx,
name: str = None,
filters: List = None,
tags: Dict[str, str] = None,
) -> Dict:
"""Fetch a list of Elastic IP addresses from AWS.
The function returns empty list when no resource is found.
Args:
name(str, Optional):
The name of the Idem state.
filters(list, Optional):
One or more filters: for example, tag :<key>, tag-key. A complete list of filters can be found at
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_addresses
tags(dict, Optional):
The dict of tags to filter by. For example, to find all resources that have a tag with the key "Owner" and
the value "TeamA" , specify "tag:Owner" for the Dict key and "TeamA" for the Dict value.
"""
result = dict(comment=[], ret=[], result=True)
tags = hub.tool.aws.tag_utils.convert_tag_dict_to_list(tags)
ret = await hub.tool.aws.ec2.elastic_ip.search_raw(
ctx=ctx, filters=filters, tags=tags
)
if not ret["result"]:
result["comment"] += list(ret["comment"])
result["result"] = False
return result
if not ret["ret"]["Addresses"]:
result["comment"].append(
hub.tool.aws.comment_utils.list_empty_comment(
resource_type="aws.ec2.elastic_ip", name=name
)
)
return result
for address in ret["ret"]["Addresses"]:
result["ret"].append(
hub.tool.aws.ec2.conversion_utils.convert_raw_elastic_ip_to_present(
raw_resource=address, idem_resource_name=address.get("PublicIp")
)
)
return result