airflow.providers.amazon.aws.operators.rds¶

类¶

`RdsCreateDbSnapshotOperator`	创建数据库实例或数据库集群的快照。
`RdsCopyDbSnapshotOperator`	复制指定的数据库实例或数据库集群快照。
`RdsDeleteDbSnapshotOperator`	删除数据库实例或集群快照，或终止复制操作。
`RdsStartExportTaskOperator`	开始将快照导出到 Amazon S3。提供的 IAM 角色必须具有访问 S3 存储桶的权限。
`RdsCancelExportTaskOperator`	取消正在进行中的、将快照导出到 Amazon S3 的导出任务。
`RdsCreateEventSubscriptionOperator`	创建 RDS 事件通知订阅。
`RdsDeleteEventSubscriptionOperator`	删除 RDS 事件通知订阅。
`RdsCreateDbInstanceOperator`	创建 RDS 数据库实例。
`RdsDeleteDbInstanceOperator`	删除 RDS 数据库实例。
`RdsStartDbOperator`	启动 RDS 数据库实例/集群。
`RdsStopDbOperator`	停止 RDS 数据库实例/集群。

模块内容¶

class airflow.providers.amazon.aws.operators.rds.RdsCreateDbSnapshotOperator(*, db_type, db_identifier, db_snapshot_identifier, tags=None, wait_for_completion=True, **kwargs)[source]¶

基础：RdsBaseOperator

创建数据库实例或数据库集群的快照。

源数据库实例或集群必须处于可用或存储优化状态。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：创建数据库快照

参数:

db_type (str) – 数据库类型 - “instance”或“cluster”
db_identifier (str) – 要创建快照的实例或集群的标识符
db_snapshot_identifier (str) – 数据库快照的标识符
tags (collections.abc.Sequence[mypy_boto3_rds.type_defs.TagTypeDef] | dict | None) – 标签字典或格式为 [{“Key”: “…”, “Value”: “…”},] 的标签列表 USER Tagging
wait_for_completion (bool) – 如果为 True，则等待数据库快照创建完成。（默认值：True）
aws_conn_id – 用于 AWS 凭证的 Airflow 连接。如果此参数为 None 或为空，则使用默认的 boto3 行为。如果在分布式环境中运行 Airflow 且 aws_conn_id 为 None 或为空，则将使用默认的 boto3 配置（且必须在每个工作节点上维护）。
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[source]¶

db_type[source]¶

db_identifier[source]¶

db_snapshot_identifier[source]¶

tags = None[source]¶

wait_for_completion = True[source]¶

execute(context)[source]¶

快照、任务和事件的不同实现。

class airflow.providers.amazon.aws.operators.rds.RdsCopyDbSnapshotOperator(*, db_type, source_db_snapshot_identifier, target_db_snapshot_identifier, kms_key_id='', tags=None, copy_tags=False, pre_signed_url='', option_group_name='', target_custom_availability_zone='', source_region='', wait_for_completion=True, **kwargs)[source]¶

基础：RdsBaseOperator

复制指定的数据库实例或数据库集群快照。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：复制数据库快照

参数:

db_type (str) – 数据库类型 - “instance”或“cluster”
source_db_snapshot_identifier (str) – 源快照的标识符
target_db_snapshot_identifier (str) – 目标快照的标识符
kms_key_id (str) – 加密数据库快照的 AWS KMS 密钥标识符
tags (collections.abc.Sequence[mypy_boto3_rds.type_defs.TagTypeDef] | dict | None) – 标签字典或格式为 [{“Key”: “…”, “Value”: “…”},] 的标签列表 USER Tagging
copy_tags (bool) – 是否将源快照的所有标签复制到目标快照（默认值 False）
pre_signed_url (str) – 包含签名版本 4 签名请求的 URL
option_group_name (str) – 与快照副本关联的选项组名称仅当 db_type=’instance’ 时有效
target_custom_availability_zone (str) – 目标外部自定义可用区标识符仅当 db_type=’instance’ 时有效
source_region (str) – 包含要复制的快照的区域 ID
wait_for_completion (bool) – 如果为 True，则等待快照复制完成。（默认值：True）
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[source]¶

db_type[source]¶

source_db_snapshot_identifier[source]¶

target_db_snapshot_identifier[source]¶

