This guide lists the configuration for 'openapi' Terraform provider resources that can be managed using Terraform v0.12. 

• Provider Installation
• Provider Configuration
  • Example Usage
  • Arguments Reference
• Provider Resources
  • openapi_cdn_v1
  • openapi_cdn_v1_firewalls_v1
  • openapi_lbs_v1
  • openapi_monitors_v1_dub1
  • openapi_monitors_v1_rst1
  • openapi_multiregionmonitors_v1
• Data Sources (using resource id)
  • openapi_cdn_v1_firewalls_v1_instance
  • openapi_cdn_v1_instance
  • openapi_lbs_v1_instance
  • openapi_monitors_v1_dub1_instance
  • openapi_monitors_v1_rst1_instance
  • openapi_multiregionmonitors_v1_instance
• Data Sources (using filters)

Provider Installation

In order to provision 'openapi' Terraform resources, you need to first install the 'openapi' Terraform plugin by running the following command (you must be running Terraform >= 0.12):

$ export PROVIDER_NAME=openapi && curl -fsSL https://raw.githubusercontent.com/dikhan/terraform-provider-openapi/master/scripts/install.sh | bash -s -- --provider-name $PROVIDER_NAME
[INFO] Downloading https://github.com/dikhan/terraform-provider-openapi/v2/releases/download/v0.29.4/terraform-provider-openapi_0.29.4_darwin_amd64.tar.gz in temporally folder /var/folders/n_/1lrwb99s7f50xmn9jpmfnddh0000gp/T/tmp.Xv1AkIZh...
[INFO] Extracting terraform-provider-openapi from terraform-provider-openapi_0.29.4_darwin_amd64.tar.gz...
[INFO] Cleaning up tmp dir created for installation purposes: /var/folders/n_/1lrwb99s7f50xmn9jpmfnddh0000gp/T/tmp.Xv1AkIZh
[INFO] Terraform provider 'terraform-provider-openapi' successfully installed at: '~/.terraform.d/plugins'!

You can then start running the Terraform provider:

$ export OTF_VAR_openapi_PLUGIN_CONFIGURATION_FILE="https://api.service.com/openapi.yaml"

➜ ~ terraform init && terraform plan

Note: As of Terraform >= 0.13 each Terraform module must declare which providers it requires, so that Terraform can install and use them. If you are using Terraform >= 0.13, copy into your .tf file the following snippet already populated with the provider configuration:

terraform {
  required_providers {
    openapi = {
      source  = "terraform.example.com/examplecorp/openapi"
      version = ">= 2.0.1" 
    }
  }
}

Provider Configuration

Example Usage

provider "openapi" {
  apikey_auth  = "..."
  x_request_id  = "..."
}

Using the default region (rst1):

provider "openapi" {
  # Resources using this default provider will be created in the 'rst1' region
  ...
}
    

Using a specific region (dub1):

provider "openapi" {
  alias  = "dub1"
  region = "dub1"
  ...
}

resource"openapi_resource" "my_resource" {
  provider = "openapi.dub1"
  ...
}
    

Arguments Reference

The following arguments are supported:

• apikey_auth [string] - (Required) .
• x_request_id [string] - (Required) .
• region [string] - (Optional) The region location to be used ([rst1 dub1]). If region isn't specified, the default is "rst1".

Provider Resources

openapi_cdn_v1

Example usage

resource "openapi_cdn_v1" "my_cdn_v1"{
    hostnames  = ["hostnames1", "hostnames2"]
    label  = "label"
    ips  = ["ips1", "ips2"]
}

Arguments Reference

The following arguments are supported:

• hostnames [list of strings] - (Required)
• label [string] - (Required)
• ips [list of strings] - (Required)
• optional_computed [string] - (Optional)
• optional_property [string] - (Optional)
• example_boolean [boolean] - (Optional)
• * object_nested_scheme_property [object] - (Optional) . The following properties compose the object schema :
  • * object_property [object] - (Optional) . The following properties compose the object schema :
    • account [string] - (Optional)
• better_example_number_field_name [number] - (Optional)
• example_int [integer] - (Optional)
• * object_property [object] - (Optional) . The following properties compose the object schema :
  • detailed_message [string] - (Required)
  • example_number [number] - (Required)
  • example_int [integer] - (Required)
  • message [string] - (Required)
  • example_boolean [boolean] - (Required)
