airflow.providers.amazon.aws.triggers.rds

Module Contents

Classes

RdsDbInstanceTrigger

Deprecated Trigger for RDS operations. Do not use.

RdsDbAvailableTrigger

Trigger to wait asynchronously for a DB instance or cluster to be available.

RdsDbDeletedTrigger

Trigger to wait asynchronously for a DB instance or cluster to be deleted.

RdsDbStoppedTrigger

Trigger to wait asynchronously for a DB instance or cluster to be stopped.
class airflow.providers.amazon.aws.triggers.rds.RdsDbInstanceTrigger(waiter_name, db_instance_identifier, waiter_delay, waiter_max_attempts, aws_conn_id, region_name, response)[source]

Bases: airflow.triggers.base.BaseTrigger

Deprecated Trigger for RDS operations. Do not use.

Parameters

  • waiter_name (str) – Name of the waiter to use, for instance ‘db_instance_available’ or ‘db_instance_deleted’.

  • db_instance_identifier (str) – The DB instance identifier for the DB instance to be polled.

  • waiter_delay (int) – The amount of time in seconds to wait between attempts.

  • waiter_max_attempts (int) – The maximum number of attempts to be made.

  • aws_conn_id (str | None) – The Airflow connection used for AWS credentials.

  • region_name (str | None) – AWS region where the DB is located, if different from the default one.

  • response (dict[str, Any]) – The response from the RdsHook, to be passed back to the operator.

serialize()[source]

Return the information needed to reconstruct this Trigger.

Returns

Tuple of (class path, keyword arguments needed to re-instantiate).

Return type

tuple[str, dict[str, Any]]

hook()[source]
async run()[source]

Run the trigger in an asynchronous context.

The trigger should yield an Event whenever it wants to fire off an event, and return None if it is finished. Single-event triggers should thus yield and then immediately return.

If it yields, it is likely that it will be resumed very quickly, but it may not be (e.g. if the workload is being moved to another triggerer process, or a multi-event trigger was being used for a single-event task defer).

In either case, Trigger classes should assume they will be persisted, and then rely on cleanup() being called when they are no longer needed.

class airflow.providers.amazon.aws.triggers.rds.RdsDbAvailableTrigger(db_identifier, waiter_delay, waiter_max_attempts, aws_conn_id, response, db_type, region_name=None)[source]

Bases: airflow.providers.amazon.aws.triggers.base.AwsBaseWaiterTrigger

Trigger to wait asynchronously for a DB instance or cluster to be available.

Parameters

  • db_identifier (str) – The DB identifier for the DB instance or cluster to be polled.

  • waiter_delay (int) – The amount of time in seconds to wait between attempts.

  • waiter_max_attempts (int) – The maximum number of attempts to be made.

  • aws_conn_id (str | None) – The Airflow connection used for AWS credentials.

  • region_name (str | None) – AWS region where the DB is located, if different from the default one.

  • response (dict[str, Any]) – The response from the RdsHook, to be passed back to the operator.

  • db_type (airflow.providers.amazon.aws.utils.rds.RdsDbType | str) – The type of DB: instance or cluster.

hook()[source]

Override in subclasses to return the right hook.

class airflow.providers.amazon.aws.triggers.rds.RdsDbDeletedTrigger(db_identifier, waiter_delay, waiter_max_attempts, aws_conn_id, response, db_type, region_name=None)[source]

Bases: airflow.providers.amazon.aws.triggers.base.AwsBaseWaiterTrigger

Trigger to wait asynchronously for a DB instance or cluster to be deleted.

Parameters

  • db_identifier (str) – The DB identifier for the DB instance or cluster to be polled.

  • waiter_delay (int) – The amount of time in seconds to wait between attempts.

  • waiter_max_attempts (int) – The maximum number of attempts to be made.

  • aws_conn_id (str | None) – The Airflow connection used for AWS credentials.

  • region_name (str | None) – AWS region where the DB is located, if different from the default one.

  • response (dict[str, Any]) – The response from the RdsHook, to be passed back to the operator.

  • db_type (airflow.providers.amazon.aws.utils.rds.RdsDbType | str) – The type of DB: instance or cluster.

hook()[source]

Override in subclasses to return the right hook.

class airflow.providers.amazon.aws.triggers.rds.RdsDbStoppedTrigger(db_identifier, waiter_delay, waiter_max_attempts, aws_conn_id, response, db_type, region_name=None)[source]

Bases: airflow.providers.amazon.aws.triggers.base.AwsBaseWaiterTrigger

Trigger to wait asynchronously for a DB instance or cluster to be stopped.

Parameters

  • db_identifier (str) – The DB identifier for the DB instance or cluster to be polled.

  • waiter_delay (int) – The amount of time in seconds to wait between attempts.

  • waiter_max_attempts (int) – The maximum number of attempts to be made.

  • aws_conn_id (str | None) – The Airflow connection used for AWS credentials.

  • region_name (str | None) – AWS region where the DB is located, if different from the default one.

  • response (dict[str, Any]) – The response from the RdsHook, to be passed back to the operator.

  • db_type (airflow.providers.amazon.aws.utils.rds.RdsDbType | str) – The type of DB: instance or cluster.

hook()[source]

Override in subclasses to return the right hook.

Was this entry helpful?