SakuraCloud Provider

https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/
Admin
A Terraform provider for interacting with the many resources supported by SakuraCloud APIs.
Tokens:14,497
Snippets:122
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### SakuraCloud Database Resource Example

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/database

This example demonstrates how to provision a SakuraCloud Database instance with MariaDB. It includes network configuration, user credentials, disk encryption using KMS, and backup settings. Ensure dependent resources like sakuracloud_switch, sakuracloud_nfs, and sakuracloud_kms are defined.

```terraform
variable username {}
variable password {}
variable replica_password {}

resource "sakuracloud_database" "foobar" {
  database_type    = "mariadb"
  database_version = "10.11" // optional
  plan             = "30g"

  username = var.username
  password = var.password

  replica_password = var.replica_password

  network_interface {
    switch_id     = sakuracloud_switch.foobar.id
    ip_address    = "192.168.11.11"
    netmask       = 24
    gateway       = "192.168.11.1"
    port          = 3306
    source_ranges = ["192.168.11.0/24", "192.168.12.0/24"]
  }

  backup {
    time     = "00:00"
    weekdays = ["mon", "tue"]
  }

  # continuous_backupを指定するときはdatabase_versionが必須
  # continuous_backup {
  #   days_of_week = ["mon", "tue"]
  #   time         = "01:30"
  #   connect      = "nfs://${sakuracloud_nfs.foobar.network_interface[0].ip_address}/export"
  # }

  parameters = {
    max_connections = 100
  }

  monitoring_suite {
    enabled = true
  }

  disk {
    encryption_algorithm = "aes256_xts"
    kms_key_id           = sakuracloud_kms.foobar.id
  }

  name        = "foobar"
  description = "description"
  tags        = ["tag1", "tag2"]
}

resource "sakuracloud_nfs" "foobar" {
  name = "foobar"
  plan = "ssd"
  size = "100"

  network_interface {
    switch_id   = sakuracloud_switch.foobar.id
    ip_address  = "192.168.11.111"
    netmask     = 24
    gateway     = "192.168.11.1"
  }
}

resource "sakuracloud_switch" "foobar" {
  name = "foobar"
}

resource "sakuracloud_kms" "foobar" {
  name = "foobar"
}
```

--------------------------------

### SakuraCloud Shared Credentials File Example

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs

Example of a JSON formatted shared credentials file for the SakuraCloud provider. This file should be located at `$HOME/.usacloud/<profile name>/config.json` or its Windows equivalent.

```json
{
    "AccessToken": "my-access-token",
    "AccessTokenSecret": "my-access-secret",
    "Zone": "is1a"
}
```

--------------------------------

### Basic Load Balancer Configuration

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/load_balancer

Example of creating a standard SakuraCloud Load Balancer with a network interface and a VIP configuration including health checks for backend servers.

```terraform
resource "sakuracloud_load_balancer" "foobar" {
  name = "foobar"
  plan = "standard"

  network_interface {
    switch_id    = sakuracloud_switch.foobar.id
    vrid         = 1
    ip_addresses = ["192.168.11.101"]
    netmask      = 24
    gateway      = "192.168.11.1"
  }

  description = "description"
  tags        = ["tag1", "tag2"]

  vip {
    vip          = "192.168.11.201"
    port         = 80
    delay_loop   = 10
    sorry_server = "192.168.11.21"

    server {
      ip_address = "192.168.11.51"
      protocol   = "http"
      path       = "/health"
      status     = 200
    }

    server {
      ip_address = "192.168.11.52"
      protocol   = "http"
      path       = "/health"
      status     = 200
    }
  }
}

resource "sakuracloud_switch" "foobar" {
  name = "foobar"
}
```

--------------------------------

### Standard VPC Router Configuration

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/vpc_router

Example of a basic VPC Router with internet connection enabled. Use this for standard networking needs.

```terraform
resource "sakuracloud_vpc_router" "standard" {
  name                = "standard"
  description         = "description"
  tags                = ["tag1", "tag2"]
  internet_connection = true
}
```

--------------------------------

### Create a Database Read Replica

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/database_read_replica

Example of creating a SakuraCloud Database Read Replica with specified network interface, disk encryption, and tags. Ensure the master database exists and is referenced by `data.sakuracloud_database.master`.

