The Application Load Balancer data source can be used to search for and return an existing Application Load Balancer. You can provide a string for the name parameter which will be compared with provisioned Application Load Balancers. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

Example Usage

By Id

data "ionoscloud_application_loadbalancer" "example" {
  datacenter_id = ionoscloud_datacenter.example.id
  id            = <alb_id>
}

By Name

data "ionoscloud_application_loadbalancer" "example" {
  datacenter_id = ionoscloud_datacenter.example.id
  name          = "ALB name"
}

By Name with Partial Match

data "ionoscloud_application_loadbalancer" "example" {
  datacenter_id = ionoscloud_datacenter.example.id
  name          = "name"
  partial_match = true
}

Argument Reference

• datacenter_id - (Required) Datacenter's UUID.

• id - (Optional) ID of the application load balancer you want to search for.

• name - (Optional) Name of an existing application load balancer that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

datacenter_id and either name or id must be provided. If none, or both of name and id are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - Id of the application load balancer.

• name - The name of the Application Load Balancer.

• listener_lan - ID of the listening (inbound) LAN.

• ips - Collection of the Application Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan are customer-reserved public IPs for the public Load Balancers, and private IPs for the private Load Balancers.

• target_lan - ID of the balanced private target LAN (outbound).

• lb_private_ips - Collection of private IP addresses with the subnet mask of the Application Load Balancer. IPs must contain valid a subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.

• central_logging - Turn logging on and off for this product. Default value is 'false'.

• logging_lormat - Specifies the format of the logs.

• flowlog - Only 1 flow log can be configured. Only the name field can change as part of an update. Flow logs holistically capture network information such as source and destination IP addresses, source and destination ports, number of packets, amount of bytes, the start and end time of the recording, and the type of protocol – and log the extent to which your instances are being accessed.

  • action - Specifies the action to be taken when the rule is matched. Possible values: ACCEPTED, REJECTED, ALL. Immutable, forces re-creation.

  • bucket - Specifies the IONOS Object Storage bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.

  • direction - Specifies the traffic direction pattern. Valid values: INGRESS, EGRESS, BIDIRECTIONAL. Immutable, forces re-creation.

  • name - Specifies the name of the flow log.

The API Gateway Route data source can be used to search for and return an existing API Gateway route. You can provide a string for the name parameter which will be compared with provisioned API Gateway routes. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

data "ionoscloud_apigateway_route" "example" {
  id = <your_apigateway_route_id>
  gateway_id = <your_gateway_id>
}

By Name

Needs to have the resource be previously created, or a depends_on clause to ensure that the resource is created before this data source is called.

data "ionoscloud_apigateway_route" "example" {
  name       = "apigateway-route"
  gateway_id = <your_gateway_id>
}

Argument Reference

• id - (Optional) ID of an existing API Gateway Route that you want to search for.

• name - (Optional) Name of an existing API Gateway Route that you want to search for.

• gateway_id - (Required) The ID of the API Gateway that the route belongs to.

Attributes Reference

The following attributes are returned by the datasource:

• id - ID of the API Gateway Route.

• name - The name of the API Gateway Route.

• websocket - Shows whether websocket support is enabled or disabled.

• type - This field specifies the protocol used by the ingress to route traffic to the backend service.

• paths - The paths that the route should match.

• methods - The HTTP methods that the route should match.

• upstreams:

  • scheme - The target URL of the upstream.

  • loadbalancer - The load balancer algorithm.

  • host - The host of the upstream.

  • port - The port of the upstream.

  • weight - Weight with which to split traffic to the upstream.

The IonosCloud provider gives the ability to deploy and configure resources using the IonosCloud APIs.

Use the navigation to the left to read about the available data sources and resources.

Using the provider

The provider needs to be configured with proper credentials before it can be used.

You can use token authentication. We strongly suggest to use token authentication for security purposes. Details on how to generate your token here:

export IONOS_TOKEN="token"

You can set the environment variables for HTTP basic authentication:

export IONOS_USERNAME="username"
export IONOS_PASSWORD="password"

For managing IONOS Object Storage resources you need to set the following environment variables with your credentials

export IONOS_S3_ACCESS_KEY="accesskey"
export IONOS_S3_SECRET_KEY="secretkey"

Also, you can overwrite the api endpoint: api.ionos.com via the following environment variable:

export IONOS_API_URL="api-url"

Note: if IONOS_API_URL environment variable is set, it is recommended to have the api.ionos.com value (not api.ionos.com/cloudapi/v5).

Another way of configuring it, is by providing your credentials/api_url in a .tf configuration file in the provider block as shown in the below example.