kms_key_id = ''[source]¶

tags = None[source]¶

copy_tags = False[source]¶

pre_signed_url = ''[source]¶

option_group_name = ''[source]¶

target_custom_availability_zone = ''[source]¶

source_region = ''[source]¶

wait_for_completion = True[source]¶

execute(context)[source]¶

快照、任务和事件的不同实现。

class airflow.providers.amazon.aws.operators.rds.RdsDeleteDbSnapshotOperator(*, db_type, db_snapshot_identifier, wait_for_completion=True, **kwargs)[source]¶

基础：RdsBaseOperator

删除数据库实例或集群快照，或终止复制操作。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：删除数据库快照

参数:

db_type (str) – 数据库类型 - “instance”或“cluster”
db_snapshot_identifier (str) – 数据库实例或数据库集群快照的标识符
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[source]¶

db_type[source]¶

db_snapshot_identifier[source]¶

wait_for_completion = True[source]¶

execute(context)[source]¶

快照、任务和事件的不同实现。

class airflow.providers.amazon.aws.operators.rds.RdsStartExportTaskOperator(*, export_task_identifier, source_arn, s3_bucket_name, iam_role_arn, kms_key_id, s3_prefix='', export_only=None, wait_for_completion=True, waiter_interval=30, waiter_max_attempts=40, **kwargs)[source]¶

基础：RdsBaseOperator

开始将快照导出到 Amazon S3。提供的 IAM 角色必须具有访问 S3 存储桶的权限。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：将 Amazon RDS 快照导出到 Amazon S3

参数:

export_task_identifier (str) – 快照导出任务的唯一标识符。
source_arn (str) – 要导出到 Amazon S3 的快照的 Amazon Resource Name (ARN)。
s3_bucket_name (str) – 要将快照导出到的 Amazon S3 存储桶的名称。
iam_role_arn (str) – 用于写入 Amazon S3 存储桶的 IAM 角色名称。
kms_key_id (str) – 用于加密快照的 Amazon Web Services KMS 密钥 ID。
s3_prefix (str) – 用作导出快照的文件名和路径的 Amazon S3 存储桶前缀。
export_only (list[str] | None) – 要从快照导出的数据。
wait_for_completion (bool) – 如果为 True，则等待数据库快照导出完成。（默认值：True）
waiter_interval (int) – 检查导出状态之前等待的秒数。（默认值：30）
waiter_max_attempts (int) – 失败前尝试的最大次数。（默认值：40）
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[source]¶

export_task_identifier[source]¶

source_arn[source]¶

s3_bucket_name[source]¶

iam_role_arn[source]¶

kms_key_id[source]¶

s3_prefix = ''[source]¶

export_only = [][source]¶

wait_for_completion = True[source]¶

waiter_interval = 30[source]¶

waiter_max_attempts = 40[source]¶

execute(context)[source]¶

快照、任务和事件的不同实现。

class airflow.providers.amazon.aws.operators.rds.RdsCancelExportTaskOperator(*, export_task_identifier, wait_for_completion=True, check_interval=30, max_attempts=40, **kwargs)[source]¶

基础：RdsBaseOperator

取消正在进行中的、将快照导出到 Amazon S3 的导出任务。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南：取消 Amazon RDS 导出任务

参数:

export_task_identifier (str) – 要取消的快照导出任务的标识符
wait_for_completion (bool) – 如果为 True，则等待数据库快照导出任务取消。（默认值：True）
check_interval (int) – 尝试之间等待的秒数
max_attempts (int) – 最大尝试次数
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[source]¶

export_task_identifier[源代码]¶

wait_for_completion = True[源代码]¶

check_interval = 30[源代码]¶

max_attempts = 40[源代码]¶

execute(context)[源代码]¶

快照、任务和事件的不同实现。

类 airflow.providers.amazon.aws.operators.rds.RdsCreateEventSubscriptionOperator(*, subscription_name, sns_topic_arn, source_type='', event_categories=None, source_ids=None, enabled=True, tags=None, wait_for_completion=True, **kwargs)[源代码]¶

基础：RdsBaseOperator

创建 RDS 事件通知订阅。

另请参阅

有关如何使用此操作器的更多信息，请参阅指南：订阅 Amazon RDS 事件通知

参数:

subscription_name (str) – 订阅的名称（必须少于 255 个字符）
sns_topic_arn (str) – 为事件通知创建的 SNS 主题的 ARN
source_type (str) – 生成事件的源类型。有效值：db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
event_categories (collections.abc.Sequence[str] | None) – 您想要订阅的源类型的事件类别列表用户事件
source_ids (collections.abc.Sequence[str] | None) – 返回事件的事件源标识符列表
enabled (bool) – 一个值，指示是否激活订阅（默认为 True）
tags (collections.abc.Sequence[mypy_boto3_rds.type_defs.TagTypeDef] | dict | None) – 标签字典或格式为 [{“Key”: “…”, “Value”: “…”},] 的标签列表 USER Tagging
wait_for_completion (bool) – 如果为 True，则等待订阅创建完成。（默认为 True）
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[源代码]¶

subscription_name[源代码]¶

sns_topic_arn[源代码]¶

source_type = ''[源代码]¶

event_categories = [][源代码]¶

source_ids = [][源代码]¶

enabled = True[源代码]¶

tags = None[源代码]¶

wait_for_completion = True[源代码]¶

execute(context)[源代码]¶

快照、任务和事件的不同实现。

类 airflow.providers.amazon.aws.operators.rds.RdsDeleteEventSubscriptionOperator(*, subscription_name, **kwargs)[源代码]¶

基础：RdsBaseOperator

删除 RDS 事件通知订阅。

另请参阅

有关如何使用此操作器的更多信息，请参阅指南：取消订阅 Amazon RDS 事件通知

参数:

subscription_name (str) – 您想要删除的 RDS 事件通知订阅的名称
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[源代码]¶

subscription_name[源代码]¶

execute(context)[源代码]¶

快照、任务和事件的不同实现。

类 airflow.providers.amazon.aws.operators.rds.RdsCreateDbInstanceOperator(*, db_instance_identifier, db_instance_class, engine, rds_kwargs=None, wait_for_completion=True, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), waiter_delay=30, waiter_max_attempts=60, **kwargs)[源代码]¶

基础：RdsBaseOperator

创建 RDS 数据库实例。

另请参阅

有关如何使用此操作器的更多信息，请参阅指南：创建数据库实例

参数:

db_instance_identifier (str) – 数据库实例标识符，必须以字母开头，包含 1 到 63 个字母、数字或连字符
db_instance_class (str) – 数据库实例的计算和内存容量，例如 db.m5.large
engine (str) – 此实例要使用的数据库引擎名称
rds_kwargs (dict | None) – 传递给 boto3 RDS 客户端函数 create_db_instance 的命名参数 https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.create_db_instance
wait_for_completion (bool) – 如果为 True，则等待数据库实例创建完成。（默认为 True）
waiter_delay (int) – 检查数据库实例状态的两次连续调用之间的等待时间（以秒为单位）
waiter_max_attempts (int) – 检查数据库实例状态的最大尝试次数
deferrable (bool) – 如果为 True，操作器将异步等待数据库实例创建。这意味着将等待完成。此模式需要安装 aiobotocore 模块。（默认为 False）
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[源代码]¶

db_instance_identifier[源代码]¶

db_instance_class[源代码]¶

engine[源代码]¶

rds_kwargs[源代码]¶

wait_for_completion = False[源代码]¶

deferrable = True[源代码]¶

waiter_delay = 30[源代码]¶

waiter_max_attempts = 60[源代码]¶

execute(context)[源代码]¶

快照、任务和事件的不同实现。

execute_complete(context, event=None)[源代码]¶

类 airflow.providers.amazon.aws.operators.rds.RdsDeleteDbInstanceOperator(*, db_instance_identifier, rds_kwargs=None, wait_for_completion=True, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), waiter_delay=30, waiter_max_attempts=60, **kwargs)[源代码]¶

基础：RdsBaseOperator

删除 RDS 数据库实例。

另请参阅

有关如何使用此操作器的更多信息，请参阅指南：删除数据库实例

参数:

