# # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. from tempfile import NamedTemporaryFile from urllib.parse import urlparse from airflow.models import BaseOperator from airflow.providers.amazon.aws.hooks.s3 import S3Hook from airflow.providers.ssh.hooks.ssh import SSHHook from airflow.utils.decorators import apply_defaults class SFTPToS3Operator(BaseOperator): """ This operator enables the transferring of files from a SFTP server to Amazon S3. :param sftp_conn_id: The sftp connection id. The name or identifier for establishing a connection to the SFTP server. :type sftp_conn_id: str :param sftp_path: The sftp remote path. This is the specified file path for downloading the file from the SFTP server. :type sftp_path: str :param s3_conn_id: The s3 connection id. The name or identifier for establishing a connection to S3 :type s3_conn_id: str :param s3_bucket: The targeted s3 bucket. This is the S3 bucket to where the file is uploaded. :type s3_bucket: str :param s3_key: The targeted s3 key. This is the specified path for uploading the file to S3. :type s3_key: str """ template_fields = ("s3_key", "sftp_path") @apply_defaults def __init__( self, *, s3_bucket: str, s3_key: str, sftp_path: str, sftp_conn_id: str = "ssh_default", s3_conn_id: str = "aws_default", **kwargs, ) -> None: super().__init__(**kwargs) self.sftp_conn_id = sftp_conn_id self.sftp_path = sftp_path self.s3_bucket = s3_bucket self.s3_key = s3_key self.s3_conn_id = s3_conn_id @staticmethod def get_s3_key(s3_key: str) -> str: """This parses the correct format for S3 keys regardless of how the S3 url is passed.""" parsed_s3_key = urlparse(s3_key) return parsed_s3_key.path.lstrip("/") def execute(self, context) -> None: self.s3_key = self.get_s3_key(self.s3_key) ssh_hook = SSHHook(ssh_conn_id=self.sftp_conn_id) s3_hook = S3Hook(self.s3_conn_id) sftp_client = ssh_hook.get_conn().open_sftp() with NamedTemporaryFile("w") as f: sftp_client.get(self.sftp_path, f.name) s3_hook.load_file( filename=f.name, key=self.s3_key, bucket_name=self.s3_bucket, replace=True, )