provider "ionoscloud" {
#  we encourage users to use token authentication for security reasons
#  username          = var.ionos_username
#  password          = var.ionos_password
  token             = var.ionos_token
#  optional, to be used only for reseller accounts
#  contract_number = "contract_number_here"
#  optional, does not need to be configured in most cases
#  endpoint = "custom_cloud_api_url"
#  s3_access_key     =  <your_access_key>
#  s3_secret_key     =  <your_secret_key>

⚠️ Note: It's NOT usually necessary to set endpoint field. The SDKs the terraform uses know how to route requests to the correct endpoints in the API.

You can either explicitly write them in the .tf file or use var.name as in the example above. For setting the var.name, environment variables can be used. The environment variables must be in the format TF_VAR_name and this will be checked last for a value. For example:

export TF_VAR_ionos_token="token"
#export TF_VAR_ionos_username="username"
#export TF_VAR_ionos_password="password"
#export TF_VAR_ionos_s3_access_key="accesskey"
#export TF_VAR_ionos_s3_secret_key="secretkey"
#export TF_VAR_ionos_s3_region="region"

Example Usage

terraform {
  required_providers {
    ionoscloud = {
      source = "ionos-cloud/ionoscloud"
      version = ">= 6.4.10"
    }
  }
}

provider "ionoscloud" {
  token                = var.ionos_token
  #  we encourage users to use token authentication
  #  username          = var.ionos_username
  #  password          = var.ionos_password
  #  optional, to be used only for reseller accounts
  #  contract_number = "contract_number_here"
  #  optional, does not need to be configured in most cases
  #  endpoint = "custom_cloud_api_url"
  #  s3_access_key     =  <your_access_key>
  #  s3_secret_key     =  <your_secret_key>
  #  s3_region     =  <your_bucket_region>
}

resource "ionoscloud_datacenter" "main" {
  # ...
}

Important Notes

• The required_providers section needs to be specified in order for terraform to be able to find and download the ionoscloud provider

• The credentials provided in a .tf file will override the credentials from environment variables.

Configuration Reference

The following arguments are supported:

• token - Required if username and password are not set. If omitted, the IONOS_TOKEN environment variable is used.

• username - Required if token is not set. If omitted, the IONOS_USERNAME environment variable is used. The username is generally an e-mail address in 'username@domain.tld' format.

• password - Required if token is not set. If omitted, the IONOS_PASSWORD environment variable is used.

• endpoint - (Optional) Usually not necessary to be set, SDks know internally how to route requests to the API. If omitted, the IONOS_API_URL environment variable is used, or it defaults to the current Cloud API release.

• retries - (Deprecated) Number of retries while waiting for a resource to be provisioned. Default value is 50. Note: This argument has been deprecated and replaced by the implementation of resource timeouts described below.

• contract_number - "To be set only for reseller accounts. Allows to run terraform on a contract number under a reseller account.",

• s3_access_key - Required for managing IONOS Object Storage resources.

• s3_secret_key - Required for managing IONOS Object Storage resources.

• s3_region - Optional, defines the region of the Object Storage resource.

Environment Variables

Resource Timeout

Individual resources may provide a timeouts block to configure the amount of time a specific operation is allowed to take before being considered an error. Each resource may provide configurable timeouts for the create, update, and delete operations. Each resource that supports timeouts will have or inherit default values for that operation. Users can overwrite the default values for a specific resource in the configuration.

The default timeouts values are:

• create - (Default 60 minutes) Used for creating a resource.

• update - (Default 60 minutes) Used for updating a resource .

• delete - (Default 60 minutes) Used for destroying a resource.

• default - (Default 60 minutes) Used for every other action on a resource.

An example of overwriting the create, update, and delete timeouts:

resource "ionoscloud_server" "example" {
    name                  = "Server Example"
    datacenter_id         = ionoscloud_datacenter.example.id
    cores                 = 1
    ram                   = 1024
    availability_zone     = "ZONE_1"
    cpu_family            = "INTEL_XEON"
    image_name            = data.ionoscloud_image.example.id
    image_password        = random_password.server_image_password.result
    type                  = "ENTERPRISE"
    volume {
        name              = "system"
        size              = 5
        disk_type         = "SSD Standard"
        user_data         = "foo"
        bus               = "VIRTIO"
        availability_zone = "ZONE_1"
    }
    nic {
        lan               = ionoscloud_lan.example.id
        name              = "system"
        dhcp              = true
        firewall_active   = true
        firewall_type     = "BIDIRECTIONAL"
        ips               = [ ionoscloud_ipblock.example.ips[0], ionoscloud_ipblock.example.ips[1] ]
        firewall {
            protocol          = "TCP"
            name              = "SSH"
            port_range_start  = 22
            port_range_end    = 22
            source_mac        = "00:0a:95:9d:68:17"
            source_ip         = ionoscloud_ipblock.example.ips[2]
            target_ip         = ionoscloud_ipblock.example.ips[3]
            type              = "EGRESS"
        }
    }
    timeouts {
      create = "30m"
      update = "300s"
      delete = "2h"
    }
}

resource "random_password" "server_image_password" {
  length           = 16
  special          = false
}

Valid units of time should be expressed in "s", "m", "h" for "seconds", "minutes", and "hours" respectively.

Individual resources must opt-in to providing configurable timeouts, and attempting to configure values for a resource that does not support timeouts, or overwriting a specific action that the resource does not specify as an option, will result in an error.

~> Note: Terraform does not automatically rollback in the face of errors. Instead, your Terraform state file will be partially updated with any resources that successfully completed.

Debugging

In the default mode, the Terraform provider returns only HTTP client errors. These usually consist only of the HTTP status code. There is no clear description of the problem. But if you want to see the API call error messages as well, you need to set the SDK and Terraform provider environment variables.

You can enable logging now using the IONOS_LOG_LEVEL env variable. Allowed values: off, debug and trace. Defaults to off.

⚠️ Note: We recommend you only use trace level for debugging purposes. Disable it in your production environments because it can log sensitive data. It logs the full request and response without encryption, even for an HTTPS call. Verbose request and response logging can also significantly impact your application’s performance.

$ export IONOS_LOG_LEVEL=debug

⚠️ Note: IONOS_DEBUG is now deprecated and will be removed in a future release.

⚠️ Note: We recommend you only use IONOS_DEBUG for debugging purposes. Disable it in your production environments because it can log sensitive data. It logs the full request and response without encryption, even for an HTTPS call. Verbose request and response logging can also significantly impact your application’s performance.

$ export TF_LOG=debug
$ export IONOS_DEBUG=true
$ terraform apply

now you can see the response body incl. api error message:

{
  "httpStatus" : 422,
  "messages" : [ {
    "errorCode" : "200",
    "message" : "[VDC-yy-xxxx] Operation cannot be executed since this Kubernetes Nodepool is already marked for deletion. Current state of the resource is FAILED_DESTROYING."
  }]
}

Migrating from the ProfitBricks provider

This area is not necessary unless you were using the old profitbricks provider

Provider Name in HCL files

The provider name changed from profitbricks to ionoscloud. This reflects in the following change in your terraform hcl files: provider "profitbricks" becomes provider "ionoscloud"

Environment Variables

The following env variables have changed:

Resources and Datasources in HCL files

The migration affects resource names and datasource names. Every resource and datasource changed its prefix from profitbricks_ to ionoscloud_.

In order to accommodate that, the terraform hcl files must be updated.

This can be done with a simple find and replace procedure. For example, on Linux, sed can be used:

$ sed -i 's/profitbricks_/ionoscloud_/g' ./main.tf

On OSX the same command becomes:

$ sed -i bak 's/profitbricks_/ionoscloud_/g' ./main.tf

Terraform State

Because of the name changes of resources and datasources, the terraform state must also be updated. The local state, in json format, can be updated by replacing profitbricks_ with ionoscloud_ directly in the state file. For example, on Linux, using:

$ sed -i 's/profitbricks_/ionoscloud_/g' ./terraform.tfstate

On OSX the same command becomes:

$ sed -i bak 's/profitbricks_/ionoscloud_/g' ./terraform.tfstate

The provider entries must also be updated. For example:

"provider": "provider[\"registry.terraform.io/hashicorp/profitbricks\"]"

becomes

"provider": "provider[\"registry.terraform.io/hashicorp/ionoscloud\"]"

If you manage your state using remote backends you need to take the appropriate steps specific to your backend.

The Application Load Balancer Forwarding Rule data source can be used to search for and return an existing Application Load Balancer Forwarding Rules. You can provide a string for the name parameter which will be compared with provisioned Application Load Balancers Forwarding Rules. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

Example Usage

By Id

data "ionoscloud_application_loadbalancer_forwardingrule" "example" {
  datacenter_id = ionoscloud_datacenter.example.id
  application_loadbalancer_id = ionoscloud_application_loadbalancer.example.id
  id    		= <alb_fwr_id>
}

By Name

data "ionoscloud_application_loadbalancer_forwardingrule" "example" {
  datacenter_id               = ionoscloud_datacenter.example.id
  application_loadbalancer_id = ionoscloud_application_loadbalancer.example.id
  name    		              = "ALB FR Example"
}

By Name with Partial Match

data "ionoscloud_application_loadbalancer_forwardingrule" "example" {
  datacenter_id               = ionoscloud_datacenter.example.id
  application_loadbalancer_id = ionoscloud_application_loadbalancer.example.id
  name    		              = "Example"
  partial_match               = true
}

Argument Reference

• datacenter_id - (Required) Datacenter's UUID.

• application_loadbalancer_id - (Required) Application Load Balancer's UUID.

• id - (Optional) ID of the application load balancer you want to search for.

• name - (Optional) Name of an existing application load balancer that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

Both datacenter_id and application_loadbalancer_id and either name or id must be provided. If none, or both of name and id are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - Id of Application Load Balancer Forwarding Rule

• name - The name of the Application Load Balancer forwarding rule.

• protocol - Balancing protocol.

• listener_ip - Listening (inbound) IP.

• listener_port - Listening (inbound) port number; valid range is 1 to 65535.

• client_timeout - The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).

• server certificates - Array of items in that collection.

• http_rules - Array of items in that collection

  • name - The unique name of the Application Load Balancer HTTP rule.

  • type - Type of the Http Rule.

  • target_group - The UUID of the target group; mandatory for FORWARD action.

  • drop_query - Default is false; valid only for REDIRECT actions.

  • location - The location for redirecting; mandatory and valid only for REDIRECT actions.

  • status_code - Valid only for REDIRECT and STATIC actions. For REDIRECT actions, default is 301 and possible values are 301, 302, 303, 307, and 308. For STATIC actions, default is 503 and valid range is 200 to 599.

  • response_message - The response message of the request; mandatory for STATIC action.

  • content_type - Valid only for STATIC actions.

  • conditions - An array of items in the collection.The action is only performed if each and every condition is met; if no conditions are set, the rule will always be performed.

    • type - Type of the Http Rule condition.

    • condition - Matching rule for the HTTP rule condition attribute; mandatory for HEADER, PATH, QUERY, METHOD, HOST, and COOKIE types; must be null when type is SOURCE_IP.

    • negate - Specifies whether the condition is negated or not; the default is False.

    • key - Must be null when type is PATH, METHOD, HOST, or SOURCE_IP. Key can only be set when type is COOKIES, HEADER, or QUERY.

    • value - Mandatory for conditions CONTAINS, EQUALS, MATCHES, STARTS_WITH, ENDS_WITH; must be null when condition is EXISTS; should be a valid CIDR if provided and if type is SOURCE_IP.

