ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2726 from trumant/provider_doc_clarification 

Clarifying the resource state persistence mechanism for custom Provid…
This commit is contained in:
Clint 2015-08-12 11:09:38 -05:00
parent 906a1b3b3b d7e0e3fbe8
commit f927835abe
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/source/docs/plugins/provider.html.md
View File

@ -142,7 +142,11 @@ The CRUD operations in more detail, along with their contracts:
* `Create` - This is called to create a new instance of the resource. * `Create` - This is called to create a new instance of the resource.
Terraform guarantees that an existing ID is not set on the resource Terraform guarantees that an existing ID is not set on the resource
data. That is, you're working with a new resource. data. That is, you're working with a new resource. Therefore, you are
responsible for calling `SetId` on your `schema.ResourceData` using a
value suitable for your resource. This ensures whatever resource
state you set on `schema.ResourceData` will be persisted in local state.
If you neglect to `SetId`, no resource state will be persisted.
* `Read` - This is called to resync the local state with the remote state. * `Read` - This is called to resync the local state with the remote state.
Terraform guarantees that an existing ID will be set. This ID should be Terraform guarantees that an existing ID will be set. This ID should be
@ -160,7 +164,8 @@ The CRUD operations in more detail, along with their contracts:
* `Exists` - This is called to verify a resource still exists. It is * `Exists` - This is called to verify a resource still exists. It is
called prior to `Read`, and lowers the burden of `Read` to be able called prior to `Read`, and lowers the burden of `Read` to be able
to assume the resource exists. to assume the resource exists. If the resource is no longer present in
remote state, calling `SetId` with an empty string will signal its removal.
## Schemas ## Schemas