53 lines
2.1 KiB
Markdown
53 lines
2.1 KiB
Markdown
<!-- This readme file is generated with terraform-docs -->
|
|
# ec2-instance-scheduler-sfn
|
|
|
|
This module start or stop ec2 instances using step function.
|
|
Schedules are made with Event Scheduler
|
|
|
|
## Requirements
|
|
|
|
No requirements.
|
|
|
|
## Providers
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| aws | n/a |
|
|
| random | n/a |
|
|
|
|
## Modules
|
|
|
|
| Name | Source | Version |
|
|
|------|--------|---------|
|
|
| EventSchedulerRole | ../../../whk1-bea-sys-ss-dev-codecommit-sharedmodules/SecurityIdentityCompliance/iam-role-v2 | n/a |
|
|
| StepFunctionRole | ../../../whk1-bea-sys-ss-dev-codecommit-sharedmodules/SecurityIdentityCompliance/iam-role-v2 | n/a |
|
|
|
|
## Resources
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| [aws_cloudwatch_log_group.Ec2Scheduler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
|
|
| [aws_scheduler_schedule.StartInstances](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/scheduler_schedule) | resource |
|
|
| [aws_scheduler_schedule.StopInstances](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/scheduler_schedule) | resource |
|
|
| [aws_sfn_state_machine.Ec2Scheduler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sfn_state_machine) | resource |
|
|
| [random_id.rid](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource |
|
|
|
|
## Inputs
|
|
|
|
| Name | Description | Type | Default | Required |
|
|
|------|-------------|------|---------|:--------:|
|
|
| cloudwatchlog-retention | Cloudwatch log retention days | `number` | `30` | no |
|
|
| instance-ids | Instances to be automatically started/stopped on schedule | `list(string)` | n/a | yes |
|
|
| instance-start-cron-expression | Cron expression for instance start schedule | `string` | n/a | yes |
|
|
| instance-stop-cron-expression | Cron expression for instance stop schedule | `string` | n/a | yes |
|
|
| kms-key-id | CMK id for cloudwatchlog encryption | `string` | n/a | yes |
|
|
| scheduler-timezone | Timezone of event scheduler | `string` | `"Asia/Hong_Kong"` | no |
|
|
|
|
## Outputs
|
|
|
|
No outputs.
|
|
|
|
---
|
|
## Authorship
|
|
This module was developed by xpk.
|