Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/massdriver-cloud/aws-aurora-serverless-postgres


https://github.com/massdriver-cloud/aws-aurora-serverless-postgres

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README 

          
[![Massdriver][logo]][website]



# aws-aurora-serverless-postgres



[![Release][release_shield]][release_url]

[![Contributors][contributors_shield]][contributors_url]

[![Forks][forks_shield]][forks_url]

[![Stargazers][stars_shield]][stars_url]

[![Issues][issues_shield]][issues_url]

[![MIT License][license_shield]][license_url]



Aurora v1. Highly Available Serverless Postgres Service At 1/10th The Cost Of Commercial-Grade Databases.



---



## Design



For detailed information, check out our [Operator Guide](operator.md) for this bundle.



## Usage



Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.



### What are Bundles?



Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).



## Bundle



### Params



Form input parameters for configuring a bundle for deployment.



View



## Properties



- **`apply_immediately`** *(boolean)*: Apply changes immediately or during your cluster's next scheduled maintenance window. Default: `True`.

- **`backup_retention_period`** *(integer)*: How long to keep backups for in days. Minimum: `1`. Maximum: `35`. Default: `1`.

- **`deletion_protection`** *(boolean)*: If the DB instance should have deletion protection enabled. Default: `True`.

- **`enable_http_endpoint`** *(boolean)*: Whether or not to enable the Data API for a serverless Aurora database engine. Default: `False`.

- **`major_version`** *(integer)*: PostgreSQL major version. Minor version upgrades are performed automatically. **Note:** Aurora V1 only supports PG 10, 11, & 13. PG 10 EOL is scheduled for January 2023. Must be one of: `[10, 11, 13]`. Default: `13`.

- **`monitoring`** *(object)*

  - **`mode`** *(string)*: Enable and customize CloudWatch metric alarms. Default: `AUTOMATED`.

    - **One of**

      - Automated

      - Custom

      - Disabled

- **`scaling_configuration`** *(object)*: Serverless scaling properties.

  - **`auto_pause`** *(boolean)*: Whether to enable automatic pause. A DB cluster can be paused only when it's idle (it has no connections). Default: `True`.

  - **`max_capacity`** *(number)*: Each capacity unit is equivalent to a specific compute and memory configuration. Based on the maximum capacity unit setting, Aurora Serverless automatically creates scaling rules for thresholds for CPU utilization, connections, and available memory. Aurora Serverless provides more capacity for the DB cluster from warm pool of resources when its workload is above these thresholds. Aurora Serverless can increase capacity to the maximum capacity unit. Must be one of: `[2, 4, 8, 16, 32, 64, 192, 384]`. Default: `4`.

  - **`min_capacity`** *(number)*: Each capacity unit is equivalent to a specific compute and memory configuration. Based on the minimum capacity unit setting, Aurora Serverless automatically creates scaling rules for thresholds for CPU utilization, connections, and available memory. Aurora Serverless reduces the resources for the DB cluster when its workload is below these thresholds. Aurora Serverless can reduce capacity down to the minimum capacity unit. Must be one of: `[2, 4, 8, 16, 32, 64, 192, 384]`. Default: `2`.

  - **`seconds_until_auto_pause`** *(number)*: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Minimum: `300`. Maximum: `86400`. Default: `300`.

  - **`timeout_action`** *(string)*: The action to take when the timeout is reached. [Learn more](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.timeout-action). Must be one of: `['ForceApplyCapacityChange', 'RollbackCapacityChange']`. Default: `RollbackCapacityChange`.

- **`skip_final_snapshot`** *(boolean)*: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. Default: `True`.

- **`source_snapshot`** *(string)*: On **creation**, restores a database from snapshot.



  Examples:

  ```json

  "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

  ```



  ```json

  "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

  ```



- **`subnet_type`** *(string)*: Deploy the database to internal subnets (cannot reach the internet) or private subnets (internet egress traffic allowed). Must be one of: `['internal', 'private']`. Default: `internal`.

- **`username`** *(string)*: Administrative (root) DB username. Default: `root`.

## Examples



  ```json

  {

      "__name": "Development",

      "backup_retention_period": 1,

      "deletion_protection": false,

      "scaling_configuration": {

          "max_capacity": 2,

          "min_capacity": 2,

          "timeout_action": "ForceApplyCapacityChange"

      },

      "skip_final_snapshot": true

  }

  ```



  ```json

  {

      "__name": "Production",

      "backup_retention_period": 30,

      "deletion_protection": true,

      "scaling_configuration": {

          "max_capacity": 32,

          "min_capacity": 2,

          "timeout_action": "RollbackCapacityChange"

      },

      "skip_final_snapshot": false

  }

  ```



### Connections



Connections from other bundles that this bundle depends on.



View



## Properties