The autoscaling group data source can be used to search for and return an existing Autoscaling Group. You can provide a string for the name or id parameters which will be compared with provisioned Autoscaling Groups. If a single match is found, it will be returned.

Example Usage

By Id

data "ionoscloud_autoscaling_group" "autoscaling_group" {
  id = <autoscaling_group_uuid>
}

By Name

data "ionoscloud_autoscaling_group" "autoscaling_group" {
  name = "test_ds"
}

Argument Reference

• id - (Optional) Id of an existing Autoscaling Group that you want to search for.

• name - (Optional) Name of an existing Autoscaling Group that you want to search for.

Either name or id must be provided. If none or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - UUID of the Autoscaling Group.

• name - The name of the Autoscaling Group.

• datacenter - VMs for this Autoscaling Group will be created in this Virtual Datacenter. Please note, that it has to have the same location as the template.

  • href - Absolute URL to the resource's representation

  • type - Type of resource

  • id - Unique identifier for the resource

• location - Location of the datacenter. This location is the same as the one from the selected template.

• max_replica_count - Maximum replica count value for targetReplicaCount. Will be enforced for both automatic and manual changes.

• min_replica_count - Minimum replica count value for targetReplicaCount. Will be enforced for both automatic and manual changes.

• policy - Specifies the behavior of this Autoscaling Group. A policy consists of Triggers and Actions, whereby an Action is some kind of automated behavior, and a Trigger is defined by the circumstances under which the Action is triggered. Currently, two separate Actions, namely Scaling In and Out are supported, triggered through Thresholds defined on a given Metric.

  • metric - The Metric that should trigger Scaling Actions. The values of the Metric are checked in fixed intervals.

  • range - Defines the range of time from which samples will be aggregated. Default is 120s. Note that when you set it to values like 5m the API will automatically transform it in PT5M, so the plan will show you a diff in state that should be ignored.

  • scale_in_action - Specifies the Action to take when the scaleInThreshold

    • amount - When amountType == ABSOLUTE, this is the number of VMs added or removed in one step. When amountType == PERCENTAGE, this is a percentage value, which will be applied to the Autoscaling Group's current targetReplicaCount in order to derive the number of VMs that will be added or removed in one step. There will always be at least one VM added or removed.

    • amount_type - The type for the given amount. Possible values are: [ABSOLUTE, PERCENTAGE].

    • cooldown_period - Minimum time to pass after this Scaling Action has started, until the next Scaling Action will be started. Additionally, if a Scaling Action is currently in progress, no second Scaling Action will be started for the same Autoscaling Group. Instead, the Metric will be re-evaluated after the current Scaling Action completed (either successful or with failures). Note that when you set it to values like 5m the API will automatically transform it in PT5M, so the plan will show you a diff in state that should be ignored.

  • scale_in_threshold - A lower threshold on the value of metric. Will be used with less than (<) operator. Exceeding this will start a Scale-In Action as specified by the scaleInAction property. The value must have a higher minimum delta to the scaleOutThreshold depending on the metric to avoid competitive actions at the same time.

  • scale_out_action - Specifies the action to take when the scaleOutThreshold is exceeded. Hereby, scaling out is always about adding new VMs to this autoscaling group

    • amount - When amountType == ABSOLUTE, this is the number of VMs added or removed in one step. When amountType == PERCENTAGE, this is a percentage value, which will be applied to the Autoscaling Group's current targetReplicaCount in order to derive the number of VMs that will be added or removed in one step. There will always be at least one VM added or removed.

    • amount_type - The type for the given amount. Possible values are: [ABSOLUTE, PERCENTAGE].

    • cooldown_period - Minimum time to pass after this Scaling Action has started, until the next Scaling Action will be started. Additionally, if a Scaling Action is currently in progress, no second Scaling Action will be started for the same Autoscaling Group. Instead, the Metric will be re-evaluated after the current Scaling Action completed (either successful or with failures). Note that when you set it to values like 5m the API will automatically transform it in PT5M, so the plan will show you a diff in state that should be ignored.

  • scale_out_threshold - The upper threshold for the value of the metric. Used with the greater than (>) operator. A scale-out action is triggered when this value is exceeded, specified by the scaleOutAction property. The value must have a lower minimum delta to the scaleInThreshold, depending on the metric, to avoid competing for actions simultaneously. If properties.policy.unit=TOTAL, a value >= 40 must be chosen.

  • unit - Specifies the Action to take when the scaleInThreshold is exceeded. Hereby, scaling in is always about removing VMs that are currently associated with this Autoscaling Group.

• template - VMs for this Autoscaling Group will be created using this Template.

  • href - Absolute URL to the resource's representation

  • type - Type of resource

  • id - Unique identifier for the resource

The Distribution data source can be used to search for and return an existing Distributions. You can provide a string for the domain parameter which will be compared with provisioned Distributions. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique domains.

Example Usage

By Id

data "ionoscloud_cdn_distribution" "example" {
  id = <distr_id>
}

By Domain

data "ionoscloud_cdn_distribution" "example" {
  domain = "example.com"
}

By Domain with Partial Match

data "ionoscloud_cdn_distribution" "example" {
  domain    		= "example"
  partial_match = true
}

Argument Reference

• id - (Optional) ID of the distribution you want to search for.

• domain - (Optional) Domain of an existing distribution that you want to search for. Search by domain is case-insensitive. The whole resource domain is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using domain argument. Default value is false.

Either domain or id must be provided. If none, or both of domain and id are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• domain - The domain of the distribution.

• certificate_id - The ID of the certificate to use for the distribution. You can create certificates with the certificate resource.

• routing_rules - The routing rules for the distribution.

  • scheme - The scheme of the routing rule.

  • prefix - The prefix of the routing rule.

  • upstream - A map of properties for the rule

    • host - The upstream host that handles the requests if not already cached. This host will be protected by the WAF if the option is enabled.

    • caching - Enable or disable caching. If enabled, the CDN will cache the responses from the upstream host. Subsequent requests for the same resource will be served from the cache.

    • waf - Enable or disable WAF to protect the upstream host.

    • sni_mode - The SNI (Server Name Indication) mode of the upstream. It supports two modes: 1) distribution: for outgoing connections to the upstream host, the CDN requires the upstream host to present a valid certificate that matches the configured domain of the CDN distribution; 2) origin: for outgoing connections to the upstream host, the CDN requires the upstream host to present a valid certificate that matches the configured upstream/origin hostname.

    • rate_limit_class - Rate limit class that will be applied to limit the number of incoming requests per IP.

    • geo_restrictions - A map of geo_restrictions

      • allow_list - List of allowed countries

      • block_list - List of blocked countries

• public_endpoint_v4 - IP of the distribution, it has to be included on the domain DNS Zone as A record.

• public_endpoint_v6 - IP of the distribution, it has to be included on the domain DNS Zone as AAAA record.

• resource_urn - Unique resource identifier.

The API Gateway data source can be used to search for and return an existing API Gateway. You can provide a string for the name parameter which will be compared with provisioned API Gateways. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

data "ionoscloud_apigateway" "example" {
    id = <your_apigateway_id>
}

By Name

Needs to have the resource be previously created, or a depends_on clause to ensure that the resource is created before this data source is called.

data "ionoscloud_apigateway" "example" {
    name = "example-apigateway"
}

Argument Reference

• id - (Optional) ID of an existing API Gateway that you want to search for.

• name - (Optional) Name of an existing API Gateway that you want to search for.

• partial_match - (Optional) Whether partial matching is allowed or not when using the name filter. Defaults to false.

Attributes Reference

The following attributes are returned by the datasource:

• id - ID of the API Gateway.

• name - The name of the API Gateway.

• logs - Shows whether the collection and reporting of logs for observability of this instance is enabled or disabled.

• metrics - Shows whether the collection and reporting of metrics for observability of this instance is enabled or disabled.

• custom_domains:

  • name - The domain name of the distribution.

  • certificate_id - The ID of the certificate to use for the distribution.

• public_endpoint - The public endpoint of the API Gateway.

