Synchronizes an S3 key, possibly a prefix, with a Google Cloud Storage destination path.

View Source

Last Updated: May. 7, 2021

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.


bucketstrThe S3 bucket where to find the objects. (templated)
prefixstrPrefix string which filters objects whose name begin with such prefix. (templated)
delimiterstrthe delimiter marks key hierarchy. (templated)
aws_conn_idstrThe source S3 connection
verifybool or strWhether or not to verify SSL certificates for S3 connection. By default SSL certificates are verified. You can provide the following values:False: do not validate SSL certificates. SSL will still be used(unless use_ssl is False), but SSL certificates will not be verified.path/to/cert/bundle.pem: A filename of the CA cert bundle to uses.You can specify this argument if you want to use a different CA cert bundle than the one used by botocore.
gcp_conn_idstr(Optional) The connection ID used to connect to Google Cloud.
dest_gcs_conn_idstr(Deprecated) The connection ID used to connect to Google Cloud. This parameter has been deprecated. You should pass the gcp_conn_id parameter instead.
dest_gcsstrThe destination Google Cloud Storage bucket and prefix where you want to store the files. (templated)
delegate_tostrGoogle account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.
replaceboolWhether you want to replace existing destination files or not.
gzipboolOption to compress file for upload
google_impersonation_chainUnion[str, Sequence[str]]Optional Google service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).


Synchronizes an S3 key, possibly a prefix, with a Google Cloud Storage destination path.


s3_to_gcs_op = S3ToGCSOperator( task_id='s3_to_gcs_example', bucket='my-s3-bucket', prefix='data/customers-201804', dest_gcs_conn_id='google_cloud_default', dest_gcs='gs://my.gcs.bucket/some/customers/', replace=False, gzip=True, dag=my-dag)

Note that bucket, prefix, delimiter and dest_gcs are templated, so you can use variables in them if you wish.

Example DAGs

Was this page helpful?