Skip to content

Commit

Permalink
Release Documentation 1.0.1
Browse files Browse the repository at this point in the history
Signed-off-by: Outscale Bot <[email protected]>
  • Loading branch information
Open-Source-Bot committed Dec 20, 2024
1 parent 53f2417 commit 597c687
Show file tree
Hide file tree
Showing 54 changed files with 915 additions and 52 deletions.
18 changes: 18 additions & 0 deletions docs/data-sources/access_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ For more information on this resource actions, see the [API documentation](https

## Example Usage

### Get one of your own access keys (root account or user)

```hcl
data "outscale_access_key" "access_key01" {
filter {
Expand All @@ -24,6 +26,22 @@ data "outscale_access_key" "access_key01" {
}
```

### Get the access key of another user

```hcl
data "outscale_access_key" "access_key01" {
user_name = "user_name"
filter {
name = "access_key_ids"
values = ["XXXXXXXXX"]
}
filter {
name = "states"
values = ["ACTIVE"]
}
}
```

## Argument Reference

The following arguments are supported:
Expand Down
18 changes: 18 additions & 0 deletions docs/data-sources/access_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ For more information on this resource actions, see the [API documentation](https

## Example Usage

### Get your own access keys (root account or user)

```hcl
data "outscale_access_keys" "access_keys01" {
filter {
Expand All @@ -24,6 +26,22 @@ data "outscale_access_keys" "access_keys01" {
}
```

### Get the access keys of another user

```hcl
data "outscale_access_keys" "access_keys" {
user_name = "user_name"
filter {
name = "access_key_ids"
values = ["XXXXXXXXX","YYYYYYYYYY"]
}
filter {
name = "states"
values = ["ACTIVE"]
}
}
```

## Argument Reference

The following arguments are supported:
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/dhcp_option.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the DHCP options sets.
* `tags` - (Optional) The key/value combinations of the tags associated with the DHCP options sets, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/dhcp_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the DHCP options sets.
* `tags` - (Optional) The key/value combinations of the tags associated with the DHCP options sets, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
53 changes: 53 additions & 0 deletions docs/data-sources/entities_linked_to_policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
layout: "outscale"
page_title: "OUTSCALE: outscale_entities_linked_to_policy"
sidebar_current: "outscale-entities-linked-to-policy"
description: |-
[Provides information about entities (account, users, or user groups) linked to a specific managed policy.]
---

# outscale_entities_linked_to_policy Data Source

Provides information about entities (account, users, or user groups) linked to a specific managed policy.

For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Policies.html).
For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api.html#readentitieslinkedtopolicy).

## Example Usage

```hcl
data "outscale_entities_linked_to_policy" "entities_linked_policy01" {
policy_orn = "orn:ows:idauth::012345678910:policy/example/example-policy"
entities_type = ["USER","GROUP","ACCOUNT"]
}
```

## Argument Reference

The following arguments are supported:

* `entities_type` - (Optional) The type of entity linked to the policy (`ACCOUNT` \| `USER` \| `GROUP`) you want to get information about.
* `first_item` - (Optional) The item starting the list of entities requested.
* `policy_orn` - (Optional) The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
* `results_per_page` - (Optional) The maximum number of items that can be returned in a single response (by default, 100).

## Attribute Reference

The following attributes are exported:

* `accounts` - TODO_ARRAY
* `id` - The ID of the entity.
* `name` - The name of the entity.
* `orn` - The OUTSCALE Resource Name (ORN) of the entity. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
* `groups` - TODO_ARRAY
* `id` - The ID of the entity.
* `name` - The name of the entity.
* `orn` - The OUTSCALE Resource Name (ORN) of the entity. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
* `has_more_items` - If true, there are more items to return using the `first_item` parameter in a new request.
* `items_count` - The number of entities the specified policy is linked to.
* `max_results_limit` - Indicates maximum results defined for the operation.
* `max_results_truncated` - If true, indicates whether requested page size is more than allowed.
* `users` - TODO_ARRAY
* `id` - The ID of the entity.
* `name` - The name of the entity.
* `orn` - The OUTSCALE Resource Name (ORN) of the entity. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
2 changes: 1 addition & 1 deletion docs/data-sources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The following arguments are supported:
* `tags` - (Optional) The key/value combinations of the tags associated with the OMIs, in the following format: `TAGKEY=TAGVALUE`.
* `virtualization_types` - (Optional) The virtualization types (always `hvm`).
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The following arguments are supported:
* `tags` - (Optional) The key/value combinations of the tags associated with the OMIs, in the following format: `TAGKEY=TAGVALUE`.
* `virtualization_types` - (Optional) The virtualization types (always `hvm`).
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/load_balancer_listener_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ The following arguments are supported:
The following attributes are exported:

* `action` - The type of action for the rule (always `forward`).
* `host_name_pattern` - A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?].
* `host_name_pattern` - A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`.
* `listener_id` - The ID of the listener.
* `listener_rule_id` - The ID of the listener rule.
* `listener_rule_name` - A human-readable name for the listener rule.
* `path_pattern` - A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except [_-.$/~&quot;'@:+?].
* `path_pattern` - A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~&quot;'@:+?`.
* `priority` - The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned.
* `vm_ids` - The IDs of the backend VMs.
4 changes: 2 additions & 2 deletions docs/data-sources/load_balancer_listener_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ The following attributes are exported:

* `listener_rules` - The list of the rules to describe.
* `action` - The type of action for the rule (always `forward`).
* `host_name_pattern` - A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?].
* `host_name_pattern` - A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`.
* `listener_id` - The ID of the listener.
* `listener_rule_id` - The ID of the listener rule.
* `listener_rule_name` - A human-readable name for the listener rule.
* `path_pattern` - A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except [_-.$/~&quot;'@:+?].
* `path_pattern` - A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~&quot;'@:+?`.
* `priority` - The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned.
* `vm_ids` - The IDs of the backend VMs.
4 changes: 2 additions & 2 deletions docs/data-sources/load_balancer_vm_health.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ layout: "outscale"
page_title: "OUTSCALE: outscale_load_balancer_vm_health"
sidebar_current: "outscale-load-balancer-vm-health"
description: |-
[Provides information about the health of one or more back-end VMs registered with a specific load balancer.]
[Provides information about the health of one or more backend VMs registered with a specific load balancer.]
---

# outscale_load_balancer_vm_health Data Source

Provides information about the health of one or more back-end VMs registered with a specific load balancer.
Provides information about the health of one or more backend VMs registered with a specific load balancer.

For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html).
For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readvmshealth).
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/nat_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the NAT services.
* `tags` - (Optional) The key/value combinations of the tags associated with the NAT services, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/nat_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the NAT services.
* `tags` - (Optional) The key/value combinations of the tags associated with the NAT services, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/net_access_point.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the Net access points.
* `tags` - (Optional) The key/value combinations of the tags associated with the Net access points, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/net_access_points.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the Net access points.
* `tags` - (Optional) The key/value combinations of the tags associated with the Net access points, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/net_peering.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the Net peerings.
* `tags` - (Optional) The key/value combinations of the tags associated with the Net peerings, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/net_peerings.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following arguments are supported:
* `tag_values` - (Optional) The values of the tags associated with the Net peerings.
* `tags` - (Optional) The key/value combinations of the tags associated with the Net peerings, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.

## Attribute Reference

Expand Down
63 changes: 63 additions & 0 deletions docs/data-sources/policies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
layout: "outscale"
page_title: "OUTSCALE: outscale_policies"
sidebar_current: "outscale-policies"
description: |-
[Provides information about NOT_FOUND.]
---

# outscale_policies Data Source

Provides information about NOT_FOUND.

For more information on this resource, see the [User Guide](NOT_FOUND).
For more information on this resource actions, see the [API documentation](NOT_FOUND).

## Example Usage

```hcl
data "outscale_policies" "user_policies" {
filter {
name = "only_linked"
values = [true]
}
filter {
name = "path_prefix"
values = ["/"]
}
filter {
name = "scope"
values = ["LOCAL"]
}
}
```

## Argument Reference

The following arguments are supported:

* `filters` - One or more filters.
* `only_linked` - (Optional) If set to true, lists only the policies attached to a user.
* `path_prefix` - (Optional) The path prefix you can use to filter the results. If not specified, it is set to a slash (`/`).
* `scope` - (Optional) The scope to filter policies (`OWS` \| `LOCAL`).
* `first_item` - (Optional) The item starting the list of policies requested.
* `results_per_page` - (Optional) The maximum number of items that can be returned in a single response (by default, `100`).

## Attribute Reference

The following attributes are exported:

* `has_more_items` - If true, there are more items to return using the `first_item` parameter in a new request.
* `max_results_limit` - Indicates maximum results defined for the operation.
* `max_results_truncated` - If true, indicates whether requested page size is more than allowed.
* `policies` - Information about one or more policies.
* `creation_date` - The date and time (UTC) at which the policy was created.
* `description` - A friendly name for the policy (between 0 and 1000 characters).
* `is_linkable` - Indicates whether the policy can be linked to a group or an EIM user.
* `last_modification_date` - The date and time (UTC) at which the policy was last modified.
* `orn` - The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
* `path` - The path to the policy.
* `policy_default_version_id` - The ID of the policy default version.
* `policy_id` - The ID of the policy.
* `policy_name` - The name of the policy.
* `resources_count` - The number of resources attached to the policy.
45 changes: 45 additions & 0 deletions docs/data-sources/policies_linked_to_user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: "outscale"
page_title: "OUTSCALE: outscale_policies_linked_to_user"
sidebar_current: "outscale-policies-linked-to-user"
description: |-
[Provides information about a link policy to user.]
---

# outscale_policies_linked_to_user Data Source

Provides information about a link policy to user.

For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Policies.html).
For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api.html#readlinkedpolicies).

## Example Usage

```hcl
data "outscale_policies_linked_to_user" "linked_policy01" {
user_name = "user_name"
}
```

## Argument Reference

The following arguments are supported:

* `filters` - One or more filters.
* `path_prefix` - (Optional) The path prefix of the policies. If not specified, it is set to a slash (`/`).
* `first_item` - (Optional) The item starting the list of policies requested.
* `results_per_page` - (Optional) The maximum number of items that can be returned in a single response (by default, `100`).
* `user_name` - (Required) The name of the user the policies are linked to.

## Attribute Reference

The following attributes are exported:

* `creation_date` - The date and time (UTC) at which the linked policy was created.
* `has_more_items` - If true, there are more items to return using the `first_item` parameter in a new request.
* `last_modification_date` - The date and time (UTC) at which the linked policy was last modified.
* `max_results_limit` - Indicates maximum results defined for the operation.
* `max_results_truncated` - If true, indicates whether requested page size is more than allowed.
* `orn` - The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
* `policy_id` - The ID of the policy.
* `policy_name` - The name of the policy.
Loading

0 comments on commit 597c687

Please sign in to comment.