The CM AutoCertificate data source can be used to search for and return an existing auto-certificate. You can provide a string for either id or name parameters which will be compared with provisioned auto-certificates. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

data "ionoscloud_auto_certificate" "example" {
  id			= <auto_certificate_id>
  location      = <auto_certificate_location>
}

By Name

data "ionoscloud_auto_certificate" "example" {
  name			= "AutoCertificate Name Example"
  location      = <auto_certificate_location>
}

Argument Reference

The following arguments are supported:

• location - (Required)[string] The location of the auto-certificate.

• name - (Optional)[string] Name of an existing auto-certificate that you want to search for.

• id - (Optional)[string] ID of the auto-certificate you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• common_name - [string] The common name (DNS) of the certificate to issue. The common name needs to be part of a zone in IONOS Cloud DNS.

• key_algorithm - [string] The key algorithm used to generate the certificate.

• subject_alternative_names - [list][string] Optional additional names to be added to the issued certificate. The additional names needs to be part of a zone in IONOS Cloud DNS.

• last_issued_certificate_id - [string] The ID of the last certificate that was issued.

The Backup Unit data source can be used to search for and return an existing Backup Unit. You can provide a string for either id or name parameters which will be compared with provisioned Backup Units. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

data "ionoscloud_backup_unit" "example" {
  id			= <backup_unit_id>
}

By Name

data "ionoscloud_backup_unit" "example" {
  name			= "Backup Unit Example"
}

Argument Reference

The following arguments are supported:

• name - (Optional) Name of an existing backup unit that you want to search for.

• id - (Optional) ID of the backup unit you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the Backup Unit.

• name - The name of the Backup Unit.

• email - The e-mail address you want assigned to the backup unit.

• login - The login associated with the backup unit. Derived from the contract number.

The Container Registry Locations data source can be used to get a list of Container Registry Locations

Example Usage

data "ionoscloud_container_registry_locations" "example" {
}

Attributes Reference

The following attributes are returned by the datasource:

• locations - list of container registry locations

The Container Registry Token data source can be used to search for and return an existing Container Registry Token. You can provide a string for the name parameter which will be compared with provisioned Container Registry Token. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

Example Usage

By Id

By Name

By Name with Partial Match

Argument Reference

• registry_id - (Required) Registry's UUID.

• id - (Optional) ID of the container registry token you want to search for.

• name - (Optional) Name of an existing container registry token that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

registry_id and either name or id must be provided. If none, or both of name and id are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - Id of the container registry token.

• name - The name of the container registry token.

• credentials

  • username

• expiry-date

• scopes

  • actions

  • name

  • type

• status

The Cube Server data source can be used to search for and return existing servers. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name

Argument Reference

• datacenter_id - (Required) Datacenter's UUID.

• name - (Optional) Name of an existing server that you want to search for.

• id - (Optional) ID of the server you want to search for.

datacenter_id and either name or id must be provided. If none, or both of name and id are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• template_uuid - The UUID of the template for creating a CUBE server; the available templates for CUBE servers can be found on the templates resource

• id - The id of that resource

• name - The name of that resource

• hostname - The hostname of the server

• type - Server usages: CUBE

• vm_state- Status of the virtual Machine

• datacenter_id - The id of the datacenter

• availability_zone - The availability zone in which the server should exist

• vm_state - Status of the virtual Machine

• boot_cdrom

• ram

• cores

• boot_volume

• boot_image

• token

• cdroms - list of

  • id - Id of the attached cdrom

  • name - The name of the attached cdrom

  • description - Description of cdrom

  • location - Location of that image/snapshot

  • size - The size of the image in GB

  • cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

  • cpu_hot_unplug - Is capable of CPU hot unplug (no reboot required)

  • ram_hot_plug - Is capable of memory hot plug (no reboot required)

  • ram_hot_unplug - Is capable of memory hot unplug (no reboot required)

  • nic_hot_plug - Is capable of nic hot plug (no reboot required)

  • nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

  • disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

  • disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required)

  • disc_scsi_hot_plug - Is capable of SCSI drive hot plug (no reboot required)

  • disc_scsi_hot_unplug - Is capable of SCSI drive hot unplug (no reboot required)

  • licence_type - OS type of this Image

  • image_type - Type of image

  • image_aliases - List of image aliases mapped for this Image

  • public - Indicates if the image is part of the public repository or not

  • image_aliases - List of image aliases mapped for this Image

  • cloud_init - Cloud init compatibility

• volumes - list of

  • id - Id of the attached volume

  • name - Name of the attached volume

  • type - Hardware type of the volume.

  • availability_zone - The availability zone in which the volume should exist

  • image - Image or snapshot ID to be used as template for this volume

  • image_password - Initial password to be set for installed OS

  • ssh_keys - Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key

  • bus - The bus type of the volume

  • licence_type - OS type of this volume

  • cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

  • ram_hot_plug - Is capable of memory hot plug (no reboot required)

  • nic_hot_plug - Is capable of nic hot plug (no reboot required)

  • nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

  • disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

  • disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required)

  • device_number - The Logical Unit Number of the storage volume

  • pci_slot - The PCI slot number of the storage volume

  • backup_unit_id - The uuid of the Backup Unit that user has access to

  • user_data - The cloud-init configuration for the volume as base64 encoded string

• nics - list of

  • id - Id of the attached nic

  • name - Name of the attached nid

  • mac - The MAC address of the NIC

  • ips - Collection of IP addresses assigned to a nic

  • dhcp - Indicates if the nic will reserve an IP using DHCP

  • lan - The LAN ID the NIC will sit on

  • firewall_active - Activate or deactivate the firewall

  • firewall_type - The type of firewall rules that will be allowed on the NIC

  • device_number - The Logical Unit Number (LUN) of the storage volume

  • pci_slot - The PCI slot number of the Nic

  • firewall_rules - list of

    • id - Id of the firewall rule

    • name - Name of the firewall rule

    • protocol - he protocol for the rule

    • source_mac - Only traffic originating from the respective MAC address is allowed

    • source_ip - Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs

    • target_ip - In case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed

    • icmp_code - Defines the allowed code (from 0 to 254) if protocol ICMP is chosen

    • icmp_type - Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen

    • port_range_start - Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen

    • port_range_end - Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen

    • type - The type of firewall rule

• security_groups_ids - The list of Security Group IDs for the resource.

The Datacenter data source can be used to search for and return an existing Virtual Data Center. You can provide a string for the name and location parameters which will be compared with provisioned Virtual Data Centers. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name & Location

Argument Reference

• id - (Optional) Id of an existing Virtual Data Center that you want to search for.

• name - (Optional) Name of an existing Virtual Data Center that you want to search for.

• location - (Optional) Id of the existing Virtual Data Center's location.

Either name, location or id must be provided. If none, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - UUID of the Virtual Data Center

• name - The name of the Virtual Data Center

• location - The regional location where the Virtual Data Center will be created

• description - Description for the Virtual Data Center

• version - The version of that Data Center. Gets incremented with every change

• features - List of features supported by the location this data center is part of

• sec_auth_protection - Boolean value representing if the data center requires extra protection e.g. two factor protection

• cpu_architecture - Array of features and CPU families available in a location

  • cpu_family - A valid CPU family name

  • max_cores - The maximum number of cores available

  • max_ram - The maximum number of RAM in MB

  • vendor - A valid CPU vendor name

The Container Registry data source can be used to search for and return an existing Container Registry. You can provide a string for the name parameter which will be compared with provisioned Container Registry. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

Example Usage

By Id

By Name

By Name with Partial Match

Argument Reference

• id - (Optional) ID of the container registry you want to search for.

• name - (Optional) Name of an existing container registry that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

Either name or id must be provided. If none, or both of name and id are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - Id of the container registry.

• name - The name of the container registry.

• location

• garbage_collection_schedule

  • time

  • days

• hostname

• api_subnet_allow_list - The subnet CIDRs that are allowed to connect to the registry. Specify "a.b.c.d/32" for an individual IP address. Note: If this list is empty or not set, there are no restrictions.

• maintenance_window

  • time

  • days