```terraform
resource "sakuracloud_kms" "foobar" {
  name = "foobar"
}

resource "sakuracloud_database_read_replica" "foobar" {
  master_id             = data.sakuracloud_database.master.id
  replica_password = "your-replica-password"

  network_interface {
    ip_address  = "192.168.11.111"
  }

  disk {
    encryption_algorithm = "aes256_xts"
    kms_key_id           = sakuracloud_kms.foobar.id
  }

  name        = "foobar"
  description = "description"
  tags        = ["tag1", "tag2"]
}

data sakuracloud_database "master" {
  filter {
    names = ["master-database-name"]
  }
}
```

--------------------------------

### Example Usage of sakuracloud_nfs Data Source

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/nfs

Use this data source to get information about an existing NFS. It can be filtered by name.

```terraform
data "sakuracloud_nfs" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

--------------------------------

### Basic Auto Backup Configuration

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/auto_backup

Example of how to create a SakuraCloud Auto Backup resource. It requires a disk ID and specifies the days of the week for backups, along with the maximum number of backups to retain.

```terraform
resource "sakuracloud_disk" "foobar" {
  name = "foobar"
}
resource "sakuracloud_auto_backup" "foobar" {
  name           = "foobar"
  disk_id        = sakuracloud_disk.foobar.id
  weekdays       = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
  max_backup_num = 5
  description    = "description"
  tags           = ["tag1", "tag2"]
}
```

--------------------------------

### Example Usage of sakuracloud_vpc_router Data Source

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/vpc_router

Use this data source to retrieve information about an existing VPC Router by its name. Ensure the VPC Router exists in the specified zone.

```terraform
data "sakuracloud_vpc_router" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

--------------------------------

### Example Usage of sakuracloud_load_balancer Data Source

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/load_balancer

This snippet shows how to use the sakuracloud_load_balancer data source to retrieve a load balancer by its name. Ensure the 'foobar' name exists in your SakuraCloud environment.

```terraform
data "sakuracloud_load_balancer" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

--------------------------------

### Premium VPC Router with Advanced Configurations

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/vpc_router

Example of a premium VPC Router demonstrating advanced configurations like public and private network interfaces, DHCP, DNS forwarding, firewall rules, L2TP/PPTP, port forwarding, WireGuard, site-to-site VPN, static NAT, static routes, user management, scheduled maintenance, and monitoring suite.

```terraform
resource "sakuracloud_vpc_router" "premium" {
  name        = "premium"
  description = "description"
  tags        = ["tag1", "tag2"]
  plan        = "premium"

  internet_connection = true

  public_network_interface {
    switch_id    = sakuracloud_internet.foobar.switch_id
    vip          = sakuracloud_internet.foobar.ip_addresses[0]
    ip_addresses = [sakuracloud_internet.foobar.ip_addresses[1], sakuracloud_internet.foobar.ip_addresses[2]]
    aliases      = [sakuracloud_internet.foobar.ip_addresses[3]]
    vrid         = 1
  }

  private_network_interface {
    index        = 1
    switch_id    = sakuracloud_switch.foobar.id
    vip          = "192.168.11.1"
    ip_addresses = ["192.168.11.2", "192.168.11.3"]
    netmask      = 24
  }

  dhcp_server {
    interface_index = 1

    range_start = "192.168.11.11"
    range_stop  = "192.168.11.20"
    dns_servers = ["8.8.8.8", "8.8.4.4"]
  }

  dhcp_static_mapping {
    ip_address  = "192.168.11.10"
    mac_address = "aa:bb:cc:aa:bb:cc"
  }

  dns_forwarding {
    interface_index = 1
    dns_servers = ["133.242.0.3", "133.242.0.4"]
  }

  firewall {
    interface_index = 1

    direction = "send"
    expression {
      protocol            = "tcp"
      source_network      = ""
      source_port         = "80"
      destination_network = ""
      destination_port    = ""
      allow               = true
      logging             = true
      description         = "desc"
    }

    expression {
      protocol            = "ip"
      source_network      = ""
      source_port         = ""
      destination_network = ""
      destination_port    = ""
      allow               = false
      logging             = true
      description         = "desc"
    }
  }

  l2tp {
    pre_shared_secret = "example"
    range_start       = "192.168.11.21"
    range_stop        = "192.168.11.30"
  }

  port_forwarding {
    protocol     = "udp"
    public_port  = 10022
    private_ip   = "192.168.11.11"
    private_port = 22
    description  = "desc"
  }

  pptp {
    range_start = "192.168.11.31"
    range_stop  = "192.168.11.40"
  }

  wire_guard {
    ip_address = "192.168.31.1/24"
    peer {
      name       = "example"
      ip_address = "192.168.31.11"
      public_key = "<your-public-key>"
    }
  }

  site_to_site_vpn {
    peer              = "10.0.0.1"
    remote_id         = "10.0.0.1"
    pre_shared_secret = "example"
    routes            = ["10.0.0.0/8"]
    local_prefix      = ["192.168.21.0/24"]
  }

  site_to_site_vpn_parameter {
    ike {
      lifetime = 28800
      dpd {
        interval = 15
        timeout  = 30
      }
    }
    esp {
      lifetime = 1800
    }
    encryption_algo = "aes256"
    hash_algo       = "sha256"
  }

  static_nat {
    public_ip   = sakuracloud_internet.foobar.ip_addresses[3]
    private_ip  = "192.168.11.12"
    description = "desc"
  }

  static_route {
    prefix   = "172.16.0.0/16"
    next_hop = "192.168.11.99"
  }

  user {
    name     = "username"
    password = "password"
  }

  scheduled_maintenance {
    day_of_week = "tue"
    hour        = 1
  }

  monitoring_suite {
    enabled = true
  }
}

