You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-24Lines changed: 30 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,51 +97,55 @@ Invoking the commands defined below creates an ECS task definition with the foll
97
97
98
98
## Inputs
99
99
100
+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
101
+
## Inputs
102
+
100
103
| Name | Description | Type | Default | Required |
101
104
|------|-------------|:----:|:-----:|:-----:|
102
-
| command | The command that is passed to the container | list |`<list>`| no |
105
+
| command | The command that is passed to the container | list |`[]`| no |
103
106
| cpu | The number of cpu units reserved for the container | string |`"0"`| no |
104
107
| disableNetworking | When this parameter is true, networking is disabled within the container | string |`"false"`| no |
105
-
| dnsSearchDomains | A list of DNS search domains that are presented to the container | list |`<list>`| no |
106
-
| dnsServers | A list of DNS servers that are presented to the container | list |`<list>`| no |
107
-
| dockerLabels | A key/value map of labels to add to the container | map |`<map>`| no |
108
-
| dockerSecurityOptions | A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems | list |`<list>`| no |
109
-
| entryPoint | The entry point that is passed to the container | list |`<list>`| no |
110
-
| environment | The environment variables to pass to a container | list |`<list>`| no |
108
+
| dnsSearchDomains | A list of DNS search domains that are presented to the container | list |`[]`| no |
109
+
| dnsServers | A list of DNS servers that are presented to the container | list |`[]`| no |
110
+
| dockerLabels | A key/value map of labels to add to the container | map |`{}`| no |
111
+
| dockerSecurityOptions | A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems | list |`[]`| no |
112
+
| entryPoint | The entry point that is passed to the container | list |`[]`| no |
113
+
| environment | The environment variables to pass to a container | list |`[]`| no |
111
114
| essential | If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped | string |`"true"`| no |
112
115
| execution\_role\_arn | The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume | string |`""`| no |
113
-
| extraHosts | A list of hostnames and IP address mappings to append to the /etc/hosts file on the container | list |`<list>`| no |
116
+
| extraHosts | A list of hostnames and IP address mappings to append to the /etc/hosts file on the container | list |`[]`| no |
114
117
| family | You must specify a family for a task definition, which allows you to track multiple versions of the same task definition | string | n/a | yes |
115
-
| healthCheck | The health check command and associated configuration parameters for the container | map |`<map>`| no |
118
+
| healthCheck | The health check command and associated configuration parameters for the container | map |`{}`| no |
116
119
| hostname | The hostname to use for your container | string |`""`| no |
117
120
| image | The image used to start a container | string |`""`| no |
118
121
| interactive | When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated | string |`"false"`| no |
119
122
| ipc\_mode | The IPC resource namespace to use for the containers in the task | string |`"host"`| no |
120
-
| links | The link parameter allows containers to communicate with each other without the need for port mappings | list |`<list>`| no |
121
-
| linuxParameters | Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities | map |`<map>`| no |
122
-
| logConfiguration | The log configuration specification for the container | map |`<map>`| no |
123
+
| links | The link parameter allows containers to communicate with each other without the need for port mappings | list |`[]`| no |
124
+
| linuxParameters | Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities | map |`{}`| no |
125
+
| logConfiguration | The log configuration specification for the container | map |`{}`| no |
123
126
| memory | The hard limit (in MiB) of memory to present to the container | string |`"0"`| no |
124
127
| memoryReservation | The soft limit (in MiB) of memory to reserve for the container | string |`"0"`| no |
125
-
| mountPoints | The mount points for data volumes in your container | list |`<list>`| no |
128
+
| mountPoints | The mount points for data volumes in your container | list |`[]`| no |
126
129
| name | The name of a container | string |`""`| no |
127
130
| network\_mode | The Docker networking mode to use for the containers in the task | string |`"bridge"`| no |
128
131
| pid\_mode | The process namespace to use for the containers in the task | string |`"host"`| no |
129
-
| placement\_constraints | An array of placement constraint objects to use for the task | list |`<list>`| no |
130
-
| portMappings | The list of port mappings for the container | list |`<list>`| no |
132
+
| placement\_constraints | An array of placement constraint objects to use for the task | list |`[]`| no |
133
+
| portMappings | The list of port mappings for the container | list |`[]`| no |
131
134
| privileged | When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user) | string |`"false"`| no |
132
135
| pseudoTerminal | When this parameter is true, a TTY is allocated | string |`"false"`| no |
133
136
| readonlyRootFilesystem | When this parameter is true, the container is given read-only access to its root file system | string |`"false"`| no |
134
-
| repositoryCredentials | The private repository authentication credentials to use | map |`<map>`| no |
135
-
| requires\_compatibilities | The launch type required by the task | list |`<list>`| no |
136
-
| resourceRequirements | The type and amount of a resource to assign to a container | list |`<list>`| no |
137
-
| secrets | The secrets to pass to the container | list |`<list>`| no |
138
-
| systemControls | A list of namespaced kernel parameters to set in the container | list |`<list>`| no |
139
-
| tags | The metadata that you apply to the task definition to help you categorize and organize them | map |`<map>`| no |
137
+
| register\_task\_definition | Registers a new task definition from the supplied family and containerDefinitions | string |`"true"`| no |
138
+
| repositoryCredentials | The private repository authentication credentials to use | map |`{}`| no |
139
+
| requires\_compatibilities | The launch type required by the task | list |`[]`| no |
140
+
| resourceRequirements | The type and amount of a resource to assign to a container | list |`[]`| no |
141
+
| secrets | The secrets to pass to the container | list |`[]`| no |
142
+
| systemControls | A list of namespaced kernel parameters to set in the container | list |`[]`| no |
143
+
| tags | The metadata that you apply to the task definition to help you categorize and organize them | map |`{}`| no |
140
144
| task\_role\_arn | The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume | string |`""`| no |
141
-
| ulimits | A list of ulimits to set in the container | list |`<list>`| no |
145
+
| ulimits | A list of ulimits to set in the container | list |`[]`| no |
142
146
| user | The user name to use inside the container | string |`""`| no |
143
-
| volumes | A list of volume definitions in JSON format that containers in your task may use | list |`<list>`| no |
144
-
| volumesFrom | Data volumes to mount from another container | list |`<list>`| no |
147
+
| volumes | A list of volume definitions in JSON format that containers in your task may use | list |`[]`| no |
148
+
| volumesFrom | Data volumes to mount from another container | list |`[]`| no |
145
149
| workingDirectory | The working directory in which to run commands inside the container | string |`""`| no |
146
150
147
151
## Outputs
@@ -153,6 +157,8 @@ Invoking the commands defined below creates an ECS task definition with the foll
153
157
| family | The family of your task definition, used as the definition name |
154
158
| revision | The revision of the task in a particular family |
155
159
160
+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
161
+
156
162
## Testing
157
163
158
164
This module uses [Terratest](https://github.com/gruntwork-io/terratest), a Go library maintained by [Gruntwork](https://gruntwork.io/), to write automated tests for your infrastructure code. To invoke tests, run the following commands:
0 commit comments