updated docs for aws_ecs_task_definition to avoid confusion

This commit is contained in:
Nathan Sullivan 2015-07-02 20:34:58 +10:00
parent e26a1b8c18
commit 928d5f76ab
1 changed files with 25 additions and 1 deletions

View File

@ -12,6 +12,8 @@ Provides an ECS task definition to be used in `aws_ecs_service`.
## Example Usage ## Example Usage
### jenkins.tf
``` ```
resource "aws_ecs_task_definition" "jenkins" { resource "aws_ecs_task_definition" "jenkins" {
family = "jenkins" family = "jenkins"
@ -24,12 +26,34 @@ resource "aws_ecs_task_definition" "jenkins" {
} }
``` ```
### task-definitions/jenkins.json
This is a small subset of the available parameters, see the [AWS docs](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) for a full list.
```
[
{
"name": "jenkins",
"image": "jenkins",
"cpu": 10,
"memory": 500,
"essential": true,
"portMappings": [
{
"containerPort": 80,
"hostPort": 80
}
]
}
]
```
## Argument Reference ## Argument Reference
The following arguments are supported: The following arguments are supported:
* `family` - (Required) The family, unique name for your task definition. * `family` - (Required) The family, unique name for your task definition.
* `container_definitions` - (Required) A list of container definitions in JSON format. See [AWS docs](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) for syntax. * `container_definitions` - (Required) A list of container definitions in JSON format. See [AWS docs](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-task-definition.html) for syntax. Note, you only need the containerDefinitions array contents, not the parent hash including the family and volumes keys.
* `volume` - (Optional) A volume block. Volumes documented below. * `volume` - (Optional) A volume block. Volumes documented below.
Volumes support the following: Volumes support the following: