Type '/' to Search

»Resource Import

Practitioners can use the terraform import command to let Terraform begin managing existing infrastructure resources. All resources implement the ImportState method, which must either specify enough Terraform state for the Read method to refresh tfsdk.Resource or return an error.

»Single Attribute

When the Read method requires a single attribute to refresh, use the tfsdk.ResourceImportStatePassthroughID function to write the import identifier argument for terraform import.

In the following example, the terraform import command passes the import identifier to the id attribute in Terraform state.

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {
    tfsdk.ResourceImportStatePassthroughID(ctx, tftypes.NewAttributePath().WithAttributeName("id"), req, resp)
}

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {    tfsdk.ResourceImportStatePassthroughID(ctx, tftypes.NewAttributePath().WithAttributeName("id"), req, resp)}

»Multiple Attributes

When the Read method requires multiple attributes to refresh, you must write custom logic in the ImportState method. Specifically, the implementation must:

  1. Use the import identifier from the tfsdk.ImportResourceStateRequest.
  2. Perform the custom logic.
  3. Set state data in the tfsdk.ImportResourceStateResponse.

For example, if the tfsdk.ResourceType implementation has the following GetSchema method:

func (t exampleResourceType) GetSchema(ctx context.Context) (tfsdk.Schema, diag.Diagnostics) {
    return tfsdk.Schema{
        Attributes: map[string]tfsdk.Attribute{
            "attr_one": {
                Type:     types.StringType,
                Required: true,
            },
            "attr_two": {
                Type:     types.StringType,
                Required: true,
            },
            // ... potentially other Attributes ...
        },
    }, nil
}

func (t exampleResourceType) GetSchema(ctx context.Context) (tfsdk.Schema, diag.Diagnostics) {    return tfsdk.Schema{        Attributes: map[string]tfsdk.Attribute{            "attr_one": {                Type:     types.StringType,                Required: true,            },            "attr_two": {                Type:     types.StringType,                Required: true,            },            // ... potentially other Attributes ...        },    }, nil}

Along with a tfsdk.Resource implementation with the following Read method:

func (r exampleResource) Read(ctx context.Context, req tfsdk.ReadResourceRequest, resp *tfsdk.ReadResourceResponse) {
    var attrOne, attrTwo string

    resp.Diagnostics.Append(req.State.GetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_one"), &attrOne)...)
    resp.Diagnostics.Append(req.State.GetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_two"), &attrTwo)...)

    if resp.Diagnostics.HasError() {
        return
    }

    // API call using attrOne and attrTwo
}

func (r exampleResource) Read(ctx context.Context, req tfsdk.ReadResourceRequest, resp *tfsdk.ReadResourceResponse) {    var attrOne, attrTwo string
    resp.Diagnostics.Append(req.State.GetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_one"), &attrOne)...)    resp.Diagnostics.Append(req.State.GetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_two"), &attrTwo)...)
    if resp.Diagnostics.HasError() {        return    }
    // API call using attrOne and attrTwo}

The terraform import command will need to accept both attribute values as a single import identifier string. A typical convention is to use a separator character, such as a comma (,), between the values. The ImportState method will then need to parse the import identifier string into the two separate values and save them appropriately into the Terraform state.

You could define the ImportState method using a comma-separated value as follows:

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {
    idParts := strings.Split(req.ID, ",")

    if len(idParts) != 2 || idParts[0] == "" || idParts[1] == "" {
        resp.Diagnostics.AddError(
            "Unexpected Import Identifier",
            fmt.Sprintf("Expected import identifier with format: attr_one,attr_two. Got: %q", req.ID),
        )
        return
    }

    resp.Diagnostics.Append(resp.State.SetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_one"), idParts[0])...)
    resp.Diagnostics.Append(resp.State.SetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_two"), idParts[1])...)
}

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {    idParts := strings.Split(req.ID, ",")
    if len(idParts) != 2 || idParts[0] == "" || idParts[1] == "" {        resp.Diagnostics.AddError(            "Unexpected Import Identifier",            fmt.Sprintf("Expected import identifier with format: attr_one,attr_two. Got: %q", req.ID),        )        return    }
    resp.Diagnostics.Append(resp.State.SetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_one"), idParts[0])...)    resp.Diagnostics.Append(resp.State.SetAttribute(ctx, tftypes.NewAttributePath().WithAttributeName("attr_two"), idParts[1])...)}

»Not Implemented

If the resource does not support terraform import, use the tfsdk.ResourceImportStateNotImplemented function to return an error. The following example returns a default error message:

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {
    tfsdk.ResourceImportStateNotImplemented(ctx, "", resp)
}

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {    tfsdk.ResourceImportStateNotImplemented(ctx, "", resp)}

When a practitioner runs terraform import, Terraform CLI will return:

$ terraform import example_resource.example some-identifier
example_resource.example: Importing from ID "some-identifier"...
╷
│ Error: Resource Import Not Implemented
│ 
│ This resource does not support import. Please contact the provider developer for additional information.
╵

$ terraform import example_resource.example some-identifierexample_resource.example: Importing from ID "some-identifier"...╷│ Error: Resource Import Not Implemented│ │ This resource does not support import. Please contact the provider developer for additional information.╵

You can also modify the details parameter of the function to include customized recommendations, such as other actions the practitioner can take. For example:

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {
    tfsdk.ResourceImportStateNotImplemented(ctx, "Custom error message.", resp)
}

func (r exampleResource) ImportState(ctx context.Context, req tfsdk.ImportResourceStateRequest, resp *tfsdk.ImportResourceStateResponse) {    tfsdk.ResourceImportStateNotImplemented(ctx, "Custom error message.", resp)}