github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/dnsimple/index.html.markdown (about)

     1  ---
     2  layout: "dnsimple"
     3  page_title: "Provider: DNSimple"
     4  sidebar_current: "docs-dnsimple-index"
     5  description: |-
     6    The DNSimple provider is used to interact with the resources supported by DNSimple. The provider needs to be configured with the proper credentials before it can be used.
     7  ---
     8  
     9  # DNSimple Provider
    10  
    11  The DNSimple provider is used to interact with the
    12  resources supported by DNSimple. The provider needs to be configured
    13  with the proper credentials before it can be used.
    14  
    15  Use the navigation to the left to read about the available resources.
    16  
    17  
    18  ## Example Usage
    19  
    20  ```hcl
    21  # Configure the DNSimple provider
    22  provider "dnsimple" {
    23    token = "${var.dnsimple_token}"
    24    account = "${var.dnsimple_account}"
    25  }
    26  
    27  # Create a record
    28  resource "dnsimple_record" "www" {
    29    # ...
    30  }
    31  ```
    32  
    33  
    34  ## API v2 vs API v1
    35  
    36  This integration uses the new DNSimple API v2 [released on December 2016](https://blog.dnsimple.com/2016/12/api-v2-stable/). The API v2 provides support for multi-accounts and requires a new authentication mechanism.
    37  
    38  If you are upgrading from a previous Terraform version and you were using the API v1, you will need to upgrade the DNSimple provider configuration to use the new API access token and specify the Account ID. Terraform will automatically detect an existing legacy configurations and it will return an error message asking to upgrade.
    39  
    40  API v1 is no longer supported. If you are using the `DNSIMPLE_EMAIL` argument, you can safely remove it once you have upgraded to API v2. To use API v1 you will need to use a Terraform version lower than 0.9.
    41  
    42  To upgrade from the DNSimple provider API v1 to DNSimple provider API v2 follow these steps:
    43  
    44  1. [Generate an API v2 access token](https://support.dnsimple.com/articles/api-access-token/)
    45  1. [Determine the Account ID](https://developer.dnsimple.com/v2/#account-scope)
    46  1. Add the `account` configuration and update the `token`, as shown in the example above
    47  1. Remove the `email` configuration, as it's no longer used
    48  
    49  
    50  ## Argument Reference
    51  
    52  The following arguments are supported:
    53  
    54  * `token` - (Required) The DNSimple API v2 token. It must be provided, but it can also be sourced from the `DNSIMPLE_TOKEN` environment variable. Please note that this must be an [API v2 token](https://support.dnsimple.com/articles/api-access-token/). You can use either an User or Account token, but an Account token is recommended.
    55  * `account` - (Required) The ID of the account associated with the token. It must be provided, but it can also be sourced from the `DNSIMPLE_ACCOUNT` environment variable.