Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs/ecs_task_definition: clarify multiple volume blocks may be specified #1158

Merged
merged 2 commits into from
Jul 18, 2017
Merged

docs/ecs_task_definition: clarify multiple volume blocks may be specified #1158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
500e6ec
docs/ecs_task_definition: clarify that multiple volume blocks may be …
Jul 14, 2017
5144f29
Rephrased and added anchors for better UX
Ninir Jul 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions website/docs/r/ecs_task_definition.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ contains only a small subset of the available parameters.

## Argument Reference

The following arguments are supported:
### Top-Level Arguments

* `family` - (Required) A unique name for your task definition.
* `container_definitions` - (Required) A list of valid [container definitions]
Expand All @@ -78,19 +78,16 @@ definition document. For a detailed description of what parameters are available
official [Developer Guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide).
* `task_role_arn` - (Optional) The ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
* `network_mode` - (Optional) The Docker networking mode to use for the containers in the task. The valid values are `none`, `bridge`, and `host`.
* `volume` - (Optional) A volume block. See below for details about what arguments are supported.
* `placement_constraints` - (Optional) rules that are taken into consideration during task placement. Maximum number of
`placement_constraints` is `10`. Defined below.
* `volume` - (Optional) A set of [volume blocks](#volume-block-arguments) that containers in your task may use.
* `placement_constraints` - (Optional) A set of [placement constraints](#placement-constraints-arguments) rules that are taken into consideration during task placement. Maximum number of `placement_constraints` is `10`.

Volume block supports the following arguments:
#### Volume Block Arguments

* `name` - (Required) The name of the volume. This name is referenced in the `sourceVolume`
parameter of container definition in the `mountPoints` section.
* `host_path` - (Optional) The path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.

## placement_constraints

`placement_constraints` support the following:
#### Placement Constraints Arguments

* `type` - (Required) The type of constraint. Use `memberOf` to restrict selection to a group of valid candidates.
Note that `distinctInstance` is not supported in task definitions.
Expand Down