from __future__ import unicode_literals
from moto.packages.boto.ec2.instancetype import InstanceType
from moto.autoscaling import autoscaling_backends
from moto.core.responses import BaseResponse
from moto.core.utils import camelcase_to_underscores
from moto.ec2.exceptions import MissingParameterError
from moto.ec2.utils import (
filters_from_querystring,
dict_from_querystring,
)
from moto.elbv2 import elbv2_backends
from moto.core import ACCOUNT_ID
from copy import deepcopy
import six
class InstanceResponse(BaseResponse):
def describe_instances(self):
filter_dict = filters_from_querystring(self.querystring)
instance_ids = self._get_multi_param("InstanceId")
token = self._get_param("NextToken")
if instance_ids:
reservations = self.ec2_backend.get_reservations_by_instance_ids(
instance_ids, filters=filter_dict
)
else:
reservations = self.ec2_backend.all_reservations(filters=filter_dict)
reservation_ids = [reservation.id for reservation in reservations]
if token:
start = reservation_ids.index(token) + 1
else:
start = 0
max_results = int(self._get_param("MaxResults", 100))
reservations_resp = reservations[start : start + max_results]
next_token = None
if max_results and len(reservations) > (start + max_results):
next_token = reservations_resp[-1].id
template = self.response_template(EC2_DESCRIBE_INSTANCES)
return (
template.render(reservations=reservations_resp, next_token=next_token)
.replace("True", "true")
.replace("False", "false")
)
def run_instances(self):
min_count = int(self._get_param("MinCount", if_none="1"))
image_id = self._get_param("ImageId")
owner_id = self._get_param("OwnerId")
user_data = self._get_param("UserData")
security_group_names = self._get_multi_param("SecurityGroup")
kwargs = {
"instance_type": self._get_param("InstanceType", if_none="m1.small"),
"placement": self._get_param("Placement.AvailabilityZone"),
"region_name": self.region,
"subnet_id": self._get_param("SubnetId"),
"owner_id": owner_id,
"key_name": self._get_param("KeyName"),
"security_group_ids": self._get_multi_param("SecurityGroupId"),
"nics": dict_from_querystring("NetworkInterface", self.querystring),
"private_ip": self._get_param("PrivateIpAddress"),
"associate_public_ip": self._get_param("AssociatePublicIpAddress"),
"tags": self._parse_tag_specification("TagSpecification"),
"ebs_optimized": self._get_param("EbsOptimized") or False,
"instance_initiated_shutdown_behavior": self._get_param(
"InstanceInitiatedShutdownBehavior"
),
}
mappings = self._parse_block_device_mapping()
if mappings:
kwargs["block_device_mappings"] = mappings
if self.is_not_dryrun("RunInstance"):
new_reservation = self.ec2_backend.add_instances(
image_id, min_count, user_data, security_group_names, **kwargs
)
template = self.response_template(EC2_RUN_INSTANCES)
return template.render(reservation=new_reservation)
def terminate_instances(self):
instance_ids = self._get_multi_param("InstanceId")
if self.is_not_dryrun("TerminateInstance"):
instances = self.ec2_backend.terminate_instances(instance_ids)
autoscaling_backends[self.region].notify_terminate_instances(instance_ids)
elbv2_backends[self.region].notify_terminate_instances(instance_ids)
template = self.response_template(EC2_TERMINATE_INSTANCES)
return template.render(instances=instances)
def reboot_instances(self):
instance_ids = self._get_multi_param("InstanceId")
if self.is_not_dryrun("RebootInstance"):
instances = self.ec2_backend.reboot_instances(instance_ids)
template = self.response_template(EC2_REBOOT_INSTANCES)
return template.render(instances=instances)
def stop_instances(self):
instance_ids = self._get_multi_param("InstanceId")
if self.is_not_dryrun("StopInstance"):
instances = self.ec2_backend.stop_instances(instance_ids)
template = self.response_template(EC2_STOP_INSTANCES)
return template.render(instances=instances)
def start_instances(self):
instance_ids = self._get_multi_param("InstanceId")
if self.is_not_dryrun("StartInstance"):
instances = self.ec2_backend.start_instances(instance_ids)
template = self.response_template(EC2_START_INSTANCES)
return template.render(instances=instances)
def _get_list_of_dict_params(self, param_prefix, _dct):
"""
Simplified version of _get_dict_param
Allows you to pass in a custom dict instead of using self.querystring by default
"""
params = []
for key, value in _dct.items():
if key.startswith(param_prefix):
params.append(value)
return params
def describe_instance_status(self):
instance_ids = self._get_multi_param("InstanceId")
include_all_instances = self._get_param("IncludeAllInstances") == "true"
filters = self._get_list_prefix("Filter")
filters = [
{"name": f["name"], "values": self._get_list_of_dict_params("value.", f)}
for f in filters
]
if instance_ids:
instances = self.ec2_backend.get_multi_instances_by_id(
instance_ids, filters
)
elif include_all_instances:
instances = self.ec2_backend.all_instances(filters)
else:
instances = self.ec2_backend.all_running_instances(filters)
template = self.response_template(EC2_INSTANCE_STATUS)
return template.render(instances=instances)
def describe_instance_types(self):
instance_types = [
InstanceType(name="t1.micro", cores=1, memory=644874240, disk=0)
]
template = self.response_template(EC2_DESCRIBE_INSTANCE_TYPES)
return template.render(instance_types=instance_types)
def describe_instance_attribute(self):
# TODO this and modify below should raise IncorrectInstanceState if
# instance not in stopped state
attribute = self._get_param("Attribute")
instance_id = self._get_param("InstanceId")
instance, value = self.ec2_backend.describe_instance_attribute(
instance_id, attribute
)
if attribute == "groupSet":
template = self.response_template(EC2_DESCRIBE_INSTANCE_GROUPSET_ATTRIBUTE)
else:
template = self.response_template(EC2_DESCRIBE_INSTANCE_ATTRIBUTE)
return template.render(instance=instance, attribute=attribute, value=value)
def describe_instance_credit_specifications(self):
instance_ids = self._get_multi_param("InstanceId")
instance = self.ec2_backend.describe_instance_credit_specifications(
instance_ids
)
template = self.response_template(EC2_DESCRIBE_INSTANCE_CREDIT_SPECIFICATIONS)
return template.render(instances=instance)
def modify_instance_attribute(self):
handlers = [
self._dot_value_instance_attribute_handler,
self._block_device_mapping_handler,
self._security_grp_instance_attribute_handler,
]
for handler in handlers:
success = handler()
if success:
return success
msg = (
"This specific call to ModifyInstanceAttribute has not been"
" implemented in Moto yet. Feel free to open an issue at"
" https://github.com/spulec/moto/issues"
)
raise NotImplementedError(msg)
def _block_device_mapping_handler(self):
"""
Handles requests which are generated by code similar to:
instance.modify_attribute(
BlockDeviceMappings=[{
'DeviceName': '/dev/sda1',
'Ebs': {'DeleteOnTermination': True}
}]
)
The querystring contains information similar to:
BlockDeviceMapping.1.Ebs.DeleteOnTermination : ['true']
BlockDeviceMapping.1.DeviceName : ['/dev/sda1']
For now we only support the "BlockDeviceMapping.1.Ebs.DeleteOnTermination"
configuration, but it should be trivial to add anything else.
"""
mapping_counter = 1
mapping_device_name_fmt = "BlockDeviceMapping.%s.DeviceName"
mapping_del_on_term_fmt = "BlockDeviceMapping.%s.Ebs.DeleteOnTermination"
while True:
mapping_device_name = mapping_device_name_fmt % mapping_counter
if mapping_device_name not in self.querystring.keys():
break
mapping_del_on_term = mapping_del_on_term_fmt % mapping_counter
del_on_term_value_str = self.querystring[mapping_del_on_term][0]
del_on_term_value = True if "true" == del_on_term_value_str else False
device_name_value = self.querystring[mapping_device_name][0]
instance_id = self._get_param("InstanceId")
instance = self.ec2_backend.get_instance(instance_id)
if self.is_not_dryrun("ModifyInstanceAttribute"):
block_device_type = instance.block_device_mapping[device_name_value]
block_device_type.delete_on_termination = del_on_term_value
# +1 for the next device
mapping_counter += 1
if mapping_counter > 1:
return EC2_MODIFY_INSTANCE_ATTRIBUTE
def _dot_value_instance_attribute_handler(self):
attribute_key = None
for key, value in self.querystring.items():
if ".Value" in key:
attribute_key = key
break
if not attribute_key:
return
if self.is_not_dryrun("Modify" + attribute_key.split(".")[0]):
value = self.querystring.get(attribute_key)[0]
normalized_attribute = camelcase_to_underscores(attribute_key.split(".")[0])
instance_id = self._get_param("InstanceId")
self.ec2_backend.modify_instance_attribute(
instance_id, normalized_attribute, value
)
return EC2_MODIFY_INSTANCE_ATTRIBUTE
def _security_grp_instance_attribute_handler(self):
new_security_grp_list = []
for key, value in self.querystring.items():
if "GroupId." in key:
new_security_grp_list.append(self.querystring.get(key)[0])
instance_id = self._get_param("InstanceId")
if self.is_not_dryrun("ModifyInstanceSecurityGroups"):
self.ec2_backend.modify_instance_security_groups(
instance_id, new_security_grp_list
)
return EC2_MODIFY_INSTANCE_ATTRIBUTE
def _parse_block_device_mapping(self):
device_mappings = self._get_list_prefix("BlockDeviceMapping")
mappings = []
for device_mapping in device_mappings:
self._validate_block_device_mapping(device_mapping)
device_template = deepcopy(BLOCK_DEVICE_MAPPING_TEMPLATE)
device_template["VirtualName"] = device_mapping.get("virtual_name")
device_template["DeviceName"] = device_mapping.get("device_name")
device_template["Ebs"]["SnapshotId"] = device_mapping.get(
"ebs._snapshot_id"
)
device_template["Ebs"]["VolumeSize"] = device_mapping.get(
"ebs._volume_size"
)
device_template["Ebs"]["DeleteOnTermination"] = self._convert_to_bool(
device_mapping.get("ebs._delete_on_termination", False)
)
device_template["Ebs"]["VolumeType"] = device_mapping.get(
"ebs._volume_type"
)
device_template["Ebs"]["Iops"] = device_mapping.get("ebs._iops")
device_template["Ebs"]["Encrypted"] = self._convert_to_bool(
device_mapping.get("ebs._encrypted", False)
)
mappings.append(device_template)
return mappings
@staticmethod
def _validate_block_device_mapping(device_mapping):
if not any(mapping for mapping in device_mapping if mapping.startswith("ebs.")):
raise MissingParameterError("ebs")
if (
"ebs._volume_size" not in device_mapping
and "ebs._snapshot_id" not in device_mapping
):
raise MissingParameterError("size or snapshotId")
@staticmethod
def _convert_to_bool(bool_str):
if isinstance(bool_str, bool):
return bool_str
if isinstance(bool_str, six.text_type):
return str(bool_str).lower() == "true"
return False
BLOCK_DEVICE_MAPPING_TEMPLATE = {
"VirtualName": None,
"DeviceName": None,
"Ebs": {
"SnapshotId": None,
"VolumeSize": None,
"DeleteOnTermination": None,
"VolumeType": None,
"Iops": None,
"Encrypted": None,
},
}
EC2_RUN_INSTANCES = (
"""
59dbff89-35bd-4eac-99ed-be587EXAMPLE
{{ reservation.id }}
"""
+ ACCOUNT_ID
+ """
-
sg-245f6a01
default
{% for instance in reservation.instances %}
-
{{ instance.id }}
{{ instance.image_id }}
0
pending
{{ instance.private_dns }}
{{ instance.public_dns }}
{{ instance.public_dns }}
{{ instance.key_name }}
{{ instance.ebs_optimized }}
{{ instance.ami_launch_index }}
{{ instance.instance_type }}
{{ instance.launch_time }}
{{ instance.placement}}
default
enabled
{% if instance.subnet_id %}
{{ instance.subnet_id }}
{% elif instance.nics[0].subnet.id %}
{{ instance.nics[0].subnet.id }}
{% endif %}
{% if instance.vpc_id %}
{{ instance.vpc_id }}
{% elif instance.nics[0].subnet.vpc_id %}
{{ instance.nics[0].subnet.vpc_id }}
{% endif %}
{{ instance.private_ip }}
{% if instance.nics[0].public_ip %}
{{ instance.nics[0].public_ip }}
{% endif %}
{{ instance.source_dest_check }}
{% for group in instance.dynamic_group_list %}
-
{{ group.id }}
{{ group.name }}
{% endfor %}
{% if instance.platform %}
{{ instance.platform }}
{% endif %}
{{ instance.virtualization_type }}
{{ instance.architecture }}
{{ instance.kernel }}
xen
false
{% for tag in instance.get_tags() %}
-
{{ tag.key }}
{{ tag.value }}
{% endfor %}
{% for nic in instance.nics.values() %}
-
{{ nic.id }}
{% if nic.subnet %}
{{ nic.subnet.id }}
{{ nic.subnet.vpc_id }}
{% endif %}
Primary network interface
"""
+ ACCOUNT_ID
+ """
in-use
1b:2b:3c:4d:5e:6f
{{ nic.private_ip_address }}
{{ instance.source_dest_check }}
{% for group in nic.group_set %}
-
{{ group.id }}
{{ group.name }}
{% endfor %}
{{ nic.attachment_id }}
{{ nic.device_index }}
attached
2015-01-01T00:00:00Z
true
{% if nic.public_ip %}
{{ nic.public_ip }}
"""
+ ACCOUNT_ID
+ """
{% endif %}
-
{{ nic.private_ip_address }}
true
{% if nic.public_ip %}
{{ nic.public_ip }}
"""
+ ACCOUNT_ID
+ """
{% endif %}
{% endfor %}
{% endfor %}
"""
)
EC2_DESCRIBE_INSTANCES = (
"""
fdcdcab1-ae5c-489e-9c33-4637c5dda355
{% for reservation in reservations %}
-
{{ reservation.id }}
"""
+ ACCOUNT_ID
+ """
{% for group in reservation.dynamic_group_list %}
-
{% if group.id %}
{{ group.id }}
{{ group.name }}
{% else %}
{{ group }}
{% endif %}
{% endfor %}
{% for instance in reservation.instances %}
-
{{ instance.id }}
{{ instance.image_id }}
{{ instance._state.code }}
{{ instance._state.name }}
{{ instance.private_dns }}
{{ instance.public_dns }}
{{ instance.public_dns }}
{{ instance._reason }}
{{ instance.key_name }}
{{ instance.ebs_optimized }}
{{ instance.ami_launch_index }}
{{ instance.instance_type }}
{{ instance.launch_time }}
{{ instance.placement }}
default
{% if instance.platform %}
{{ instance.platform }}
{% endif %}
disabled
{% if instance.subnet_id %}
{{ instance.subnet_id }}
{% elif instance.nics[0].subnet.id %}
{{ instance.nics[0].subnet.id }}
{% endif %}
{% if instance.vpc_id %}
{{ instance.vpc_id }}
{% elif instance.nics[0].subnet.vpc_id %}
{{ instance.nics[0].subnet.vpc_id }}
{% endif %}
{{ instance.private_ip }}
{% if instance.nics[0].public_ip %}
{{ instance.nics[0].public_ip }}
{% endif %}
{{ instance.source_dest_check }}
{% for group in instance.dynamic_group_list %}
-
{% if group.id %}
{{ group.id }}
{{ group.name }}
{% else %}
{{ group }}
{% endif %}
{% endfor %}
{{ instance._state_reason.code }}
{{ instance._state_reason.message }}
{{ instance.architecture }}
{{ instance.kernel }}
ebs
/dev/sda1
{% for device_name,deviceobject in instance.get_block_device_mapping %}
-
{{ device_name }}
{{ deviceobject.volume_id }}
{{ deviceobject.status }}
{{ deviceobject.attach_time }}
{{ deviceobject.delete_on_termination }}
{{deviceobject.size}}
{% endfor %}
{{ instance.virtualization_type }}
ABCDE"""
+ ACCOUNT_ID
+ """3
{% if instance.get_tags() %}
{% for tag in instance.get_tags() %}
-
{{ tag.resource_id }}
{{ tag.resource_type }}
{{ tag.key }}
{{ tag.value }}
{% endfor %}
{% endif %}
xen
{% for nic in instance.nics.values() %}
-
{{ nic.id }}
{% if nic.subnet %}
{{ nic.subnet.id }}
{{ nic.subnet.vpc_id }}
{% endif %}
Primary network interface
"""
+ ACCOUNT_ID
+ """
in-use
1b:2b:3c:4d:5e:6f
{{ nic.private_ip_address }}
{{ instance.source_dest_check }}
{% for group in nic.group_set %}
-
{% if group.id %}
{{ group.id }}
{{ group.name }}
{% else %}
{{ group }}
{% endif %}
{% endfor %}
{{ nic.attachment_id }}
{{ nic.device_index }}
attached
2015-01-01T00:00:00Z
true
{% if nic.public_ip %}
{{ nic.public_ip }}
"""
+ ACCOUNT_ID
+ """
{% endif %}
-
{{ nic.private_ip_address }}
true
{% if nic.public_ip %}
{{ nic.public_ip }}
"""
+ ACCOUNT_ID
+ """
{% endif %}
{% endfor %}
{% endfor %}
{% endfor %}
{% if next_token %}
{{ next_token }}
{% endif %}
"""
)
EC2_TERMINATE_INSTANCES = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
{% for instance in instances %}
-
{{ instance.id }}
16
running
32
shutting-down
{% endfor %}
"""
EC2_STOP_INSTANCES = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
{% for instance in instances %}
-
{{ instance.id }}
16
running
64
stopping
{% endfor %}
"""
EC2_START_INSTANCES = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
{% for instance in instances %}
-
{{ instance.id }}
16
running
0
pending
{% endfor %}
"""
EC2_REBOOT_INSTANCES = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
true
"""
EC2_DESCRIBE_INSTANCE_ATTRIBUTE = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
{{ instance.id }}
<{{ attribute }}>
{% if value is not none %}
{{ value }}
{% endif %}
{{ attribute }}>
"""
EC2_DESCRIBE_INSTANCE_CREDIT_SPECIFICATIONS = """
1b234b5c-d6ef-7gh8-90i1-j2345678901
{% for instance in instances %}
-
{{ instance.id }}
standard
{% endfor %}
"""
EC2_DESCRIBE_INSTANCE_GROUPSET_ATTRIBUTE = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
{{ instance.id }}
<{{ attribute }}>
{% for sg in value %}
-
{{ sg.id }}
{% endfor %}
{{ attribute }}>
"""
EC2_MODIFY_INSTANCE_ATTRIBUTE = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
true
"""
EC2_INSTANCE_STATUS = """
59dbff89-35bd-4eac-99ed-be587EXAMPLE
{% for instance in instances %}
-
{{ instance.id }}
{{ instance.placement }}
{{ instance.state_code }}
{{ instance.state }}
{% if instance.state_code == 16 %}
ok
-
reachability
passed
ok
-
reachability
passed
{% else %}
not-applicable
not-applicable
{% endif %}
{% endfor %}
"""
EC2_DESCRIBE_INSTANCE_TYPES = """
f8b86168-d034-4e65-b48d-3b84c78e64af
{% for instance_type in instance_types %}
-
{{ instance_type.name }}
{{ instance_type.cores }}
{{ instance_type.cores }}
1
{{ instance_type.memory }}
{{ instance_type.disk }}
-
x86_64
{% endfor %}
"""