Skip to content

Commit dedc3c1

Browse files
committed
(Chore) Update Readme
* Fixes the `cron()` example and `schedule_expression` description * Adds documentation links
1 parent 04d255d commit dedc3c1

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ A Terraform module to create a scheduled task in AWS ECS
77
``` hcl
88
module "scheduled_task" {
99
source = "github.com:dxw/terraform-aws-ecs-scheduled-task"
10-
version = "1.0"
10+
version = "1.2"
1111
1212
name = "my_awesome_task"
1313
environment = "staging"
1414
container_definitions = "${file(./path/to/container-definitions.json)}"
15-
schedule_expression = "0 * * * *"
15+
schedule_expression = "cron(0 * * * ? 0)"
1616
cluster_arn = "my_awesome_cluster"
1717
memory = "512"
1818
cpu = "512"
@@ -37,12 +37,12 @@ The following variables can be configured:
3737

3838
#### `container_definitions`
3939

40-
- **Description**: Task container defintions
40+
- **Description**: Task container defintions. See [AWS docs][container_definition_docs]
4141
- **Default**: `none`
4242

4343
#### `schedule_expression`
4444

45-
- **Description**: Schedule expression (cron) for when to run task
45+
- **Description**: Schedule expression ( `cron()` or `rate()`) for when to run task. See [AWS docs][schedule_expression_docs]
4646
- **Default**: `none`
4747

4848
#### `cluster_arn`
@@ -86,3 +86,6 @@ The following outputs are exported:
8686
#### `scheduled_task_arn`
8787

8888
- **Description**: Scheduled Task ARN
89+
90+
[container_definition_docs]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html
91+
[schedule_definition_docs]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html

0 commit comments

Comments
 (0)