- **`aws_authentication`** *(object)*: . Cannot contain additional properties.

  - **`data`** *(object)*

    - **`arn`** *(string)*: Amazon Resource Name.



      Examples:

      ```json

      "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

      ```



      ```json

      "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

      ```



    - **`external_id`** *(string)*: An external ID is a piece of data that can be passed to the AssumeRole API of the Security Token Service (STS). You can then use the external ID in the condition element in a role's trust policy, allowing the role to be assumed only when a certain value is present in the external ID.

  - **`specs`** *(object)*

    - **`aws`** *(object)*: .

      - **`region`** *(string)*: AWS Region to provision in.



        Examples:

        ```json

        "us-west-2"

        ```



- **`vpc`** *(object)*: . Cannot contain additional properties.

  - **`data`** *(object)*

    - **`infrastructure`** *(object)*

      - **`arn`** *(string)*: Amazon Resource Name.



        Examples:

        ```json

        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

        ```



        ```json

        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

        ```



      - **`cidr`** *(string)*



        Examples:

        ```json

        "10.100.0.0/16"

        ```



        ```json

        "192.24.12.0/22"

        ```



      - **`internal_subnets`** *(array)*

        - **Items** *(object)*: AWS VCP Subnet.

          - **`arn`** *(string)*: Amazon Resource Name.



            Examples:

            ```json

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            ```



            ```json

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

            ```



          Examples:

      - **`private_subnets`** *(array)*

        - **Items** *(object)*: AWS VCP Subnet.

          - **`arn`** *(string)*: Amazon Resource Name.



            Examples:

            ```json

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            ```



            ```json

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

            ```



          Examples:

      - **`public_subnets`** *(array)*

        - **Items** *(object)*: AWS VCP Subnet.

          - **`arn`** *(string)*: Amazon Resource Name.



            Examples:

            ```json

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            ```



            ```json

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

            ```



          Examples:

  - **`specs`** *(object)*

    - **`aws`** *(object)*: .

      - **`region`** *(string)*: AWS Region to provision in.



        Examples:

        ```json

        "us-west-2"

        ```



### Artifacts



Resources created by this bundle that can be connected to other bundles.



View



## Properties



- **`authentication`** *(object)*: Authentication parameters for a PostgreSQL database. Cannot contain additional properties.

  - **`data`** *(object)*: Cannot contain additional properties.

    - **`authentication`** *(object)*

      - **`hostname`** *(string)*

      - **`password`** *(string)*

      - **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.

      - **`username`** *(string)*

    - **`infrastructure`** *(object)*: Cloud specific PostgreSQL configuration data.

      - **One of**

        - AWS Infrastructure ARN*object*: Minimal AWS Infrastructure Config. Cannot contain additional properties.

          - **`arn`** *(string)*: Amazon Resource Name.



            Examples:

            ```json

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            ```



            ```json

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

            ```



        - GCP Infrastructure Name*object*: GCP Infrastructure Config For Resources With A Name Not A GRN. Cannot contain additional properties.

          - **`name`** *(string)*: Name Of GCP Resource.



            Examples:

            ```json

            "my-cloud-function"

            ```



            ```json

            "my-sql-instance"

            ```



        - Azure Infrastructure Resource ID*object*: Minimal Azure Infrastructure Config. Cannot contain additional properties.

          - **`ari`** *(string)*: Azure Resource ID.



            Examples:

            ```json

            "/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"

            ```



        - Kuberenetes infrastructure config*object*: . Cannot contain additional properties.

          - **`kubernetes_namespace`** *(string)*

          - **`kubernetes_service`** *(string)*

    - **`security`** *(object)*: TBD.

      - **Any of**

        - AWS Security information*object*: Informs downstream services of network and/or IAM policies. Cannot contain additional properties.

          - **`iam`** *(object)*: IAM Policies. Cannot contain additional properties.

            - **`^[a-z]+[a-z_]*[a-z]+$`** *(object)*

              - **`policy_arn`** *(string)*: AWS IAM policy ARN.



                Examples:

                ```json

                "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

                ```



                ```json

                "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

                ```



          - **`identity`** *(object)*: For instances where IAM policies must be attached to a role attached to an AWS resource, for instance AWS Eventbridge to Firehose, this attribute should be used to allow the downstream to attach it's policies (Firehose) directly to the IAM role created by the upstream (Eventbridge). It is important to remember that connections in massdriver are one way, this scheme perserves the dependency relationship while allowing bundles to control the lifecycles of resources under it's management. Cannot contain additional properties.

            - **`role_arn`** *(string)*: ARN for this resources IAM Role.



              Examples:

              ```json

              "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

              ```



              ```json

              "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

              ```



          - **`network`** *(object)*: AWS security group rules to inform downstream services of ports to open for communication. Cannot contain additional properties.

            - **`^[a-z-]+$`** *(object)*

              - **`arn`** *(string)*: Amazon Resource Name.



                Examples:

                ```json

                "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

                ```



                ```json

                "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

                ```



              - **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.

              - **`protocol`** *(string)*: Must be one of: `['tcp', 'udp']`.

        - Security*object*: Azure Security Configuration. Cannot contain additional properties.

          - **`iam`** *(object)*: IAM Roles And Scopes. Cannot contain additional properties.

            - **`^[a-z]+[a-z_]*[a-z]$`** *(object)*

              - **`role`**: Azure Role.



                Examples:

                ```json

                "Storage Blob Data Reader"

                ```



              - **`scope`** *(string)*: Azure IAM Scope.

        - Security*object*: GCP Security Configuration. Cannot contain additional properties.

          - **`iam`** *(object)*: IAM Roles And Conditions. Cannot contain additional properties.

            - **`^[a-z]+[a-z_]*[a-z]$`** *(object)*

              - **`condition`** *(string)*: GCP IAM Condition.

              - **`role`**: GCP Role.



                Examples:

                ```json

                "roles/owner"

                ```



                ```json

                "roles/redis.editor"

                ```



                ```json

                "roles/storage.objectCreator"

                ```



                ```json

                "roles/storage.legacyObjectReader"

                ```



  - **`specs`** *(object)*: Cannot contain additional properties.

    - **`aws`** *(object)*: .

      - **`region`** *(string)*: AWS Region to provision in.



        Examples:

        ```json

        "us-west-2"

        ```



    - **`azure`** *(object)*: .

      - **`region`** *(string)*: Select the Azure region you'd like to provision your resources in.

    - **`gcp`** *(object)*: .

      - **`project`** *(string)*

      - **`region`** *(string)*: The GCP region to provision resources in.



        Examples:

        ```json

        "us-east1"

        ```



        ```json

        "us-east4"

        ```



        ```json

        "us-west1"

        ```



        ```json

        "us-west2"

        ```



        ```json

        "us-west3"

        ```



        ```json

        "us-west4"

        ```



        ```json

        "us-central1"

        ```



    - **`rdbms`** *(object)*: Common metadata for relational databases.

      - **`engine`** *(string)*: The type of database server.



        Examples:

        ```json

        "postgresql"

        ```



        ```json

        "mysql"

        ```



      - **`engine_version`** *(string)*: The cloud provider's database version.



        Examples:

        ```json

        "5.7.mysql_aurora.2.03.2"

        ```



      - **`version`** *(string)*: The database version. Default: ``.



        Examples:

        ```json

        "12.2"

        ```



        ```json

        "5.7"

        ```



      Examples:

      ```json

      {

          "engine": "postgresql",

          "engine_version": "10.14",

          "version": "10.14"

      }

      ```



      ```json

      {

          "engine": "mysql",

          "engine_version": "5.7.mysql_aurora.2.03.2",

          "version": "5.7"

      }

      ```