• array_of_objects_example [list of objects] - (Optional) . The following properties compose the object schema :
  • protocol [string] - (Optional)
  • origin_port [integer] - (Optional)

* Note: Object type properties are internally represented (in the state file) as a list of one elem due to Terraform SDK's limitation for supporting complex object types. Please index on the first elem of the array to reference the object values (eg: openapi_cdn_v1.my_cdn_v1.object_property[0].object_property)

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• optional_computed_with_default [string]
• optional_computed [string]
• computed_with_default [string]
• * object_nested_scheme_property [object] The following properties compose the object schema:
  • name [string]
• id [string]
• computed [string]

* Note: Object type properties are internally represented (in the state file) as a list of one elem due to Terraform SDK's limitation for supporting complex object types. Please index on the first elem of the array to reference the object values (eg: openapi_cdn_v1.my_cdn_v1.object_property[0].object_property)

Import

cdn_v1 resources can be imported using the id , e.g:

$ terraform import openapi_cdn_v1.my_cdn_v1 id

Note: In order for the import to work, the 'openapi' terraform provider must be properly installed. Read more about Terraform import usage here.

openapi_cdn_v1_firewalls_v1

Example usage

resource "openapi_cdn_v1_firewalls_v1" "my_cdn_v1_firewalls_v1"{
    name  = "name"
    cdn_v1_id  = "cdn_v1_id"
}

Arguments Reference

The following arguments are supported:

• name [string] - (Required)
• cdn_v1_id [string] - (Required) The cdn_v1_id that this resource belongs to

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]

Import

cdn_v1_firewalls_v1 resources can be imported using the id . This is a sub-resource so the parent resource IDs ([cdn_v1_id]) are required to be able to retrieve an instance of this resource, e.g:

$ terraform import openapi_cdn_v1_firewalls_v1.my_cdn_v1_firewalls_v1 cdn_v1_id/cdn_v1_firewalls_v1_id

Note: In order for the import to work, the 'openapi' terraform provider must be properly installed. Read more about Terraform import usage here.

openapi_lbs_v1

Example usage

resource "openapi_lbs_v1" "my_lbs_v1"{
    name  = "name"
    backends  = ["backends1", "backends2"]
}

Arguments Reference

The following arguments are supported:

• name [string] - (Required)
• backends [list of strings] - (Required)
• simulate_failure [boolean] - (Optional)

* Note: Object type properties are internally represented (in the state file) as a list of one elem due to Terraform SDK's limitation for supporting complex object types. Please index on the first elem of the array to reference the object values (eg: openapi_lbs_v1.my_lbs_v1.new_status[0].object_property)

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• status [string] - lb resource status
• id [string]
• time_to_process [integer]

* Note: Object type properties are internally represented (in the state file) as a list of one elem due to Terraform SDK's limitation for supporting complex object types. Please index on the first elem of the array to reference the object values (eg: openapi_lbs_v1.my_lbs_v1.new_status[0].object_property)

Import

lbs_v1 resources can be imported using the id , e.g:

$ terraform import openapi_lbs_v1.my_lbs_v1 id

Note: In order for the import to work, the 'openapi' terraform provider must be properly installed. Read more about Terraform import usage here.

openapi_monitors_v1_dub1

Example usage

resource "openapi_monitors_v1_dub1" "my_monitors_v1_dub1"{
    name  = "name"
}

Arguments Reference

The following arguments are supported:

• name [string] - (Required)

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]

Import

monitors_v1_dub1 resources can be imported using the id , e.g:

$ terraform import openapi_monitors_v1_dub1.my_monitors_v1_dub1 id

Note: In order for the import to work, the 'openapi' terraform provider must be properly installed. Read more about Terraform import usage here.

openapi_monitors_v1_rst1

Example usage

resource "openapi_monitors_v1_rst1" "my_monitors_v1_rst1"{
    name  = "name"
}

Arguments Reference

The following arguments are supported:

• name [string] - (Required)

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]

Import

monitors_v1_rst1 resources can be imported using the id , e.g:

$ terraform import openapi_monitors_v1_rst1.my_monitors_v1_rst1 id