db_instance_identifier (str) – 要删除的数据库实例的数据库实例标识符
rds_kwargs (dict | None) – 传递给 boto3 RDS 客户端函数 delete_db_instance 的命名参数 https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.delete_db_instance
wait_for_completion (bool) – 如果为 True，则等待数据库实例删除完成。（默认为 True）
waiter_delay (int) – 检查数据库实例状态的两次连续调用之间的等待时间（以秒为单位）
waiter_max_attempts (int) – 检查数据库实例状态的最大尝试次数
deferrable (bool) – 如果为 True，操作器将异步等待数据库实例创建。这意味着将等待完成。此模式需要安装 aiobotocore 模块。（默认为 False）
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[源代码]¶

db_instance_identifier[源代码]¶

rds_kwargs[源代码]¶

wait_for_completion = False[源代码]¶

deferrable = True[源代码]¶

waiter_delay = 30[源代码]¶

waiter_max_attempts = 60[源代码]¶

execute(context)[源代码]¶

快照、任务和事件的不同实现。

execute_complete(context, event=None)[源代码]¶

类 airflow.providers.amazon.aws.operators.rds.RdsStartDbOperator(*, db_identifier, db_type=RdsDbType.INSTANCE, wait_for_completion=True, waiter_delay=30, waiter_max_attempts=40, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[源代码]¶

基础：RdsBaseOperator

启动 RDS 数据库实例/集群。

另请参阅

有关如何使用此操作器的更多信息，请参阅指南：启动数据库实例或集群

参数:

db_identifier (str) – 要启动的数据库的 AWS 标识符
db_type (airflow.providers.amazon.aws.utils.rds.RdsDbType | str) – 数据库类型 - "instance"（实例）或 "cluster"（集群）（默认为 "instance"）
wait_for_completion (bool) – 如果为 True，则等待数据库启动。（默认为 True）
waiter_delay (int) – 检查数据库实例状态的两次连续调用之间的等待时间（以秒为单位）
waiter_max_attempts (int) – 检查数据库实例状态的最大尝试次数
deferrable (bool) – 如果为 True，操作器将异步等待数据库实例创建。这意味着将等待完成。此模式需要安装 aiobotocore 模块。
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[源代码]¶

db_identifier[源代码]¶

db_type[源代码]¶

wait_for_completion = True[源代码]¶

waiter_delay = 30[源代码]¶

waiter_max_attempts = 40[源代码]¶

deferrable = True[源代码]¶

execute(context)[源代码]¶

快照、任务和事件的不同实现。

execute_complete(context, event=None)[源代码]¶

类 airflow.providers.amazon.aws.operators.rds.RdsStopDbOperator(*, db_identifier, db_type=RdsDbType.INSTANCE, db_snapshot_identifier=None, wait_for_completion=True, waiter_delay=30, waiter_max_attempts=40, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[源代码]¶

基础：RdsBaseOperator

停止 RDS 数据库实例/集群。

另请参阅

有关如何使用此操作器的更多信息，请参阅指南：停止数据库实例或集群

参数:

db_identifier (str) – 要停止的数据库的 AWS 标识符
db_type (airflow.providers.amazon.aws.utils.rds.RdsDbType | str) – 数据库类型 - "instance"（实例）或 "cluster"（集群）（默认为 "instance"）
db_snapshot_identifier (str | None) – 在停止数据库实例之前要创建的数据库快照的实例标识符。默认值 (None) 跳过快照创建。当 db_type 为 "cluster" 时，此参数将被忽略。
wait_for_completion (bool) – 如果为 True，则等待数据库停止。（默认为 True）
waiter_delay (int) – 检查数据库实例状态的两次连续调用之间的等待时间（以秒为单位）
waiter_max_attempts (int) – 检查数据库实例状态的最大尝试次数
deferrable (bool) – 如果为 True，操作器将异步等待数据库实例创建。这意味着将等待完成。此模式需要安装 aiobotocore 模块。
region_name – AWS region_name。如果未指定，则使用默认的 boto3 行为。
verify – 是否验证 SSL 证书。参见：https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – botocore 客户端的配置字典（键值对）。参见：https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

template_fields[来源]¶

db_identifier[来源]¶

db_type[来源]¶

db_snapshot_identifier = None[来源]¶

wait_for_completion = True[来源]¶

waiter_delay = 30[来源]¶

waiter_max_attempts = 40[来源]¶

deferrable = True[来源]¶

execute(context)[来源]¶

快照、任务和事件的不同实现。

execute_complete(context, event=None)[来源]¶