Source code for

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

from functools import cached_property
from typing import TYPE_CHECKING, Any, Sequence

from airflow.configuration import conf
from airflow.exceptions import AirflowException, AirflowSkipException
from import EC2Hook
from import EC2StateSensorTrigger
from airflow.sensors.base import BaseSensorOperator

    from airflow.utils.context import Context

[docs]class EC2InstanceStateSensor(BaseSensorOperator): """ Poll the state of the AWS EC2 instance until the instance reaches the target state. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:EC2InstanceStateSensor` :param target_state: target state of instance :param instance_id: id of the AWS EC2 instance :param region_name: (optional) aws region name associated with the client :param deferrable: if True, the sensor will run in deferrable mode """
[docs] template_fields: Sequence[str] = ("target_state", "instance_id", "region_name")
[docs] ui_color = "#cc8811"
[docs] ui_fgcolor = "#ffffff"
[docs] valid_states = ["running", "stopped", "terminated"]
def __init__( self, *, target_state: str, instance_id: str, aws_conn_id: str = "aws_default", region_name: str | None = None, deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False), **kwargs, ): if target_state not in self.valid_states: raise ValueError(f"Invalid target_state: {target_state}") super().__init__(**kwargs) self.target_state = target_state self.instance_id = instance_id self.aws_conn_id = aws_conn_id self.region_name = region_name self.deferrable = deferrable
[docs] def execute(self, context: Context) -> Any: if self.deferrable: self.defer( trigger=EC2StateSensorTrigger( instance_id=self.instance_id, target_state=self.target_state, aws_conn_id=self.aws_conn_id, region_name=self.region_name, poll_interval=int(self.poke_interval), ), method_name="execute_complete", ) else: super().execute(context=context)
[docs] def hook(self): return EC2Hook(aws_conn_id=self.aws_conn_id, region_name=self.region_name)
[docs] def poke(self, context: Context): instance_state = self.hook.get_instance_state(instance_id=self.instance_id)"instance state: %s", instance_state) return instance_state == self.target_state
[docs] def execute_complete(self, context, event=None): if event["status"] != "success": # TODO: remove this if check when min_airflow_version is set to higher than 2.7.1 message = f"Error: {event}" if self.soft_fail: raise AirflowSkipException(message) raise AirflowException(message) return

Was this entry helpful?