• storage_usage

  • bytes

  • updated_at

The CM Provider data source can be used to search for and return an existing certificate manager provider. You can provide a string for either id or name parameters which will be compared with provisioned providers. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name

Argument Reference

The following arguments are supported:

• location - (Required)[string] The location of the provider.

• name - (Optional)[string] Name of an existing provider that you want to search for.

• id - (Optional)[string] ID of the provider you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• email - [string] The email address of the certificate requester.

• server - [string] The URL of the certificate provider.

• external_account_binding - [list]

  • key_id - [string] The key ID of the external account binding.

  • key_secret - [string] The key secret of the external account binding

The Certificate data source can be used to search for and return an existing certificate. You can provide a string for either id or name parameters which will be compared with provisioned certificates. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name

Argument Reference

The following arguments are supported:

• name - (Optional) Name of an existing certificate that you want to search for.

• id - (Optional) ID of the certificate you want to search for.

Either name or id must be provided, or both. If none are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the certificate.

• name - The name of the certificate.

• certificate - Certificate body.

• certificate_chain - Certificate chain.

The autoscaling group servers data source can be used to search for and return existing servers that are part of a specific autoscaling group.

Example Usage

Argument Reference

• group_id - (Required) The unique ID of the autoscaling group.

group_id must be provided. If it is not provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• group_id - Id of the autoscaling group.

• servers - List of servers.

  • id - The unique ID of the server.

The Dataplatform Versions Data Source can be used to search for and retrieve list of available Managed Dataplatform API versions.

Example Usage

Retrieve list of Managed Dataplatform API versions

data "ionoscloud_dataplatform_versions" "example" {
}

Attributes Reference

The following attributes are returned by the datasource:

• versions - list of Managed Dataplatform API versions.

The ionoscloud_inmemorydb_snapshot data source can be used to retrieve information about an existing InMemoryDB Snapshot.

Example Usage

data "ionoscloud_inmemorydb_snapshot" "example" {
  id = "snapshot-id"
  location = "de/txl"
}

Argument Reference

• id - (Required) The ID of the InMemoryDB Snapshot.

• location - (Optional) The location of the InMemoryDB Snapshot.

Attributes Reference

• metadata - Metadata of the snapshot.

  • created_date - The ISO 8601 creation timestamp.

  • datacenter_id - The ID of the datacenter in which the snapshot is located.

  • last_modified_date - The ISO 8601 modified timestamp.

  • replica_set_id - The ID of the replica set from which the snapshot was created.

  • snapshot_time - The time at which the snapshot was taken.

The ionoscloud_inmemorydb_replicaset data source can be used to retrieve information about an existing InMemoryDB Replica Set.

Example Usage

By id

data "ionoscloud_inmemorydb_replicaset" "example" {
  id = "example-id"
  location = "es/vit"
}

By display_name

data "ionoscloud_inmemorydb_replicaset" "example" {
  display_name = "example-id"
  location = "us/las"
}

Argument Reference

• id - (Optional) The ID of the InMemoryDB Replica Set.

• display_name - (Optional) The display name of the InMemoryDB Replica Set.

• location - (Optional) The location of the InMemoryDB Replica Set.

Note: Either id or display_name must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• dns_name - [string] The DNS name pointing to your replica set. Will be used to connect to the active/standalone instance.

• connections - [object] The network connection for your replica set. Only one connection is allowed. It includes:

  • cidr - [string] The IP and subnet for your instance. Note the following unavailable IP ranges: 10.233.64.0/18, 10.233.0.0/18, 10.233.114.0/24.

  • datacenter_id - [string] The datacenter to connect your instance to.

  • lan_id - [string] The numeric LAN ID to connect your instance to.

• credentials - [object] Credentials for the InMemoryDB replicaset, only one type of password can be used since they are mutually exclusive. It includes:

  • username - [string] The username for the initial InMemoryDB user. Some system usernames are restricted (e.g. 'admin', 'standby').

• eviction_policy - [string] The eviction policy for the replica set, possible values are:

  • noeviction - No eviction policy is used. InMemoryDB will never remove any data. If the memory limit is reached, an error will be returned on write operations.

  • allkeys-lru - The least recently used keys will be removed first.

  • allkeys-lfu - The least frequently used keys will be removed first.

  • allkeys-random - Random keys will be removed.

  • volatile-lru - The least recently used keys will be removed first, but only among keys with the expire field set to true.

  • volatile-lfu - The least frequently used keys will be removed first, but only among keys with the expire field set to true.

  • volatile-random - Random keys will be removed, but only among keys with the expire field set to true.

  • volatile-ttl - The key with the nearest time to live will be removed first, but only among keys with the expire field set to true.

• maintenance_window - A weekly 4 hour-long window, during which maintenance might occur. It includes:

  • time - [string] Start of the maintenance window in UTC time.

  • day_of_the_week - [string] The name of the week day.

• persistence_mode - [string] Specifies How and If data is persisted, possible values are:

  • None - Data is inMemory only and will not be persisted. Useful for cache only applications.

  • AOF - (Append Only File) AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the InMemoryDB protocol itself.

  • RDB - RDB persistence performs snapshots of the current in memory state.

  • RDB_AOF - Both, RDB and AOF persistence are enabled.

• version - [string] The InMemoryDB version of your replica set.

• replicas - [int] The total number of replicas in the replica set (one active and n-1 passive). In case of a standalone instance, the value is 1. In all other cases, the value is > 1. The replicas will not be available as read replicas, they are only standby for a failure of the active instance.

• resources - [object] The resources of the individual replicas. It includes:

  • cores - [int] The number of CPU cores per instance.

  • ram - [int] The amount of memory per instance in gigabytes (GB).

  • storage - [int] The size of the storage in GB. The size is derived from the amount of RAM and the persistence mode and is not configurable.

The DBaaS MariaDB Cluster data source can be used to search for and return an existing DBaaS MariaDB Cluster.

Example Usage

By ID

data "ionoscloud_mariadb_cluster" "example" {
  id       = <cluster_id>
  location = "de/txl"
}

By Name

data "ionoscloud_mariadb_cluster" "example" {
  display_name = "MariaDB_cluster"
  location     = "de/txl"
}

Argument Reference

• display_name - (Optional)[string] Display Name of an existing cluster that you want to search for.

• id - (Optional)[string] ID of the cluster you want to search for.

• location- (Optional)[string] The location of the cluster. Different service endpoints are used based on location, possible options are: "de/fra", "de/txl", "es/vit", "fr/par", "gb/lhr", "us/ewr", "us/las", "us/mci". If not set, the endpoint will be the one corresponding to "de/txl".

⚠ WARNING: Location attribute will become required in the future.

Either display_name or id must be provided. If none or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• mariadb_version - [string] The MariaDB version of your cluster.

• instances - [int] The total number of instances in the cluster (one primary and n-1 secondary).

• cores - [int] The number of CPU cores per instance.

• ram - [int] The amount of memory per instance in gigabytes (GB).

• storage_size - [int] The amount of storage per instance in gigabytes (GB).

• connections - The network connection for your cluster. Only one connection is allowed.

  • datacenter_id - [string] The datacenter to connect your cluster to.

  • lan_id - [string] The LAN to connect your cluster to.

  • cidr - [string] The IP and subnet for your cluster.

• display_name - [string] The friendly name of your cluster.

• maintenance_window - A weekly 4 hour-long window, during which maintenance might occur.

  • time - [string] Start of the maintenance window in UTC time.

  • day_of_the_week - [string] The name of the week day.

• dns_name - [string] The DNS name pointing to your cluster.

The DbaaS Mongo Cluster data source can be used to search for and return an existing DbaaS MongoDB Cluster. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

data "ionoscloud_mongo_cluster" "example" {
  id	= <cluster_id>
}

By display_name

data "ionoscloud_mongo_cluster" "example" {
  display_name	= <display_name>
}

• display_name - (Optional) Display Name of an existing cluster that you want to search for.

• id - (Optional) ID of the cluster you want to search for.

Either display_name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• edition - Cluster edition. Playground, business or enterprise.

