Skip to main content
PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Pythonic AWS RDS boto3 API, for human.

Project description

Documentation Status https://github.com/MacHu-GWU/simple_aws_rds-project/workflows/CI/badge.svg https://codecov.io/gh/MacHu-GWU/simple_aws_rds-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/simple_aws_rds.svg https://img.shields.io/pypi/l/simple_aws_rds.svg https://img.shields.io/pypi/pyversions/simple_aws_rds.svg https://img.shields.io/badge/Release_History!--None.svg?style=social https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Source_Code-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to simple_aws_rds Documentation

https://simple-aws-rds.readthedocs.io/en/latest/_static/simple_aws_rds-logo.png

Pythonic AWS RDS boto3 API, for human.

Usage:

from simple_aws_rds.api import RDSDBInstance, RDSDBSnapshot
from boto_session_manager import BotoSesManager

bsm = BotoSesManager()

# get db instance by id
db_inst = RDSDBInstance.from_id(bsm, "my-db-identifier")
# get db instance by tag key value pair, it returns a iter proxy that may have multiple db instance
db_inst = RDSDBInstance.from_tag_key_value(bsm, key="Env", value="prod").one_or_none()
db_inst = RDSDBInstance.query(bsm, filters=..., db_instance_identifier=...).all()

print(db_inst.id)
print(db_inst.status)
print(db_inst.instance_class)
print(db_inst.instance_create_time)
print(db_inst.engine)
print(db_inst.engine_version)
print(db_inst.endpoint)
print(db_inst.port)
print(db_inst.hosted_zone_id)
print(db_inst.vpc_id)
print(db_inst.subnet_ids)
print(db_inst.security_groups)
print(db_inst.availability_zone)
print(db_inst.publicly_accessible)
print(db_inst.tags)
print(db_inst.data)

print(db_inst.is_available())
print(db_inst.is_stopped())
print(db_inst.is_ready_to_start())
print(db_inst.is_ready_to_stop())

Install

simple_aws_rds is released on PyPI, so all you need is:

$ pip install simple_aws_rds

To upgrade to latest version:

$ pip install --upgrade simple_aws_rds

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page