resource "sakuracloud_internet" "foobar" {
  name = "foobar"
}

resource sakuracloud_switch "foobar" {
  name = "foobar"
}
```

--------------------------------

### Example Usage of SakuraCloud NFS Resource

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/nfs

This snippet demonstrates how to define and configure an NFS resource with specified name, plan, size, and network interface settings. It also includes the definition of a dependent `sakuracloud_switch` resource.

```Terraform
resource "sakuracloud_nfs" "foobar" {
  name = "foobar"
  plan = "ssd"
  size = "500"

  network_interface {
    switch_id   = sakuracloud_switch.foobar.id
    ip_address  = "192.168.11.101"
    netmask     = 24
    gateway     = "192.168.11.1"
  }

  description = "description"
  tags        = ["tag1", "tag2"]
}

resource "sakuracloud_switch" "foobar" {
  name = "foobar"
}
```

--------------------------------

### Example Usage of sakuracloud_database Data Source

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/database

This snippet shows how to use the sakuracloud_database data source to find a database by its name. Ensure the 'filter' block is correctly configured with the desired 'names' to match your database.

```terraform
data "sakuracloud_database" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

--------------------------------

### SakuraCloud Provider with Static Credentials

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs

Configure the SakuraCloud provider using static access token and secret. Warning: Hard-coding credentials is not recommended due to security risks.

```terraform
provider "sakuracloud" {
  token  = "my-access-token"
  secret = "my-access-secret"
  zone   = "is1a"
}
```

--------------------------------

### Site-to-Site VPN Configuration

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/vpc_router

Configuration block for setting up a Site-to-Site VPN connection with a VPC Router.

```APIDOC
## Site-to-Site VPN Configuration

A `site_to_site_vpn_parameter` block supports the following:

### Parameters

#### Site-to-Site VPN Parameters
- **local_prefix** (list of string) - Required - A list of CIDR block of the network under the VPC Router.
- **peer** (string) - Required - The IP address of the opposing appliance connected to the VPC Router.
- **pre_shared_secret** (string) - Required - The pre shared secret for the VPN. The length of this value must be in the range [0-40].
- **remote_id** (string) - Required - The id of the opposing appliance connected to the VPC Router. This is typically set same as value of `peer`.
- **routes** (list of string) - Required - A list of CIDR block of VPN connected networks.

#### VPN Encryption and Authentication Parameters
- **dh_group** (string) - Optional - This must be one of [`modp1024`/`modp2048`/`modp3072`/`modp4096`].
- **encryption_algo** (string) - Optional - This must be one of [`aes128`/`aes256`].
- **esp** (block) - Optional - An `esp` block as defined below.
- **hash_algo** (string) - Optional - This must be one of [`sha1`/`sha256`].
- **ike** (block) - Optional - An `ike` block as defined below.

### ESP Block

A `esp` block supports the following:

- **lifetime** (number) - Optional - Default: `1800`.

### IKE Block

An `ike` block supports the following:

- **dpd** (block) - Optional - A `dpd` block as defined below.
- **lifetime** (number) - Optional - Default: `28800`.

### DPD Block

A `dpd` block supports the following:

- **interval** (number) - Optional - Default: `15`.
- **timeout** (number) - Optional - Default: `30`.
```

--------------------------------

