Amazon Neptune¶

Amazon Neptune Database is a serverless graph database designed for superior scalability and availability. Neptune Database provides built-in security, continuous backups, and integrations with other AWS services.

Prerequisite Tasks¶

To use these operators, you must do a few things:

Create necessary resources using AWS Console or AWS CLI.
Install API libraries via pip.
pip install 'apache-airflow[amazon]'
Detailed information is available Installation of Apache Airflow®
Setup Connection.

Generic Parameters¶

aws_conn_id

Reference to Amazon Web Services Connection ID. If this parameter is set to None then the default boto3 behaviour is used without a connection lookup. Otherwise use the credentials stored in the Connection. Default: aws_default

region_name

AWS Region Name. If this parameter is set to None or omitted then region_name from AWS Connection Extra Parameter will be used. Otherwise use the specified value instead of the connection value. Default: None

verify

Whether or not to verify SSL certificates.

False - Do not validate SSL certificates.
path/to/cert/bundle.pem - A filename of the CA cert bundle to use. You can specify this argument if you want to use a different CA cert bundle than the one used by botocore.

If this parameter is set to None or is omitted then verify from AWS Connection Extra Parameter will be used. Otherwise use the specified value instead of the connection value. Default: None

botocore_config

The provided dictionary is used to construct a botocore.config.Config. This configuration can be used to configure Avoid Throttling exceptions, timeouts, etc.

Example, for more detail about parameters please have a look botocore.config.Config¶

{
    "signature_version": "unsigned",
    "s3": {
        "us_east_1_regional_endpoint": True,
    },
    "retries": {
      "mode": "standard",
      "max_attempts": 10,
    },
    "connect_timeout": 300,
    "read_timeout": 300,
    "tcp_keepalive": True,
}

If this parameter is set to None or omitted then config_kwargs from AWS Connection Extra Parameter will be used. Otherwise use the specified value instead of the connection value. Default: None

Note

Specifying an empty dictionary, {}, will overwrite the connection configuration for botocore.config.Config

Operators¶

Start a Neptune database cluster¶

To start a existing Neptune database cluster, you can use StartNeptuneDbClusterOperator. This operator can be run in deferrable mode by passing deferrable=True as a parameter. This requires the aiobotocore module to be installed.

Note

This operator only starts an existing Neptune database cluster, it does not create a cluster.

tests/system/providers/amazon/aws/example_neptune.py[source]

start_cluster = NeptuneStartDbClusterOperator(
    task_id="start_task", db_cluster_id=cluster_id, deferrable=True
)

Stop a Neptune database cluster¶

To stop a running Neptune database cluster, you can use StartNeptuneDbClusterOperator. This operator can be run in deferrable mode by passing deferrable=True as a parameter. This requires the aiobotocore module to be installed.

tests/system/providers/amazon/aws/example_neptune.py[source]

stop_cluster = NeptuneStopDbClusterOperator(
    task_id="stop_task", db_cluster_id=cluster_id, deferrable=True
)

Reference¶

AWS boto3 library documentation for Neptune