基类: airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook
与 Amazon ElastiCache 交互。
提供 boto3.client("elasticache")
的厚包装。
- 参数
max_retries (int) – 用于检查复制组的可用性和删除的最大重试次数。如果未提供,则默认为 10
exponential_back_off_factor (float) – 用于决定下一次休眠时间的乘法因子。如果未提供,则默认为 1
initial_poke_interval (float) – 初始休眠时间(秒)。如果未提供,则默认为 60 秒
可以指定其他参数(例如 aws_conn_id
),这些参数将传递给底层 AwsBaseHook。
-
TERMINAL_STATES[源代码]
-
create_replication_group(config)[源代码]
创建 Redis (禁用集群模式) 或 Redis (启用集群模式) 复制组。
- 参数
config (dict) – 用于创建复制组的配置
- 返回
来自 ElastiCache 创建复制组 API 的响应
- 返回类型
dict
-
delete_replication_group(replication_group_id)[源代码]
删除现有复制组。
- 参数
replication_group_id (str) – 要删除的复制组的 ID
- 返回
来自 ElastiCache 删除复制组 API 的响应
- 返回类型
dict
-
describe_replication_group(replication_group_id)[源代码]
获取有关特定复制组的信息。
- 参数
replication_group_id (str) – 要描述的复制组的 ID
- 返回
来自 ElastiCache 描述复制组 API 的响应
- 返回类型
dict
-
get_replication_group_status(replication_group_id)[源代码]
获取复制组的当前状态。
- 参数
replication_group_id (str) – 要检查状态的复制组的 ID
- 返回
复制组的当前状态
- 返回类型
str
-
is_replication_group_available(replication_group_id)[源代码]
检查复制组是否可用。
- 参数
replication_group_id (str) – 要检查可用性的复制组的 ID
- 返回
如果可用,则为 True,否则为 False
- 返回类型
bool
-
wait_for_availability(replication_group_id, initial_sleep_time=None, exponential_back_off_factor=None, max_retries=None)[源代码]
通过对其执行描述来检查复制组是否可用。
- 参数
replication_group_id (str) – 要检查可用性的复制组的 ID
initial_sleep_time (float | None) – 初始休眠时间(秒)。如果未提供,则默认为类级别值
exponential_back_off_factor (float | None) – 用于决定下一次休眠时间的乘法因子。如果未提供,则默认为类级别值
max_retries (int | None) – 用于检查复制组可用性的最大重试次数。如果未提供,则默认为类级别值
- 返回
如果复制可用,则为 True,否则为 False
- 返回类型
bool
-
wait_for_deletion(replication_group_id, initial_sleep_time=None, exponential_back_off_factor=None, max_retries=None)[source]
删除复制组,确保它已被删除或无法删除。
- 参数
replication_group_id ( str ) – 要删除的复制组的 ID。
initial_sleep_time ( float | None ) – 初始休眠时间,以秒为单位。如果未提供,则默认为类级别值。
exponential_back_off_factor (float | None) – 用于决定下一次休眠时间的乘法因子。如果未提供,则默认为类级别值
max_retries (int | None) – 用于检查复制组可用性的最大重试次数。如果未提供,则默认为类级别值
- 返回
来自 ElastiCache 删除复制组 API 的响应以及标识是否已删除的标志。
-
ensure_delete_replication_group(replication_group_id, initial_sleep_time=None, exponential_back_off_factor=None, max_retries=None)[source]
删除复制组,确保它已被删除或无法删除。
- 参数
replication_group_id ( str ) – 要删除的复制组的 ID。
initial_sleep_time ( float | None ) – 初始休眠时间,以秒为单位。如果未提供,则默认为类级别值。
exponential_back_off_factor (float | None) – 用于决定下一次休眠时间的乘法因子。如果未提供,则默认为类级别值
max_retries (int | None) – 用于检查复制组可用性的最大重试次数。如果未提供,则默认为类级别值
- 返回
来自 ElastiCache 删除复制组 API 的响应
- 引发
AirflowException – 如果复制组未被删除。
- 返回类型
dict