### SakuraCloud Provider with Environment Variables

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs

Configure the SakuraCloud provider to use credentials from environment variables. Ensure SAKURA_ACCESS_TOKEN, SAKURA_ACCESS_TOKEN_SECRET, and SAKURA_ZONE are set.

```terraform
provider "sakuracloud" {}
```

```bash
$ export SAKURA_ACCESS_TOKEN="my-access-token"
$ export SAKURA_ACCESS_TOKEN_SECRET="my-access-secret"
$ export SAKURA_ZONE="is1a"
$ terraform plan
```

--------------------------------

### Configure SakuraCloud Provider

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs

This snippet shows how to declare the SakuraCloud provider and pin it to a specific version. It's recommended to pin the provider version for stability.

```terraform
terraform {
  required_providers {
    sakuracloud = {
      source = "sacloud/sakuracloud"

      # We recommend pinning to the specific version of the SakuraCloud Provider you're using
      # since new versions are released frequently
      version = "2.35.1"
      #version = "~> 2"
    }
  }
}
# Configure the SakuraCloud Provider
provider "sakuracloud" {
  # More information on the authentication methods supported by
  # the SakuraCloud Provider can be found here:
  # https://docs.usacloud.jp/terraform/provider/.

  # profile = "..."
}
```

--------------------------------

### DHCP/NAT/Forwarding Services

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/vpc_router

Configuration options for DHCP server, static mapping, DNS forwarding, port forwarding, and static NAT.

```APIDOC
## DHCP/NAT/Forwarding Services

### DHCP Server Configuration

A `dhcp_server` block supports the following:

- **interface_index** (number) - Required - The index of the network interface on which to enable the DHCP service. This must be in the range [1-7].
- **range_start** (string) - Required - The start value of IP address range to assign to DHCP client.
- **range_stop** (string) - Required - The end value of IP address range to assign to DHCP client.
- **dns_servers** (list of string) - Optional - A list of IP address of DNS server to assign to DHCP client.

### DHCP Static Mapping Configuration

A `dhcp_static_mapping` block supports the following:

- **ip_address** (string) - Required - The static IP address to assign to DHCP client.
- **mac_address** (string) - Required - The source MAC address of static mapping.

### DNS Forwarding Configuration

A `dns_forwarding` block supports the following:

- **dns_servers** (list of string) - Optional - A list of IP address of DNS server to forward to.
- **interface_index** (number) - Required - The index of the network interface on which to enable the DNS forwarding service. This must be in the range [1-7].

### Port Forwarding Configuration

A `port_forwarding` block supports the following:

- **private_ip** (string) - Required - The destination ip address of the port forwarding.
- **private_port** (number) - Required - The destination port number of the port forwarding. This will be a port number on a private network.
- **protocol** (string) - Required - The protocol used for port forwarding. This must be one of [`tcp`/`udp`].
- **public_port** (number) - Required - The source port number of the port forwarding. This must be a port number on a public network.
- **description** (string) - Optional - The description of the port forwarding. The length of this value must be in the range [0-512].

### Static NAT Configuration

A `static_nat` block supports the following:

- **private_ip** (string) - Required - The private IP address used for the static NAT.
- **public_ip** (string) - Required - The public IP address used for the static NAT.
- **description** (string) - Optional - The description of the static nat. The length of this value must be in the range [0-512].
```

--------------------------------

### sakuracloud_database_read_replica

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/database_read_replica

Manages a SakuraCloud Database Read Replica.

```APIDOC
## sakuracloud_database_read_replica

Manages a SakuraCloud Database Read Replica.

### Example Usage
```
resource "sakuracloud_kms" "foobar" {
  name = "foobar"
}

resource "sakuracloud_database_read_replica" "foobar" {
  master_id             = data.sakuracloud_database.master.id
  replica_password = "your-replica-password"

  network_interface {
    ip_address  = "192.168.11.111"
  }

  disk {
    encryption_algorithm = "aes256_xts"
    kms_key_id           = sakuracloud_kms.foobar.id
  }

  name        = "foobar"
  description = "description"
  tags        = ["tag1", "tag2"]
}

