blob: 98b39dbeda0466e5b05f2fa9be7b207cd7c5156b [file] [log] [blame]
:mod:`airflow.providers.amazon.aws.operators.dms_start_task`
============================================================
.. py:module:: airflow.providers.amazon.aws.operators.dms_start_task
Module Contents
---------------
.. py:class:: DmsStartTaskOperator(*, replication_task_arn: str, start_replication_task_type: Optional[str] = 'start-replication', start_task_kwargs: Optional[dict] = None, aws_conn_id: str = 'aws_default', **kwargs)
Bases: :class:`airflow.models.BaseOperator`
Starts AWS DMS replication task.
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:DmsStartTaskOperator`
:param replication_task_arn: Replication task ARN
:type replication_task_arn: str
:param start_replication_task_type: Replication task start type
('start-replication'|'resume-processing'|'reload-target')
:type start_replication_task_type: Optional[str]
:param start_task_kwargs: Extra start replication task arguments
:type start_task_kwargs: Optional[dict]
:param 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).
:type aws_conn_id: Optional[str]
.. attribute:: template_fields
:annotation: = ['replication_task_arn', 'start_replication_task_type', 'start_task_kwargs']
.. attribute:: template_ext
:annotation: = []
.. attribute:: template_fields_renderers
.. method:: execute(self, context)
Starts AWS DMS replication task from Airflow
:return: replication task arn