## Contributing



### Bug Reports & Feature Requests



Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/aws-aurora-serverless-postgres/issues) to report any bugs or request additional features.



### Developing



**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.



Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).



### Fix or Fork



If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!



## Connect



Questions? Concerns? Adulations? We'd love to hear from you!



Please connect with us!



[![Email][email_shield]][email_url]

[![GitHub][github_shield]][github_url]

[![LinkedIn][linkedin_shield]][linkedin_url]

[![Twitter][twitter_shield]][twitter_url]

[![YouTube][youtube_shield]][youtube_url]

[![Reddit][reddit_shield]][reddit_url]



[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg

[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-aurora-serverless-postgres&utm_content=docs

[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-aurora-serverless-postgres&utm_content=website

[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-aurora-serverless-postgres&utm_content=github

[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=aws-aurora-serverless-postgres&utm_content=slack

[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=aws-aurora-serverless-postgres&utm_content=linkedin



[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/aws-aurora-serverless-postgres.svg?style=for-the-badge

[contributors_url]: https://github.com/massdriver-cloud/aws-aurora-serverless-postgres/graphs/contributors

[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/aws-aurora-serverless-postgres.svg?style=for-the-badge

[forks_url]: https://github.com/massdriver-cloud/aws-aurora-serverless-postgres/network/members

[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/aws-aurora-serverless-postgres.svg?style=for-the-badge

[stars_url]: https://github.com/massdriver-cloud/aws-aurora-serverless-postgres/stargazers

[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/aws-aurora-serverless-postgres.svg?style=for-the-badge

[issues_url]: https://github.com/massdriver-cloud/aws-aurora-serverless-postgres/issues

[release_url]: https://github.com/massdriver-cloud/aws-aurora-serverless-postgres/releases/latest

[release_shield]: https://img.shields.io/github/release/massdriver-cloud/aws-aurora-serverless-postgres.svg?style=for-the-badge

[license_shield]: https://img.shields.io/github/license/massdriver-cloud/aws-aurora-serverless-postgres.svg?style=for-the-badge

[license_url]: https://github.com/massdriver-cloud/aws-aurora-serverless-postgres/blob/main/LICENSE



[email_url]: mailto:support@massdriver.cloud

[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000

[github_url]: mailto:support@massdriver.cloud

[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717

[linkedin_url]: https://linkedin.com/in/massdriver-cloud

[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2

[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=aws-aurora-serverless-postgres&utm_content=twitter

[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2

[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-aurora-serverless-postgres&utm_content=discourse

[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000

[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ

[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000

[reddit_url]: https://www.reddit.com/r/massdriver

[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500