data sakuracloud_database "master" {
  filter {
    names = ["master-database-name"]
  }
}
```

## Argument Reference

* `name` - (Required) The name of the read-replica database. The length of this value must be in the range [`1`-`64`].
* `master_id` - (Required) The id of the replication master database. Changing this forces a new resource to be created.
* `replica_password` - (Required) The password for the replication. This is write-only and won't be saved in state.

#### Disk
* `disk` - (Optional) A `disk` block as defined below. Changing this forces a new resource to be created.

* * *
A `disk` block supports the following:
* `encryption_algorithm` - (Optional) The disk encryption algorithm. This must be one of [`none`/`aes256_xts`].
* `kms_key_id` - (Optional) ID of the KMS key for encryption.

#### Network
* `network_interface` - (Required) An `network_interface` block as defined below.

* * *
A `network_interface` block supports the following:
* `ip_address` - (Required) The IP address to assign to the read-replica database.
* `gateway` - (Optional) The IP address of the gateway used by read-replica database. If `gateway` isn't specified, it will be set to the same value of the master database.
* `netmask` - (Optional) The bit length of the subnet to assign to the read-replica database. This must be in the range [`8`-`29`]. If `netmask` isn't specified, it will be set to the same value of the master database.
* `source_ranges` - (Optional) The range of source IP addresses that allow to access to the read-replica database via network.
* `switch_id` - (Optional) The id of the switch to which the read-replica database connects. If `switch_id` isn't specified, it will be set to the same value of the master database.

#### Common Arguments
* `description` - (Optional) The description of the read-replica database. The length of this value must be in the range [`1`-`512`].
* `icon_id` - (Optional) The icon id to attach to the read-replica database.
* `tags` - (Optional) Any tags to assign to the read-replica database.
* `zone` - (Optional) The name of zone that the read-replica database will be created. (e.g. `is1a`, `tk1a`). Changing this forces a new resource to be created.

### Timeouts
The `timeouts` block allows you to specify timeouts for certain actions:
* `create` - (Defaults to 60 minutes) Used when creating the Database Read Replica
* `update` - (Defaults to 60 minutes) Used when updating the Database Read Replica
* `delete` - (Defaults to 20 minutes) Used when deleting Database Read Replica

## Attribute Reference

* `id` - The id of the Database Read Replica.
```

--------------------------------

### sakuracloud_load_balancer

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/load_balancer

Manages a SakuraCloud Load Balancer resource.

```APIDOC
## sakuracloud_load_balancer

Manages a SakuraCloud Load Balancer.

### Example Usage

```terraform
resource "sakuracloud_load_balancer" "foobar" {
  name = "foobar"
  plan = "standard"

  network_interface {
    switch_id    = sakuracloud_switch.foobar.id
    vrid         = 1
    ip_addresses = ["192.168.11.101"]
    netmask      = 24
    gateway      = "192.168.11.1"
  }

  description = "description"
  tags        = ["tag1", "tag2"]

  vip {
    vip          = "192.168.11.201"
    port         = 80
    delay_loop   = 10
    sorry_server = "192.168.11.21"

    server {
      ip_address = "192.168.11.51"
      protocol   = "http"
      path       = "/health"
      status     = 200
    }

    server {
      ip_address = "192.168.11.52"
      protocol   = "http"
      path       = "/health"
      status     = 200
    }
  }
}

