airflow.providers.amazon.aws.hooks.elasticache_replication_group
¶
Module Contents¶
Classes¶
Interact with Amazon ElastiCache. |
- class airflow.providers.amazon.aws.hooks.elasticache_replication_group.ElastiCacheReplicationGroupHook(max_retries=10, exponential_back_off_factor=1, initial_poke_interval=60, *args, **kwargs)[source]¶
Bases:
airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook
Interact with Amazon ElastiCache.
Provide thick wrapper around
boto3.client("elasticache")
.- Parameters
max_retries (int) – Max retries for checking availability of and deleting replication group If this is not supplied then this is defaulted to 10
exponential_back_off_factor (float) – Multiplication factor for deciding next sleep time If this is not supplied then this is defaulted to 1
initial_poke_interval (float) – Initial sleep time in seconds If this is not supplied then this is defaulted to 60 seconds
Additional arguments (such as
aws_conn_id
) may be specified and are passed down to the underlying AwsBaseHook.- create_replication_group(config)[source]¶
Create a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
- describe_replication_group(replication_group_id)[source]¶
Get information about a particular replication group.
- get_replication_group_status(replication_group_id)[source]¶
Get current status of replication group.
- is_replication_group_available(replication_group_id)[source]¶
Check if replication group is available or not.
- wait_for_availability(replication_group_id, initial_sleep_time=None, exponential_back_off_factor=None, max_retries=None)[source]¶
Check if replication group is available or not by performing a describe over it.
- Parameters
replication_group_id (str) – ID of replication group to check for availability
initial_sleep_time (float | None) – Initial sleep time in seconds If this is not supplied then this is defaulted to class level value
exponential_back_off_factor (float | None) – Multiplication factor for deciding next sleep time If this is not supplied then this is defaulted to class level value
max_retries (int | None) – Max retries for checking availability of replication group If this is not supplied then this is defaulted to class level value
- Returns
True if replication is available else False
- Return type
- wait_for_deletion(replication_group_id, initial_sleep_time=None, exponential_back_off_factor=None, max_retries=None)[source]¶
Delete a replication group ensuring it is either deleted or can’t be deleted.
- Parameters
replication_group_id (str) – ID of replication to delete
initial_sleep_time (float | None) – Initial sleep time in second If this is not supplied then this is defaulted to class level value
exponential_back_off_factor (float | None) – Multiplication factor for deciding next sleep time If this is not supplied then this is defaulted to class level value
max_retries (int | None) – Max retries for checking availability of replication group If this is not supplied then this is defaulted to class level value
- Returns
Response from ElastiCache delete replication group API and flag to identify if deleted or not
- ensure_delete_replication_group(replication_group_id, initial_sleep_time=None, exponential_back_off_factor=None, max_retries=None)[source]¶
Delete a replication group ensuring it is either deleted or can’t be deleted.
- Parameters
replication_group_id (str) – ID of replication to delete
initial_sleep_time (float | None) – Initial sleep time in second If this is not supplied then this is defaulted to class level value
exponential_back_off_factor (float | None) – Multiplication factor for deciding next sleep time If this is not supplied then this is defaulted to class level value
max_retries (int | None) – Max retries for checking availability of replication group If this is not supplied then this is defaulted to class level value
- Returns
Response from ElastiCache delete replication group API
- Raises
AirflowException – If replication group is not deleted
- Return type