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, Sequence

from deprecated import deprecated

from airflow.exceptions import AirflowProviderDeprecationWarning
from import RedshiftHook
from airflow.sensors.base import BaseSensorOperator

    from airflow.utils.context import Context

[docs]class RedshiftClusterSensor(BaseSensorOperator): """ Waits for a Redshift cluster to reach a specific status. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:RedshiftClusterSensor` :param cluster_identifier: The identifier for the cluster being pinged. :param target_status: The cluster status desired. """
[docs] template_fields: Sequence[str] = ("cluster_identifier", "target_status")
def __init__( self, *, cluster_identifier: str, target_status: str = "available", aws_conn_id: str = "aws_default", **kwargs, ): super().__init__(**kwargs) self.cluster_identifier = cluster_identifier self.target_status = target_status self.aws_conn_id = aws_conn_id
[docs] def poke(self, context: Context): current_status = self.hook.cluster_status(self.cluster_identifier) "Poked cluster %s for status '%s', found status '%s'", self.cluster_identifier, self.target_status, current_status, ) return current_status == self.target_status
@deprecated(reason="use `hook` property instead.", category=AirflowProviderDeprecationWarning)
[docs] def get_hook(self) -> RedshiftHook: """Create and return a RedshiftHook.""" return self.hook
[docs] def hook(self) -> RedshiftHook: return RedshiftHook(aws_conn_id=self.aws_conn_id)

Was this entry helpful?