resource "sakuracloud_switch" "foobar" {
  name = "foobar"
}
```

## Argument Reference

* `name` - (Required) The name of the LoadBalancer. The length of this value must be in the range [`1`-`64`].
* `plan` - (Optional) The plan name of the LoadBalancer. This must be one of [`standard`/`highspec`]. Changing this forces a new resource to be created. Default:`standard`.

#### Network

* `network_interface` - (Required) An `network_interface` block as defined below.
* `vip` - (Optional) One or more `vip` blocks as defined below.


* * *
A `network_interface` block supports the following:

* `gateway` - (Optional) The IP address of the gateway used by LoadBalancer.
* `ip_addresses` - (Required) A list of IP address to assign to the LoadBalancer. .
* `netmask` - (Required) The bit length of the subnet assigned to the LoadBalancer. This must be in the range [`8`-`29`].
* `switch_id` - (Required) The id of the switch to which the LoadBalancer connects.
* `vrid` - (Required) The Virtual Router Identifier.


* * *
A `vip` block supports the following:

* `port` - (Required) The target port number for load-balancing. This must be in the range [`1`-`65535`].
* `vip` - (Required) The virtual IP address.
* `delay_loop` - (Optional) The interval in seconds between checks. This must be in the range [`10`-`2147483647`].
* `description` - (Optional) The description of the VIP. The length of this value must be in the range [`1`-`512`].
* `server` - (Optional) One or more `server` blocks as defined below.
* `sorry_server` - (Optional) The IP address of the SorryServer. This will be used when all servers under this VIP are down.


* * *
A `server` block supports the following:

* `ip_address` - (Required) The IP address of the destination server.
* `protocol` - (Required) The protocol used for health checks. This must be one of [`http`/`https`/`tcp`/`ping`].
* `enabled` - (Optional) The flag to enable as destination of load balancing.
* `path` - (Optional) The path used when checking by HTTP/HTTPS.
* `status` - (Optional) The response code to expect when checking by HTTP/HTTPS.


#### Common Arguments

* `description` - (Optional) The description of the LoadBalancer. The length of this value must be in the range [`1`-`512`].
* `icon_id` - (Optional) The icon id to attach to the LoadBalancer.
* `tags` - (Optional) Any tags to assign to the LoadBalancer.
* `zone` - (Optional) The name of zone that the LoadBalancer will be created. (e.g. `is1a`, `tk1a`). Changing this forces a new resource to be created.


### Timeouts

The `timeouts` block allows you to specify timeouts for certain actions:

* `create` - (Defaults to 60 minutes) Used when creating the Load Balancer
* `update` - (Defaults to 60 minutes) Used when updating the Load Balancer
* `delete` - (Defaults to 20 minutes) Used when deleting Load Balancer


## Attribute Reference

* `id` - The id of the Load Balancer.

####  On this page 

* Example Usage
* Argument Reference
* Attribute Reference


Report an issue 

```

--------------------------------

### sakuracloud_vpc_router

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/vpc_router

Fetches details of an existing VPC Router based on specified filters.

```APIDOC
## Data Source: sakuracloud_vpc_router

Get information about an existing VPC Router.

### Example Usage

```terraform
data "sakuracloud_vpc_router" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

## Argument Reference

* `filter` - (Optional) One or more values used for filtering, as defined below.
* `zone` - (Optional) The name of zone that the VPC Router is in (e.g. `is1a`, `tk1a`).

* * *
A `filter` block supports the following:

* `condition` - (Optional) One or more name/values pairs used for filtering. There are several valid keys, for a full reference, check out finding section in the SakuraCloud API reference.
* `id` - (Optional) The resource id on SakuraCloud used for filtering.
* `names` - (Optional) The resource names on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.
* `tags` - (Optional) The resource tags on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.

* * *
A `condition` block supports the following:

* `name` - (Required) The name of the target field. This value is case-sensitive.
* `values` - (Required) The values of the condition. If multiple values are specified, they combined as AND condition.
* `operator` - (Optional) The filtering operator. This must be one of following: `partial_match_and`/`exact_match_or`. Default: `partial_match_and`
```

--------------------------------

### sakuracloud_auto_backup Resource

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/resources/auto_backup

Manages a SakuraCloud Auto Backup resource. This resource allows for the configuration of automated backups for specified disks, including scheduling, retention policies, and tagging.

```APIDOC
## Resource: sakuracloud_auto_backup

Manages a SakuraCloud Auto Backup.

### Description

This resource allows you to configure and manage automated backups for disks within the SakuraCloud platform. It supports specifying backup schedules, the number of backups to retain, and associated metadata like descriptions and tags.

### Argument Reference

* `name` - (Required) The name of the AutoBackup. The length of this value must be in the range [`1`-`64`].
* `disk_id` - (Required) The disk id to backed up. Changing this forces a new resource to be created.
* `weekdays` - (Required) A list of weekdays to backed up. The values in the list must be in [`sun`/`mon`/`tue`/`wed`/`thu`/`fri`/`sat`].
* `max_backup_num` - (Optional) The number backup files to keep. This must be in the range [`1`-`10`]. Default:`1`.
* `description` - (Optional) The description of the AutoBackup. The length of this value must be in the range [`1`-`512`].
* `icon_id` - (Optional) The icon id to attach to the AutoBackup.
* `tags` - (Optional) Any tags to assign to the AutoBackup.
* `zone` - (Optional) The name of zone that the AutoBackup will be created. (e.g. `is1a`, `tk1a`). Changing this forces a new resource to be created.

### Timeouts

The `timeouts` block allows you to specify timeouts for certain actions:
* `create` - (Defaults to 5 minutes) Used when creating the Auto Backup
* `update` - (Defaults to 5 minutes) Used when updating the Auto Backup
* `delete` - (Defaults to 5 minutes) Used when deleting Auto Backup