• mongodb_version - The MongoDB version of your cluster. Updates to the value of the field force the cluster to be re-created.

• template_id - The unique ID of the template, which specifies the number of cores, storage size, and memory. Updates to the value of the field force the cluster to be re-created.

• instances - The total number of instances in the cluster (one master and n-1 standbys). Example: 3, 5, 7. Updates to the value of the field force the cluster to be re-created.

• display_name - The name of your cluster. Updates to the value of the field force the cluster to be re-created.

• location - The connection string for your cluster. Updates to the value of the field force the cluster to be re-created.

• connections - Details about the network connection for your cluster. Updates to the value of the field force the cluster to be re-created.

  • datacenter_id - The datacenter to connect your cluster to.

  • lan_id - The LAN to connect your cluster to.

  • cidr - The IP and subnet for the database. Must be same number as instances. Note the following unavailable IP ranges: 10.233.64.0/18, 10.233.0.0/18, 10.233.114.0/24. Please input in the correct format like IP/Subnet, exp: 192.168.10.0/24. See Private IPs and Cluster Setup - Preparing the network.

  • whitelist - List of whitelisted CIDRs

• maintenance_window - A weekly 4 hour-long window, during which maintenance might occur. Updates to the value of the field force the cluster to be re-created.

  • time

  • day_of_the_week

• connection_string - The physical location where the cluster will be created. This will be where all of your instances live. Updates to the value of the field force the cluster to be re-created. Available locations: de/txl, gb/lhr, es/vit"

• ram - The amount of memory per instance in megabytes. Required for enterprise edition.

• storage_size - The amount of storage per instance in MB. Required for enterprise edition.

• storage_type - The storage type used in your cluster. Required for enterprise edition.

• cores - The number of CPU cores per replica. Required for enterprise edition.

• backup

  • location: The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster. Possible values are de, eu-south-2, or eu-central-2.

The Dataplatform Node Pool Data Source can be used to search for and return an existing Dataplatform Node Pool under a Dataplatform Cluster. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

Example Usage

By ID

data "ionoscloud_dataplatform_node_pool" "example" {
  cluster_id  = <cluster_id>
  id	      = <node_pool_id>
}

By Name

data "ionoscloud_dataplatform_node_pool" "example" {
  cluster_id    = <cluster_id>
  name      	= "Dataplatform_Node_Pool_Example"
}

By Name with Partial Match

data "ionoscloud_dataplatform_node_pool" "example" {
  cluster_id    = <cluster_id>
  name      	= "_Example"
  partial_match = true
}

Argument Reference

• cluster_id - (Required) ID of the cluster the searched node pool is part of.

• id - (Optional) ID of the node pool you want to search for.

• name - (Optional) Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

Either id or name must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• cluster_id - ID of the cluster the searched node pool is part of.

• datacenter_id - The UUID of the virtual data center (VDC) the cluster is provisioned.

• id - ID of your node pool.

• name - The name of your node pool

• version - The version of the Data Platform.

• node_count - The number of nodes that make up the node pool.

• cpu_family - A CPU family.

• cores_count - The number of CPU cores per node.

• ram_size - The RAM size for one node in MB.

• availability_zone - The availability zone of the virtual datacenter region where the node pool resources should be provisioned.

• storage_type - The type of hardware for the volume.

• storage_size - The size of the volume in GB.

• maintenance_window - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format

  • time - Time at which the maintenance should start.

  • day_of_the_week

• labels - Key-value pairs attached to the node pool resource as Kubernetes labels.

• annotations - Key-value pairs attached to node pool resource as Kubernetes annotations.

• auto_scaling - Whether the Node Pool should autoscale. For more details, please check the API documentation

  • min_node_count - The minimum number of worker nodes the node pool can scale down to. Should be less than max_node_count

  • max_node_count - The maximum number of worker nodes that the node pool can scale to. Should be greater than min_node_count

The DBaaS MariaDB Backups data source can be used to search for and return existing DBaaS MariaDB Backups for a specific cluster.

Example Usage

Get all backups for a specific cluster

data "ionoscloud_mariadb_backups" "example" { 
    cluster_id = <cluster_id>
    location   = "de/txl"
}

Get a specific backup

data "ionoscloud_mariadb_backups" "example" {
    backup_id = <backup_id>
    location   = "de/txl"
}

Argument Reference

• cluster_id - (Optional)[string] The unique ID of the cluster.

• backup_id - (Optional)[string] The unique ID of the backup.

• location- (Optional)[string] The location of the cluster. Different service endpoints are used based on location, possible options are: "de/fra", "de/txl", "es/vit", "fr/par", "gb/lhr", "us/ewr", "us/las", "us/mci". If not set, the endpoint will be the one corresponding to "de/txl".

⚠️ Note: Either cluster_id or backup_id must be used, but not both at the same time.

⚠ WARNING: Location attribute will become required in the future.

Attributes Reference

The following attributes are returned by the datasource:

• bakups - List of backups.

  • cluster_id - The unique ID of the cluster that was backed up.

  • earliest_recovery_target_time - The oldest available timestamp to which you can restore.

  • size - Size of all base backups in Mebibytes (MiB). This is at least the sum of all base backup sizes.

  • base_backups - The list of backups for the specified cluster

    • size - The size of the backup in Mebibytes (MiB). This is the size of the binary backup file that was stored

    • created - The ISO 8601 creation timestamp

The Dataplatform Cluster Data Source can be used to search for and return an existing Dataplatform Cluster. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

Example Usage

By ID

data "ionoscloud_dataplatform_cluster" "example" {
  id	= <cluster_id>
}

By Name

data "ionoscloud_dataplatform_cluster" "example" {
  name	= "Dataplatform_Cluster_Example"
}

By Name with Partial Match

data "ionoscloud_dataplatform_cluster" "example" {
  name	= "_Example"
  partial_match = true
}

Argument Reference

• id - (Optional) ID of the cluster you want to search for.

• name - (Optional) Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

Either id or name must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The UUID of the cluster.

• datacenter_id - The UUID of the virtual data center (VDC) in which the cluster is provisioned.

• name - The name of your cluster.

• version - The version of the Data Platform.

• maintenance_window - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format

  • time - Time at which the maintenance should start.

  • day_of_the_week

• kube_config - Kubernetes configuration

• config - structured kubernetes config consisting of a list with 1 item with the following fields:

  • api_version - Kubernetes API Version

  • kind - "Config"

  • current-context - string

  • clusters - list of

    • name - name of cluster

    • cluster - map of

      • certificate-authority-data - base64 decoded cluster CA data

      • server - server address in the form https://host:port

  • contexts - list of

    • name - context name

    • context - map of

      • cluster - cluster name

      • user - cluster user

  • users - list of

    • name - user name

    • user - map of

      • token - user token used for authentication

• user_tokens - a convenience map to be search the token of a specific user

  • key - is the user name

  • value - is the token

• server - cluster server (same as config[0].clusters[0].cluster.server but provided as an attribute for ease of use)

• ca_crt - base64 decoded cluster certificate authority data (provided as an attribute for direct use)

• lans - A list of LANs you want this node pool to be part of

  • lan_id - The LAN ID of an existing LAN at the related data center

  • dhcp - Indicates if the Kubernetes node pool LAN will reserve an IP using DHCP. The default value is 'true'.

  • routes - An array of additional LANs attached to worker nodes

    • gateway - IPv4 or IPv6 gateway IP for the route

    • network - IPv4 or IPv6 CIDR to be routed via the interface

NOTE: The whole config node is marked as sensitive.

Example of accessing a Dataplatform Cluster using the user's token

resource "ionoscloud_dataplatform_cluster" "example" {
  datacenter_id   		=  ionoscloud_datacenter.example.id
  name 					= "Dataplatform_Cluster_Example"
  maintenance_window {
    day_of_the_week  	= "Sunday"
    time				= "09:00:00"
  }
  version	= "23.7"
}

data "ionoscloud_dataplatform_cluster" "example" {
  name = "Dataplatform_Cluster_Example"
}

