blob: 983815175edfb7e91ccb1ec3854b29a8adb69307 [file] [log] [blame]
:py:mod:`airflow.providers.amazon.aws.sensors.rds`
==================================================
.. py:module:: airflow.providers.amazon.aws.sensors.rds
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.amazon.aws.sensors.rds.RdsSnapshotExistenceSensor
airflow.providers.amazon.aws.sensors.rds.RdsExportTaskExistenceSensor
.. py:class:: RdsSnapshotExistenceSensor(*, db_type, db_snapshot_identifier, target_statuses = None, aws_conn_id = 'aws_conn_id', **kwargs)
Bases: :py:obj:`RdsBaseSensor`
Waits for RDS snapshot with a specific status.
.. seealso::
For more information on how to use this sensor, take a look at the guide:
:ref:`howto/sensor:RdsSnapshotExistenceSensor`
:param db_type: Type of the DB - either "instance" or "cluster"
:param db_snapshot_identifier: The identifier for the DB snapshot
:param target_statuses: Target status of snapshot
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['db_snapshot_identifier', 'target_statuses']
.. py:method:: poke(self, context)
Function that the sensors defined while deriving this class should
override.
.. py:class:: RdsExportTaskExistenceSensor(*, export_task_identifier, target_statuses = None, aws_conn_id = 'aws_default', **kwargs)
Bases: :py:obj:`RdsBaseSensor`
Waits for RDS export task with a specific status.
.. seealso::
For more information on how to use this sensor, take a look at the guide:
:ref:`howto/sensor:RdsExportTaskExistenceSensor`
:param export_task_identifier: A unique identifier for the snapshot export task.
:param target_statuses: Target status of export task
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['export_task_identifier', 'target_statuses']
.. py:method:: poke(self, context)
Function that the sensors defined while deriving this class should
override.