### Attribute Reference

* `id` - The id of the Auto Backup.
```

--------------------------------

### sakuracloud_load_balancer Data Source

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/load_balancer

Retrieves information about an existing SakuraCloud Load Balancer. It supports filtering by name, ID, tags, and conditions.

```APIDOC
## Data Source: sakuracloud_load_balancer

Get information about an existing Load Balancer.

### Example Usage
```
data "sakuracloud_load_balancer" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

## Argument Reference

* `filter` - (Optional) One or more values used for filtering, as defined below.
* `zone` - (Optional) The name of zone that the LoadBalancer is in (e.g. `is1a`, `tk1a`).

* * *
A `filter` block supports the following:

* `condition` - (Optional) One or more name/values pairs used for filtering. There are several valid keys, for a full reference, check out finding section in the SakuraCloud API reference.
* `id` - (Optional) The resource id on SakuraCloud used for filtering.
* `names` - (Optional) The resource names on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.
* `tags` - (Optional) The resource tags on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.

* * *
A `condition` block supports the following:

* `name` - (Required) The name of the target field. This value is case-sensitive.
* `values` - (Required) The values of the condition. If multiple values are specified, they combined as AND condition.
* `operator` - (Optional) The filtering operator. This must be one of following: `partial_match_and`/`exact_match_or`. Default: `partial_match_and`


## Attribute Reference

* `id` - The id of the Load Balancer.
* `description` - The description of the LoadBalancer.
* `network_interface` - A list of `network_interface` blocks as defined below.
* `icon_id` - The icon id attached to the LoadBalancer.
* `name` - The name of the LoadBalancer.
* `plan` - The plan name of the LoadBalancer. This will be one of [`standard`/`highspec`].
* `tags` - Any tags assigned to the LoadBalancer.
* `vip` - A list of `vip` blocks as defined below.

* * *
A `network_interface` block exports the following:

* `gateway` - The IP address of the gateway used by LoadBalancer.
* `ip_addresses` - The list of IP address assigned to the LoadBalancer.
* `netmask` - The bit length of the subnet assigned to the LoadBalancer.
* `switch_id` - The id of the switch connected from the LoadBalancer.
* `vrid` - The Virtual Router Identifier.

* * *
A `vip` block exports the following:

* `delay_loop` - The interval in seconds between checks.
* `description` - The description of the VIP.
* `port` - The target port number for load-balancing.
* `server` - A list of `server` blocks as defined below.
* `sorry_server` - The IP address of the SorryServer. This will be used when all servers under this VIP are down.
* `vip` - The virtual IP address.

* * *
A `server` block exports the following:

* `enabled` - The flag to enable as destination of load balancing.
* `ip_address` - The IP address of the destination server.
* `path` - The path used when checking by HTTP/HTTPS.
* `protocol` - The protocol used for health checks. This will be one of [`http`/`https`/`tcp`/`ping`].
* `status` - The response code to expect when checking by HTTP/HTTPS.
```

--------------------------------

### sakuracloud_database Data Source

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/database

Retrieves information about an existing SakuraCloud Database. It supports filtering by name, ID, or tags, and can specify the zone for the search.

```APIDOC
## Data Source: sakuracloud_database

Get information about an existing Database.

### Example Usage

```
data "sakuracloud_database" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

### Argument Reference

* `filter` - (Optional) One or more values used for filtering, as defined below.
* `zone` - (Optional) The name of zone that the Database is in (e.g. `is1a`, `tk1a`). Changing this forces a new resource to be created.

* * *
A `filter` block supports the following:
  * `condition` - (Optional) One or more name/values pairs used for filtering. There are several valid keys, for a full reference, check out finding section in the SakuraCloud API reference.
  * `id` - (Optional) The resource id on SakuraCloud used for filtering.
  * `names` - (Optional) The resource names on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.
  * `tags` - (Optional) The resource tags on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.

* * *
A `condition` block supports the following:
  * `name` - (Required) The name of the target field. This value is case-sensitive.
  * `values` - (Required) The values of the condition. If multiple values are specified, they combined as AND condition.
  * `operator` - (Optional) The filtering operator. This must be one of following: `partial_match_and`/`exact_match_or`. Default: `partial_match_and`


### Attribute Reference

