Skip to content

Latest commit

 

History

History
180 lines (124 loc) · 6.77 KB

index.md

File metadata and controls

180 lines (124 loc) · 6.77 KB
Raw

Twilio Provider

The Twilio provider is used to interact with the many resources supported by Twilio. The provider needs to be configured with your Twilio credentials before it can be used.

⚠️ Disclaimer: This project is not an official Twilio project and is not supported or endorsed by Twilio in any way. It is maintained in my free time.

Installation

NOTE: This provider only supports Terraform 0.12+

Terraform 0.13+

The provider has been published to the Terraform Registry you need to add the following code to your Terraform configuration and run terraform init. Terraform will take care of installing the provider for you.

terraform {
  required_providers {
    twilio = {
      source  = "RJPearson94/twilio"
      version = ">= 0.2.1"
    }
  }
}

provider "twilio" {
  # Configuration options
}

Terraform 0.12

This is a bit more work as you have to download the latest release of the terraform provider which can run on you machine operating system/ processor architecture. Then unzip the provider and place the provider in the ~/.terraform.d/plugins folder (on most operating systems) and %APPDATA%\terraform.d\plugins on Windows. For more information see the terraform docs

Authentication

The Twilio provider offers a various way of providing credentials for authentication. The following methods are supported, in precedence order:

  • Static credentials
    • API Key & Secret
    • Account SID & Auth Token
  • Environment variables
    • API Key & Secret
    • Account SID & Auth Token

Static credentials

!> This method is supported however it is not recommend for use as secrets could be leaked if the provider was committed to public version control.

API Key & Secret

Static credentials can be provided by setting the account_sid, api_key & api_secret attributes in the Twilio provider block:

Usage:

provider "twilio" {
  account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  api_key     = "SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  api_secret  = "api-secret"
}

Account SID & Auth Token

Static credentials can be provided by setting the account_sid and auth_token attributes in the Twilio provider block:

Usage:

provider "twilio" {
  account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  auth_token  = "my-auth-token"
}

Environment variables

API Key & Secret

You can provide your credentials via the TWILIO_ACCOUNT_SID, TWILIO_API_KEY and TWILIO_API_SECRET environment variables, representing your Twilio Account SID, API Key SID and API Secret respectively.

provider "twilio" {}

Usage:

export TWILIO_ACCOUNT_SID="ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
export TWILIO_API_KEY="SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
export TWILIO_API_SECRET="api-secret"
terraform plan

or

TWILIO_ACCOUNT_SID="ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" TWILIO_API_KEY="SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" TWILIO_API_SECRET="api-secret" terraform plan

Account SID & Auth Token

You can provide your credentials via the TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN environment variables, representing your Twilio Account SID and Auth Token respectively.

provider "twilio" {}

Usage:

export TWILIO_ACCOUNT_SID="ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
export TWILIO_AUTH_TOKEN="my-auth-token"
terraform plan

or

TWILIO_ACCOUNT_SID="ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" TWILIO_AUTH_TOKEN="my-auth-token" terraform plan

Rate Limiting & Retry configuration

To protect its services, Twilio implements Rate Limiting on it's APIs. When provisioning/ configuring a large number of resources the provider may experience rate limiting from the various API's and the provider may error with the following error message Error: Failed to create workflow: Rate limit exceeded for target Workflow-Create.

To limit the number of errors, the provider supports retries with exponential backoff, by default the provider will retry 3 times with a backoff interval of 5 seconds (5000 ms). Under certain scenarios this limit may not be suitable, so the configuration can be overridden on the provider by specifying the attributes on the provider or via environment variables

To configure a retry limit of 5 attempts and a backoff interval of 10 seconds (10000 ms) you can use one of the following options:

Provider attributes

provider "twilio" {}

Usage:

provider "twilio" {
  retry_attempts         = 5
  backoff_interval_in_ms = 10000
}

Environment variables

provider "twilio" {}

Usage:

export TWILIO_RETRY_ATTEMPTS=5
export TWILIO_BACKOFF_INTERVAL_IN_MS=10000
terraform plan

or

TWILIO_RETRY_ATTEMPTS=5 TWILIO_BACKOFF_INTERVAL_IN_MS=10000 terraform plan

Argument Reference

In addition to generic provider arguments the following arguments are supported:

  • account_sid - (Optional) This is the Account Sid. This SID is mandatory, but it can also be retrieved from the TWILIO_ACCOUNT_SID environment variable
  • api_key - (Optional) An API key SID associate with the account. This value can be retrieved from the TWILIO_API_KEY environment variable
  • api_secret - (Optional) An secret value for the API Key. This value can be retrieved from the TWILIO_API_SECRET environment variable
  • auth_token - (Optional) The Auth token for the account. This value can be retrieved from the TWILIO_AUTH_TOKEN environment variable
  • skip_credential_validation - (Optional) Whether to skip credential validation. This setting aids with the management of sub-account resources when the sub account and sub-account resources are created in the same state. This should be used with caution, as requests may fail when planning or applying changes. This value can be retrieved from the TWILIO_SKIP_CREDENTIAL_VALIDATION environment variable. The default value is false
  • retry_attempts - (Optional) The maximum number of retry attempts. This value can be retrieved from the TWILIO_RETRY_ATTEMPTS environment variable. The default value is 3
  • backoff_interval_in_ms - (Optional) The time in ms to wait between each retry attempt. This value can be retrieved from the TWILIO_BACKOFF_INTERVAL_IN_MS environment variable. The default value is 5000
  • edge - (Optional) The edge location to use. This value can be retrieved from the TWILIO_EDGE environment variable.
  • region - (Optional) The region to use. This value can be retrieved from the TWILIO_REGION environment variable.

NOTE: A valid API Key and Secret or Auth Token must be supplied