---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
---
<!-- Bug: Type and Name are switched -->
# {{.Type}} ({{.Name}})

{{ .Description | trimspace }}

## Example Usage

### Basic

Finds and downloads the latest `ubuntu:precise` image but does not check
for further updates of the image

{{tffile "examples/resources/docker_image/resource.tf"}}

### Dynamic updates

To be able to update an image dynamically when the `sha256` sum changes,
you need to use it in combination with `docker_registry_image` as follows:

{{tffile "examples/resources/docker_image/resource-dynamic.tf"}}

### Build

You can also use the resource to build an image.

-> **Note**: The default timeout for the building is 20 minutes. If you need to increase this, you can use [operation timeouts](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts).

In this case the image "zoo" and "zoo:develop" are built.
The `context` and `dockerfile` arguments are relative to the local Terraform process (`path.cwd`).
There is no need to copy the files to remote hosts before creating the resource.

{{tffile "examples/resources/docker_image/resource-build.tf"}}

You can use the `triggers` argument to specify when the image should be rebuild. This is for example helpful when you want to rebuild the docker image whenever the source code changes.

{{tffile "examples/resources/docker_image/resource-build-triggers.tf"}}

{{ .SchemaMarkdown | trimspace }}