* `id` - The id of the Database.
* `backup` - A list of `backup` blocks as defined below.
* `continuous_backup` - A list of `continuous_backup` blocks as defined below.
* `database_type` - The type of the database. This will be one of [`mariadb`/`postgres`].
* `database_version` - The version of the database.
* `description` - The description of the Database.
* `disk` - A list of `disk` blocks as defined below.
* `icon_id` - The icon id attached to the Database.
* `monitoring_suite` - A list of `monitoring_suite` blocks as defined below.
* `name` - The name of the Database.
* `network_interface` - A list of `network_interface` blocks as defined below.
* `parameters` - The map for setting RDBMS-specific parameters. Valid keys can be found with the `usacloud database list-parameters` command.
* `password` - The password of default user on the database.
* `plan` - The plan name of the Database. This will be one of [`10g`/`30g`/`90g`/`240g`/`500g`/`1t`].
* `replica_password` - The password of user that processing a replication.
* `replica_user` - The name of user that processing a replication.
* `tags` - Any tags assigned to the Database.
* `username` - The name of default user on the database.

* * *
A `backup` block exports the following:
  * `time` - The time to take backup. This will be formatted with `HH:mm`.
  * `weekdays` - The list of name of weekday that doing backup. This will be in [`sun`/`mon`/`tue`/`wed`/`thu`/`fri`/`sat`].

* * *
A `continuous_backup` block exports the following:
  * `connect` - NFS server address for storing backups (e.g., `nfs://192.0.2.1/export`).
  * `time` - The time to take backup. This must be formatted with `HH:mm`.
  * `days_of_week` - The list of name of weekday that doing backup. This will be in [`sun`/`mon`/`tue`/`wed`/`thu`/`fri`/`sat`].

* * *
A `disk` block exports the following:
  * `encryption_algorithm` - The disk encryption algorithm. This must be one of [`none`/`aes256_xts`].
  * `kms_key_id` - ID of the KMS key for encryption.

* * *
A `monitoring_suite` block exports the following:
  * `enabled` - Enable sending signals to Monitoring Suite.

* * *
A `network_interface` block exports the following:
  * `gateway` - The IP address of the gateway used by Database.
  * `ip_address` - The IP address assigned to the Database.
  * `netmask` - The bit length of the subnet assigned to the Database.
  * `port` - The number of the listening port.
  * `source_ranges` - The range of source IP addresses that allow to access to the Database via network.
  * `switch_id` - The id of the switch connected from the Database.
```

--------------------------------

### sakuracloud_nfs Data Source

Source: https://registry.terraform.io/providers/sacloud/sakuracloud/latest/docs/data-sources/nfs

Retrieves information about an existing NFS instance in SakuraCloud. It can be filtered by name, tags, ID, or conditions.

```APIDOC
## Data Source: sakuracloud_nfs

Get information about an existing NFS.

### Example Usage

```
data "sakuracloud_nfs" "foobar" {
  filter {
    names = ["foobar"]
  }
}
```

## Argument Reference

* `filter` - (Optional) One or more values used for filtering, as defined below.
* `zone` - (Optional) The name of zone that the NFS is in (e.g. `is1a`, `tk1a`).

### `filter` block

* `condition` - (Optional) One or more name/values pairs used for filtering. There are several valid keys, for a full reference, check out finding section in the SakuraCloud API reference.
* `id` - (Optional) The resource id on SakuraCloud used for filtering.
* `names` - (Optional) The resource names on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.
* `tags` - (Optional) The resource tags on SakuraCloud used for filtering. If multiple values are specified, they combined as AND condition.

### `condition` block

* `name` - (Required) The name of the target field. This value is case-sensitive.
* `values` - (Required) The values of the condition. If multiple values are specified, they combined as AND condition.
* `operator` - (Optional) The filtering operator. This must be one of following: `partial_match_and`/`exact_match_or`. Default: `partial_match_and`

## Attribute Reference

* `id` - The id of the NFS.
* `description` - The description of the NFS.
* `icon_id` - The icon id attached to the NFS.
* `network_interface` - A list of `network_interface` blocks as defined below.
* `name` - The name of the NFS.
* `plan` - The plan name of the NFS. This will be one of [`hdd`/`ssd`].
* `size` - The size of NFS in GiB.
* `tags` - Any tags assigned to the NFS.

### `network_interface` block exports

* `gateway` - The IP address of the gateway used by NFS.
* `ip_address` - The IP address assigned to the NFS.
* `netmask` - The bit length of the subnet assigned to the NFS.
* `switch_id` - The id of the switch connected from the NFS.
```
Tokens:
Raw