provider "kubernetes" {
  host = data.ionoscloud_dataplatform_cluster.example.server
  token =  data.ionoscloud_dataplatform_cluster.example.user_tokens["cluster-admin"]
}

Example of accessing a kubernetes cluster using the token from the config

resource "ionoscloud_dataplatform_cluster" "example" {
  datacenter_id   		=  ionoscloud_datacenter.example.id
  name 					= "Dataplatform_Cluster_Example"
  maintenance_window {
    day_of_the_week  	= "Sunday"
    time				= "09:00:00"
  }
  version	= "23.7"
}

data "ionoscloud_dataplatform_cluster" "example" {
  name = "Dataplatform_Cluster_Example"
}

provider "kubernetes" {
  host = data.ionoscloud_dataplatform_cluster.example.config[0].clusters[0].cluster.server
  token =  data.ionoscloud_dataplatform_cluster.example.config[0].users[0].user.token
}

Example of dumping the kube_config raw data into a yaml file

NOTE: Dumping kube_config data into files poses a security risk.

NOTE: Using sensitive_content for local_file does not show the data written to the file during the plan phase.

data "ionoscloud_dataplatform_cluster" "example" {
  name = "Dataplatform_Cluster_Example"
}

resource "local_file" "kubeconfig" {
    sensitive_content     = yamlencode(jsondecode(data.ionoscloud_dataplatform_cluster.example.kube_config))
    filename              = "kubeconfig.yaml"
}

The Dataplatform Node Pools Data Source can be used to search for and return a list of existing Dataplatform Node Pools under a Dataplatform Cluster.

Example Usage

All Node Pools under a Cluster ID

data "ionoscloud_dataplatform_node_pools" "example" {
  cluster_id  = <cluster_id>
}

By Name

data "ionoscloud_dataplatform_node_pools" "example" {
  cluster_id    = <cluster_id>
  name      	= "Dataplatform_Node_Pool_Example"
}

By Name with Partial Match

data "ionoscloud_dataplatform_node_pools" "example" {
  cluster_id    = <cluster_id>
  name    	    = "_Example"
  partial_match = true
}

Argument Reference

• cluster_id - (Required) ID of the cluster the searched node pool is part of.

• name - (Optional) Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if partial_match parameter is not set to true.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

Attributes Reference

The following attributes are returned by the datasource:

• cluster_id - ID of the cluster the searched node pool is part of.

• node_pools - List of Node Pools - See the Node Pool section.

The DbaaS Mongo Template data source can be used to search for and return an existing DbaaS MongoDB Template. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By name

By name, using partial_match

• name - (Optional) The name of the template you want to search for.

• id - (Optional) ID of the template you want to search for.

• partial_match - (Optional) Whether partial matching is allowed or not when using name argument. Default value is false.

Either name or id must be provided. If none or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The ID of the template.

• name - The name of the template.

• edition - The edition of the template (e.g. enterprise).

• cores - The number of CPU cores.

• ram - The amount of memory in GB.

• storage_size - The amount of storage size in GB.

The DbaaS Postgres Cluster data source can be used to search for and return an existing DbaaS Postgres Cluster. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name

Argument Reference

• display_name - (Optional) Display Name of an existing cluster that you want to search for.

• id - (Optional) ID of the cluster you want to search for.

Either display_name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• postgres_version - The PostgreSQL version of your cluster.

• instances - The total number of instances in the cluster (one master and n-1 standbys)

• cores - The number of CPU cores per replica.

• ram - The amount of memory per instance in megabytes.

• storage_size - The amount of storage per instance in MB.

• storage_type - The storage type used in your cluster.

• connection_pooler - Details about the connection pooler.

  • enabled

  • pool_mode - Represents different modes of connection pooling for the connection pooler.

• connections - Details about the network connection for your cluster.

  • datacenter_id - The datacenter to connect your cluster to.

  • lan_id - The LAN to connect your cluster to.

  • cidr - The IP and subnet for the database.

• location - The physical location where the cluster will be created. This will be where all of your instances live.

• backup_location - The IONOS Object Storage location where the backups will be stored.

• display_name - The friendly name of your cluster.

• maintenance_window - A weekly 4 hour-long window, during which maintenance might occur

  • time

  • day_of_the_week

• credentials - Credentials for the database user to be created.

  • username - The username for the initial postgres user.

• synchronization_mode - Represents different modes of replication.

• from_backup - The unique ID of the backup you want to restore.

  • backup_id - The PostgreSQL version of your cluster.

  • recovery_target_time - If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp.

• dns_name - The DNS name pointing to your cluster.

The DbaaS Mongo User data source can be used to search for and return an existing DbaaS MongoDB User. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By display_name

Argument reference

• cluster_id - (Required)[string] The unique ID of the cluster. Updates to the value of the field force the cluster to be re-created.

• username - (Required)[string] Used for authentication. Updates to the value of the field force the cluster to be re-created.

• database - (Required)[string] The user database to use for authentication. Updates to the value of the field force the cluster to be re-created.

• password - (Required)[string] User password. Updates to the value of the field force the cluster to be re-created.

• roles - (Required)[string] a list of mongodb user roles. Updates to the value of the field force the cluster to be re-created.

  • role - (Required)[true] Mongodb user role. Examples: read, readWrite, readAnyDatabase, readWriteAnyDatabase, dbAdmin, dbAdminAnyDatabase, clusterMonitor and enableSharding.

  • database - (Required)[true] Database on which to apply the role.

NOTE: MongoDb users do not support update at the moment. Changing any attribute will result in the user being re-created.

Import

Resource DbaaS MongoDb User can be imported using the cluster_id, the database and the username e.g.

The PgSql User data source can be used to search for and return an existing PgSql user.

Example Usage

Argument Reference

• cluster_id - (Required)[string] The ID of the cluster.

• username - (Required)[string] Name of an existing user that you want to search for.

Attributes Reference

The following attributes are returned by the datasource:

• id - [string] The id of the user.

• is_system_user - [bool] Describes whether this user is a system user or not. A system user cannot be updated or deleted.

The DNS Record can be used to search for and return an existing DNS Record. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

⚠️ Only tokens are accepted for authorization in the ionoscloud_dns_record data source. Please ensure you are using tokens as other methods will not be valid.

Example Usage

By ID

By name

By name with partial match

Argument reference

• zone_id - (Required)[string] The ID of the DNS Zone in which the DNS Record can be found.

• id - (Optional)[string] The ID of the DNS Record you want to search for.

• name - (Optional)[string] The name of the DNS Record you want to search for.

• partial_match - (Optional)[bool] Whether partial matching is allowed or not when using name argument. Default value is false.

Either id or name must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The UUID of the DNS Record.

• name - The name of the DNS Record.

• type - The type of the DNS Record.

• content - The content of the DNS Record.

• ttl - The time to live of the DNS Record.

• priority - The priority for the DNS Record.

• enabled - Indicates if the DNS Record is active or not.

The PgSql Database data source can be used to search for and return an existing PgSql database.

Example Usage

Argument Reference

• cluster_id - (Required)[string] The ID of the cluster.

• name - (Required)[string] Name of an existing database that you want to search for.

Attributes Reference

The following attributes are returned by the datasource:

• id - [string] The id of the database.

• owner - [string] The owner of the database.

The DbaaS Postgres Backups data source can be used to search for and return existing DbaaS Postgres Backups for a specific Cluster. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

Argument Reference

• cluster_id - (Required) The unique ID of the cluster.

cluster_id must be provided. If it is not provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• cluster_id - Id of the cluster.

• cluster_backups - List of backups.

  • id - The unique ID of the resource.

  • cluster_id - The unique ID of the cluster

  • size - The size of all base backups including the wal size in MB.

  • location - The IONOS Object Storage location where the backups will be stored.

  • version - The PostgreSQL version this backup was created from.

  • is_active - Whether a cluster currently backs up data to this backup.

  • earliest_recovery_target_time - The oldest available timestamp to which you can restore.

  • type

  • metadata - Metadata of the resource.

    • created_date - The ISO 8601 creation timestamp.

    • created_by

    • created_by_user_id

    • last_modified_date - The ISO 8601 modified timestamp.

    • last_modified_by

    • last_modified_by_user_id

