airflow.providers.amazon.aws.sensors.rds

Classes

RdsSnapshotExistenceSensor

Waits for RDS snapshot with a specific status.

RdsExportTaskExistenceSensor

Waits for RDS export task with a specific status.

RdsDbSensor

Waits for an RDS instance or cluster to enter one of a number of states.

Module Contents

class airflow.providers.amazon.aws.sensors.rds.RdsSnapshotExistenceSensor(*, db_type, db_snapshot_identifier, target_statuses=None, **kwargs)[source]

Bases: RdsBaseSensor

Waits for RDS snapshot with a specific status.

See also

For more information on how to use this sensor, take a look at the guide: Wait on an Amazon RDS snapshot status

Parameters:

  • db_type (str) – Type of the DB - either “instance” or “cluster”

  • db_snapshot_identifier (str) – The identifier for the DB snapshot

  • target_statuses (list[str] | None) – Target status of snapshot

  • aws_conn_id – The Airflow connection used for AWS credentials. If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node).

  • region_name – AWS region_name. If not specified then the default boto3 behaviour is used.

  • verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html

  • botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields: collections.abc.Sequence[str][source]
db_type[source]
db_snapshot_identifier[source]
target_statuses = ['available'][source]
poke(context)[source]

Override when deriving this class.

class airflow.providers.amazon.aws.sensors.rds.RdsExportTaskExistenceSensor(*, export_task_identifier, target_statuses=None, error_statuses=None, **kwargs)[source]

Bases: RdsBaseSensor

Waits for RDS export task with a specific status.

See also

For more information on how to use this sensor, take a look at the guide: Wait on an Amazon RDS export task status

Parameters:

  • export_task_identifier (str) – A unique identifier for the snapshot export task.

  • target_statuses (list[str] | None) – Target status of export task

  • error_statuses (list[str] | None) – Target error status of export task to fail the sensor

template_fields: collections.abc.Sequence[str][source]
export_task_identifier[source]
target_statuses = ['starting', 'in_progress', 'complete', 'canceling', 'canceled'][source]
error_statuses = ['failed'][source]
poke(context)[source]

Override when deriving this class.

class airflow.providers.amazon.aws.sensors.rds.RdsDbSensor(*, db_identifier, db_type=RdsDbType.INSTANCE, target_statuses=None, **kwargs)[source]

Bases: RdsBaseSensor

Waits for an RDS instance or cluster to enter one of a number of states.

See also

For more information on how to use this sensor, take a look at the guide: Wait on an Amazon RDS instance or cluster status

Parameters:
template_fields: collections.abc.Sequence[str][source]
db_identifier[source]
target_statuses = ['available'][source]
db_type[source]
poke(context)[source]

Override when deriving this class.

Was this entry helpful?