Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(instance_private_nic): added zone field doc & fix typo #1328

Merged
merged 6 commits into from
Jun 16, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions docs/resources/instance_private_nic.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ description: |-
Creates and manages Scaleway Instance Private NICs. For more information, see
[the documentation](https://developers.scaleway.com/en/products/instance/api/#private-nics-a42eea).

## Example
## Examples

### Basic

```hcl
resource "scaleway_instance_private_nic" "pnic01" {
Expand All @@ -18,19 +20,41 @@ resource "scaleway_instance_private_nic" "pnic01" {
}
```

### With zone

```hcl
resource scaleway_vpc_private_network pn01 {
name = "private_network_instance"
zone = "fr-par-2"
}

resource "scaleway_instance_server" "base" {
image = "ubuntu_focal"
type = "DEV1-S"
zone = scaleway_vpc_private_network.pn01.zone
}

resource "scaleway_instance_private_nic" "pnic01" {
server_id = scaleway_instance_server.base.id
private_network_id = scaleway_vpc_private_network.pn01.id
zone = scaleway_vpc_private_network.pn01.zone
}
```

## Arguments Reference

The following arguments are required:

- `server_id` - (Required) The ID of the server associated with.
- `private_network_id` - (Required) The ID of the private network attached to.
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the server must be created.

## Attributes Reference

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

- `id` - The ID of the private NIC.
- ``mac_address` - The MAC address of the private NIC.
- `mac_address` - The MAC address of the private NIC.

## Import

Expand Down