Note: In order for the import to work, the 'openapi' terraform provider must be properly installed. Read more about Terraform import usage here.

openapi_multiregionmonitors_v1

Example usage

resource "openapi_multiregionmonitors_v1" "my_multiregionmonitors_v1"{
    name  = "name"
}

Arguments Reference

The following arguments are supported:

• name [string] - (Required)

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]

Import

multiregionmonitors_v1 resources can be imported using the id , e.g:

$ terraform import openapi_multiregionmonitors_v1.my_multiregionmonitors_v1 id

Note: In order for the import to work, the 'openapi' terraform provider must be properly installed. Read more about Terraform import usage here.

Data Sources (using resource id)

openapi_cdn_v1_firewalls_v1_instance

Retrieve an existing resource using it's ID

Example usage

data "openapi_cdn_v1_firewalls_v1_instance" "my_cdn_v1_firewalls_v1_instance"{
    id = "existing_resource_id"
}

Arguments Reference

The following arguments are supported:

• id - (Required) ID of the existing resource to retrieve

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]
• name [string]

openapi_cdn_v1_instance

Retrieve an existing resource using it's ID

Example usage

data "openapi_cdn_v1_instance" "my_cdn_v1_instance"{
    id = "existing_resource_id"
}

Arguments Reference

The following arguments are supported:

• id - (Required) ID of the existing resource to retrieve

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• array_of_objects_example [list of objects] The following properties compose the object schema:
  • protocol [string]
  • origin_port [integer]
• ips [list of strings]
• example_boolean [boolean]
• optional_computed [string]
• * object_property [object] The following properties compose the object schema:
  • message [string]
  • example_boolean [boolean]
  • example_int [integer]
  • detailed_message [string]
  • example_number [number]
• optional_property [string]
• * object_nested_scheme_property [object] The following properties compose the object schema:
  • name [string]
  • * object_property [object] The following properties compose the object schema:
    • account [string]
• better_example_number_field_name [number]
• computed_with_default [string]
• id [string]
• computed [string]
• label [string]
• example_int [integer]
• optional_computed_with_default [string]
• hostnames [list of strings]

* Note: Object type properties are internally represented (in the state file) as a list of one elem due to Terraform SDK's limitation for supporting complex object types. Please index on the first elem of the array to reference the object values (eg: openapi_cdn_v1_instance.my_cdn_v1_instance.object_nested_scheme_property[0].object_property)

openapi_lbs_v1_instance

Retrieve an existing resource using it's ID

Example usage

data "openapi_lbs_v1_instance" "my_lbs_v1_instance"{
    id = "existing_resource_id"
}

Arguments Reference

The following arguments are supported:

• id - (Required) ID of the existing resource to retrieve

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• backends [list of strings]
• simulate_failure [boolean]
• time_to_process [integer]
• status [string] - lb resource status
• id [string]
• name [string]
• * new_status [object] The following properties compose the object schema:
  • status [string]
  • message [string]

* Note: Object type properties are internally represented (in the state file) as a list of one elem due to Terraform SDK's limitation for supporting complex object types. Please index on the first elem of the array to reference the object values (eg: openapi_lbs_v1_instance.my_lbs_v1_instance.new_status[0].object_property)

openapi_monitors_v1_dub1_instance

Retrieve an existing resource using it's ID

Example usage

data "openapi_monitors_v1_dub1_instance" "my_monitors_v1_dub1_instance"{
    id = "existing_resource_id"
}

Arguments Reference

The following arguments are supported:

• id - (Required) ID of the existing resource to retrieve

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]
• name [string]

openapi_monitors_v1_rst1_instance

Retrieve an existing resource using it's ID

Example usage

data "openapi_monitors_v1_rst1_instance" "my_monitors_v1_rst1_instance"{
    id = "existing_resource_id"
}

Arguments Reference

The following arguments are supported:

• id - (Required) ID of the existing resource to retrieve

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]
• name [string]

openapi_multiregionmonitors_v1_instance

Retrieve an existing resource using it's ID

Example usage

data "openapi_multiregionmonitors_v1_instance" "my_multiregionmonitors_v1_instance"{
    id = "existing_resource_id"
}

Arguments Reference

The following arguments are supported:

• id - (Required) ID of the existing resource to retrieve

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id [string]
• name [string]

Data Sources (using filters)