Skip to main content

A set of constructs deploying pgSTAC with CDK

Project description

eoAPI CDK Constructs

eoapi-cdk is a package of AWS CDK constructs designed to encapsulate eoAPI services and best practices as simple reusable components.

[!IMPORTANT]

We would :heart: to hear from you! Please join the discussion and let us know how you're using eoAPI! This helps us improve the project for you and others. If you prefer to remain anonymous, you can email us at eoapi@developmentseed.org, and we'll be happy to post a summary on your behalf.

For more background on the included services see The Earth Observation API

Included constructs

Detailed API docs for the constructs can be found here.

pgSTAC Database

An RDS instance with pgSTAC installed and the Postgres parameters optimized for the selected instance type.

STAC API

A STAC API implementation using stac-fastapi with a pgSTAC backend. Packaged as a complete runtime for deployment with API Gateway and Lambda.

For runtime notes on event loops, Mangum lifespan handling, and SnapStart-aware database pool initialization, see lib/stac-api/runtime/README.md.

pgSTAC Titiler API

A complete dynamic tiling API using titiler-pgstac to create dynamic mosaics of assets based on STAC Search queries. Packaged as a complete runtime for deployment with API Gateway and Lambda and fully integrated with the pgSTAC Database construct.

STAC browser

A CDK construct to host a static Radiant Earth STAC browser on S3.

OGC Features/Tiles API

A complete OGC Features/Tiles API using tipg. Packaged as a complete runtime for deployment with API Gateway and Lambda. By default the API will be connected to the Database's public schema.

STAC Ingestor

An API for large scale STAC data ingestion and validation into a pgSTAC instance.

ingestor

Authentication for the STAC Ingestor API can be configured with JWTs authenticated by JWKS. To learn more about securing FastAPI applications with this approach see Securing FastAPI with JWKS (AWS Cognito, Auth0).

A sample Cognito-based authentication system is available at aws-asdi-auth.

Bastion Host

A bastion host is a secure gateway that provides access to resources in a private subnet. In this case it provides the ability to make administrative connections to eoAPI's pgSTAC instance.

Alt text

For more background on bastion hosts in AWS see this article.

And for configuration instructions for this construct see the docs.

Published Packages

Release

Versioning is automatically handled via Conventional Commits and Semantic Release.

Warning: If you rebase main, you must ensure that the commits referenced by tags point to commits that are within the main branch. If a commit references a commit that is no longer on the main branch, Semantic Release will fail to detect the correct version of the project. More information.

Tests

Each pull request to main is added to a merge queue so that a "deployment test" workflow can run before the merge actually happens. If the deployment fails, the merge is cancelled. Here is the definition of this workflow and the tests definition.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eoapi_cdk-11.6.0.tar.gz (631.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eoapi_cdk-11.6.0-py3-none-any.whl (629.8 kB view details)

Uploaded Python 3

File details

Details for the file eoapi_cdk-11.6.0.tar.gz.

File metadata

  • Download URL: eoapi_cdk-11.6.0.tar.gz
  • Upload date:
  • Size: 631.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for eoapi_cdk-11.6.0.tar.gz
Algorithm Hash digest
SHA256 20b043d51fa904010cd93fb1520b2b9ceb93cb13eb1dfee621928dc6aca13bee
MD5 21837cea1e9eec3608d7b71c3f3cfe1b
BLAKE2b-256 349e2409e31e0f14531a05e72cc8c90dca40869685f6f9be7e6aeea0e15d9a88

See more details on using hashes here.

Provenance

The following attestation bundles were made for eoapi_cdk-11.6.0.tar.gz:

Publisher: distribute.yaml on developmentseed/eoapi-cdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file eoapi_cdk-11.6.0-py3-none-any.whl.

File metadata

  • Download URL: eoapi_cdk-11.6.0-py3-none-any.whl
  • Upload date:
  • Size: 629.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for eoapi_cdk-11.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8186ab34487be5149bc82d17935fdde3ba5697caca1203e50a1e3bc2b2128ff9
MD5 1e28efa9dced222a0ccc54f2b145ef6a
BLAKE2b-256 378056e179a27e609fc7dba8d19c2964de1ec91d185d8770457868ec7927f421

See more details on using hashes here.

Provenance

The following attestation bundles were made for eoapi_cdk-11.6.0-py3-none-any.whl:

Publisher: distribute.yaml on developmentseed/eoapi-cdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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