NOTE: If the earliestRecoveryTargetTime is missing in your backup, the cluster from where you want to restore wasn't able to do a base backup. This can happen, when you e.g. quickly delete a newly created cluster, since the base backup will be triggered up to a minute after the cluster is available.

The DbaaS Postgres Versions data source can be used to search for and retrieve list of available postgres versions for a specific cluster or for all clusters.

Example Usage

Retrieve list of postgres versions for a specific cluster

Retrieve list of postgres versions for all clusters

Argument Reference

• cluster_id - (Optional) The unique ID of the cluster.

If cluster_id is not provided the data source will return the list of postgres version for all cluster.

Attributes Reference

The following attributes are returned by the datasource:

• cluster_id - Id of the cluster

• postgres_versions - list of PostgreSQL versions.

The PgSql Databases data source can be used to search for and return multiple existing PgSql databases.

Example Usage

All databases from a specific cluster

Filter by owner

Argument Reference

• cluster_id - (Required)[string] The ID of the cluster.

• owner - (Optional)[string] Filter using a specific owner.

Attributes Reference

The following attributes are returned by the datasource:

• databases - [list] A list that contains either all databases, either some of them (filter by owner). A database from list has the following format:

  • name - [string] The name of the database.

  • owner - [string] The owner of the database.

  • id - [string] The ID of the database.

The IP Block data source can be used to search for and return an existing Ip Block. You can provide a string for the id, the name or the location parameters which will be compared with the provisioned Ip Blocks. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name

By Location

By Name & Location

Argument reference

• id - (Optional) ID of an existing Ip Block that you want to search for.

• name - (Optional) Name of an existing Ip Block that you want to search for.

• location - (Optional) The regional location for this IP Block: us/las, us/ewr, de/fra, de/fkb.

Attributes Reference

• id - The id of Ip Block

• name - The name of Ip Block

• location - The regional location for this IP Block: us/las, us/ewr, de/fra, de/fkb.

• size - The number of IP addresses to reserve for this block.

• ips - The list of IP addresses associated with this block.

• ip_consumers Read-Only attribute. Lists consumption detail of an individual ip

  • ip

  • mac

  • nic_uuid

  • server_id

  • server_name

  • datacenter_id

  • datacenter_name

  • k8s_nodepool_uuid

  • k8s_cluster_uuid

The Firewall data source can be used to search for and return an existing FirewallRules. You can provide a string for either id or name parameters which will be compared with provisioned Firewall Rules. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name

Argument Reference

The following arguments are supported:

• name - (Optional) Name of an existing firewall rule that you want to search for.

• id - (Optional) ID of the firewall rule you want to search for.

• datacenter_id - (Required) The Virtual Data Center ID.

• server_id - (Required) The Server ID.

• nic_id - (Required) The NIC ID.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the firewall rule.

• name - The name of the firewall rule.

• protocol - The protocol for the rule: TCP, UDP, ICMP, ANY. This property is immutable.

• source_mac - Only traffic originating from the respective MAC address is allowed.

• source_ip - Only traffic originating from the respective IPv4 address is allowed.

• target_ip - Only traffic directed to the respective IP address of the NIC is allowed.

• port_range_start - Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen.

• port_range_end - Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen.

• icmp_type - Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen.

• icmp_code - Defines the allowed code (from 0 to 254) if protocol ICMP is chosen.

The DNS Zone can be used to search for and return an existing DNS Zone. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.

⚠️ Only tokens are accepted for authorization in the ionoscloud_dns_zone data source. Please ensure you are using tokens as other methods will not be valid.

Example Usage

By ID

By name

By name with partial match

Argument reference

• id - (Optional)[string] The ID of the DNS Zone you want to search for.

• name - (Optional)[string] The name of the DNS Zone you want to search for.

• partial_match - (Optional)[bool] Whether partial matching is allowed or not when using name argument. Default value is false.

Either id or name must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The UUID of the DNS Zone.

• name - The name of the DNS Zone.

• description - The description of the DNS Zone.

• enabled - Indicates if the DNS Zone is activated or not.

• nameservers - A list of available name servers.

The IP Failover data source can be used to search for and return an existing IP Failover object. You need to provide the datacenter_id and the id of the lan to get the ip failover object for the provided datacenter. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned.

Example Usage

Argument Reference

The following arguments are supported:

• datacenter_id - (Required) The ID of the datacenter containing the ip failover datasource

• id - (Required) The id of the lan of which the IP failover belongs

Attributes Reference

The following attributes are returned by the datasource:

• datacenter_id - The ID of a Data Center.

• ip - The reserved IP address to be used in the IP failover group.

• lan_id - The ID of a LAN.

• nicuuid - The ID of a NIC.

The Group data source can be used to search for and return existing groups. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

By Name

Argument Reference

• name - (Optional) Name of an existing group that you want to search for.

• id - (Optional) ID of the group you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the group.

• name - A name for the group.

• create_datacenter - The group will be allowed to create virtual data centers.

• create_snapshot - The group will be allowed to create snapshots.

• reserve_ip - The group will be allowed to reserve IP addresses.

• access_activity_log - The group will be allowed to access the activity log.

• create_pcc - The group will be allowed to create Cross Connects privilege.

• s3_privilege - The group will have S3 privilege.

• create_backup_unit - The group will be allowed to create backup unit privilege.

• create_internet_access - The group will be allowed to create internet access privilege.

• create_k8s_cluster - The group will be allowed to create kubernetes cluster privilege.

• create_flow_log - The group will be allowed to create flow log.

• access_and_manage_monitoring The group will be allowed to access and manage monitoring.

• access_and_manage_certificates - The group will be allowed to access and manage certificates.

• manage_dbaas - Privilege for a group to manage DBaaS related functionality.

• users - List of users in group.

The Image data source can be used to search for and return an existing image which can then be used to provision a server. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result. In case multiple matches are found, enable debug(TF_LOG=debug) to show the name and location of the images.

Example Usage

Finds an image with alias ubuntu:latest_iso, in location de/txl, that does not support cloud_init and is of type CDROM.

Example Usage

Finds an image with alias ubuntu:latest in location de/txl. Uses exact matching on both fields.

Example Usage

Finds an image named ubuntu-20.04.6 in location de/txl. Uses exact matching.

Argument Reference

• name - (Required) Name of an existing image that you want to search for. It will return an exact match if one exists, otherwise it will retrieve partial matches.

• location - (Optional) Id of the existing image's location. Exact match. Possible values: de/fra, de/txl, gb/lhr, es/vit, us/ewr, us/las

• type - (Optional) The image type, HDD or CD-ROM. Exact match.

• cloud_init - (Optional) Cloud init compatibility ("NONE" or "V1"). Exact match.

• image_alias - (Optional) Image alias of the image you are searching for. Exact match. E.g. =centos:latest, ubuntu:latest

• version - (Optional) The version of the image that you want to search for.

If both "name" and "version" are provided the plugin will concatenate the two strings in this format [name]-[version]. The resulting string will be used to search for an exact match. An error will be thrown if one is not found.

Attributes Reference

• id - UUID of the image

• name - name of the image

• description - description of the image

• size - The size of the image in GB

• cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

• cpu_hot_unplug - Is capable of CPU hot unplug (no reboot required)

• ram_hot_plug - Is capable of memory hot plug (no reboot required)

• ram_hot_unplug - Is capable of memory hot unplug (no reboot required)

• nic_hot_plug - Is capable of nic hot plug (no reboot required)

• nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

• disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

• disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required)

• disc_scsi_hot_plug - Is capable of SCSI drive hot plug (no reboot required)

• disc_scsi_hot_unplug - Is capable of SCSI drive hot unplug (no reboot required)

• licence_type - OS type of this Image

• public - Indicates if the image is part of the public repository or not

• image_aliases - List of image aliases mapped for this Image

• cloud_init - Cloud init compatibility

• type - This indicates the type of image

• location - Location of that image/snapshot.

The k8s_clusters data source can be used to search for and return existing kubernetes clusters based on filters used.