apfm-actions/DocumentDB Deploy
Deploy an AWS DocumentDB using Terraform
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit May 21, 2020
- License
- None
Pinned Snippet
uses: apfm-actions/terraform-docdb-action@1b72710058dbaa1954fefe7bd7f3d79caa8afe13 # no releases — HEAD as of 2026-07-10tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| destroy | Runs Terraform destroy to remove resources created by this action | no | false |
| deploy | Runs Terraform apply to create/update resources created by this action | no | true |
| plan | Runs Terraform plan to check the changes necessary to achieve the desired state | no | true |
| cluster_name | DocumentDB cluster name | yes | — |
| username | Username for the DocumentDB access. Hyphens are not allowed. | yes | — |
| credstash_docdb_password | Credstash secret name/key. Used to retrieve the stored password for the DocumentDB cluster | yes | — |
| parameter_group | A cluster parameter group to associate with the cluster | no | — |
| security_group_ids | A comma separated list of security group IDs associated with the cluster | no | — |
| port | The port on which the DB accepts connections | no | 27017 |
| storage_encrypted | Specifies whether the DB cluster is encrypted | no | false |
| apply_immediately | Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. APPLY IMMEDIATELY WILL CAUSE OUTAGE | no | false |
| backup_window | The daily time range during which automated backups are created in UTC. e.g. 04:00-09:00 | no | 07:00-11:00 |
| backup_retention | The days to retain backups for | no | 1 |
| instance_count | Number of instances to create and join to the cluster | no | 1 |
| instance_class | The instance class to use. Supported instance classes: https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-classes.html#db-instance-class-specs | no | db.r5.large |
| subnet_ids | A comma separated list of subnet IDs | yes | — |
Outputs
| name | description |
|---|---|
| documentdb_name | Name of the created documentdb cluster |
| documentdb_arn | ARN of the created documentdb cluster |
| documentdb_endpoint | The DNS address of the DocDB instance |
| documentdb_reader_endpoint | A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas |