Skip to content

Commit

Permalink
DOC-3104: Global Doc Improvement - Last Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
outscale-lru authored and outscale-mdr committed Nov 12, 2021
1 parent ba64b50 commit 43bffc2
Show file tree
Hide file tree
Showing 6 changed files with 280 additions and 253 deletions.
6 changes: 3 additions & 3 deletions website/docs/d/client_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_client_gateway" "data_client_gateway01" {
filter {
name = "client_gateway_ids"
values = ["cgw-12345678"]
filter {
name = "client_gateway_ids"
values = ["cgw-12345678"]
}
}
```
Expand Down
6 changes: 3 additions & 3 deletions website/docs/d/client_gateways.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_client_gateways" "data_client_gateways01" {
filter {
name = "client_gateway_ids"
values = ["cgw-12345678","cgw-87654321"]
filter {
name = "client_gateway_ids"
values = ["cgw-12345678","cgw-87654321"]
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/route_table_link.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The following attributes are exported:
* `link_route_table_id` - The ID of the association between the route table and the Subnet.
* `main` - If true, the route table is the main one.
* `route_table_id` - The ID of the route table.
* `subnet_id` - The ID of the subnet.
* `subnet_id` - The ID of the Subnet.

## Import

Expand Down
75 changes: 43 additions & 32 deletions website/docs/r/snapshot.html.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: "outscale"
page_title: "3DS OUTSCALE: outscale_snapshot"
page_title: "OUTSCALE: outscale_snapshot"
sidebar_current: "outscale-snapshot"
description: |-
[Manages a snapshot.]
Expand All @@ -14,28 +14,31 @@ For more information on this resource actions, see the [API documentation](https

## Example Usage

```hcl
### Required resource

# Create a snapshot
```hcl
resource "outscale_volume" "volume01" {
subregion_name = "${var.region}a"
size = 40
}
```

#resource "outscale_volume" "volume01" {
# subregion_name = "${var.region}a"
# size = 40
#}
### Create a snapshot

```hcl
resource "outscale_snapshot" "snapshot01" {
volume_id = outscale_volume.volume01.volume_id
volume_id = outscale_volume.volume01.volume_id
}
```

# Copy a snapshot
### Copy a snapshot

```hcl
resource "outscale_snapshot" "snapshot02" {
description = "Terraform snapshot copy"
source_snapshot_id = "snap-12345678"
source_region_name = "eu-west-2"
description = "Terraform snapshot copy"
source_snapshot_id = "snap-12345678"
source_region_name = "eu-west-2"
}
```

## Argument Reference
Expand All @@ -47,28 +50,36 @@ The following arguments are supported:
* `snapshot_size` - (Optional) The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot.
* `source_region_name` - (Optional) The name of the source Region, which must be the same as the Region of your account.
* `source_snapshot_id` - (Optional) The ID of the snapshot you want to copy.
* `tags` - One or more tags to add to this resource.
* `key` - The key of the tag, with a minimum of 1 character.
* `value` - The value of the tag, between 0 and 255 characters.
* `tags` - (Optional) A tag to add to this resource. You can specify this argument several times.
* `key` - (Required) The key of the tag, with a minimum of 1 character.
* `value` - (Required) The value of the tag, between 0 and 255 characters.
* `volume_id` - (Optional) The ID of the volume you want to create a snapshot of.

## Attribute Reference

The following attributes are exported:

* `snapshot` - Information about the snapshot.
* `account_alias` - The account alias of the owner of the snapshot.
* `account_id` - The account ID of the owner of the snapshot.
* `description` - The description of the snapshot.
* `permissions_to_create_volume` - Information about the users who have permissions for the resource.
* `account_ids` - The account ID of one or more users who have permissions for the resource.
* `global_permission` - If true, the resource is public. If false, the resource is private.
* `progress` - The progress of the snapshot, as a percentage.
* `snapshot_id` - The ID of the snapshot.
* `state` - The state of the snapshot (`in-queue` \| `completed` \| `error`).
* `tags` - One or more tags associated with the snapshot.
* `key` - The key of the tag, with a minimum of 1 character.
* `value` - The value of the tag, between 0 and 255 characters.
* `volume_id` - The ID of the volume used to create the snapshot.
* `volume_size` - The size of the volume used to create the snapshot, in gibibytes (GiB).
* `account_alias` - The account alias of the owner of the snapshot.
* `account_id` - The account ID of the owner of the snapshot.
* `description` - The description of the snapshot.
* `permissions_to_create_volume` - Information about the users who have permissions for the resource.
* `account_ids` - The account ID of one or more users who have permissions for the resource.
* `global_permission` - If true, the resource is public. If false, the resource is private.
* `progress` - The progress of the snapshot, as a percentage.
* `snapshot_id` - The ID of the snapshot.
* `state` - The state of the snapshot (`in-queue` \| `completed` \| `error`).
* `tags` - One or more tags associated with the snapshot.
* `key` - The key of the tag, with a minimum of 1 character.
* `value` - The value of the tag, between 0 and 255 characters.
* `volume_id` - The ID of the volume used to create the snapshot.
* `volume_size` - The size of the volume used to create the snapshot, in gibibytes (GiB).

## Import

A snapshot can be imported using its ID. For example:

```console

$ terraform import terraform import outscale_snapshot.ImportedSnapshot snap-12345678

```
Loading

0 comments on commit 43bffc2

Please sign in to comment.