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.

Sign up for GitHub

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

Documentation 0.10.0 #395

Merged
merged 1 commit into from
Nov 10, 2023
Merged

Documentation 0.10.0 #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/data-sources/access_key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ The following arguments are supported:
* `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
* `access_key_ids` - (Optional) The IDs of the access keys.
* `states` - (Optional) The states of the access keys (`ACTIVE` \| `INACTIVE`).
* `user_name` - (Optional) The name of the EIM user. By default, the user who sends the request (which can be the root account).

## Attribute Reference

Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/access_keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ The following arguments are supported:
* `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
* `access_key_ids` - (Optional) The IDs of the access keys.
* `states` - (Optional) The states of the access keys (`ACTIVE` \| `INACTIVE`).
* `user_name` - (Optional) The name of the EIM user. By default, the user who sends the request (which can be the root account).

## Attribute Reference

Expand Down
14 changes: 8 additions & 6 deletions docs/data-sources/image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following arguments are supported:
* `image_names` - (Optional) The names of the OMIs, provided when they were created.
* `permissions_to_launch_account_ids` - (Optional) The account IDs of the users who have launch permissions for the OMIs.
* `permissions_to_launch_global_permission` - (Optional) If true, lists all public OMIs. If false, lists all private OMIs.
* `product_codes` - (Optional) The product code associated with the OMI (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10).
* `product_codes` - (Optional) The product codes associated with the OMI.
* `root_device_names` - (Optional) The name of the root device. This value must be /dev/sda1.
* `root_device_types` - (Optional) The types of root device used by the OMIs (always `bsu`).
* `states` - (Optional) The states of the OMIs (`pending` \| `available` \| `failed`).
Expand Down Expand Up @@ -72,16 +72,18 @@ If you specify a snapshot ID but no volume size, the volume is created with a si
For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops).
* `device_name` - The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
* `virtual_device_name` - The name of the virtual device (`ephemeralN`).
* `creation_date` - The date and time of creation of the OMI.
* `creation_date` - The date and time of creation of the OMI, in ISO 8601 date-time format.
* `description` - The description of the OMI.
* `file_location` - The location of the bucket where the OMI files are stored.
* `image_id` - The ID of the OMI.
* `image_name` - The name of the OMI.
* `image_type` - The type of the OMI.
* `permissions_to_launch` - 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.
* `product_codes` - The product code associated with the OMI (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10).
* `permissions_to_launch` - Permissions for the resource.
* `account_ids` - One or more account IDs that the permission is associated with.
* `global_permission` - A global permission for all accounts.<br />
(Request) Set this parameter to true to make the resource public (if the parent parameter is `Additions`) or to make the resource private (if the parent parameter is `Removals`).<br />
(Response) If true, the resource is public. If false, the resource is private.
* `product_codes` - The product codes associated with the OMI.
* `root_device_name` - The name of the root device.
* `root_device_type` - The type of root device used by the OMI (always `bsu`).
* `state_comment` - Information about the change of state.
Expand Down
14 changes: 8 additions & 6 deletions docs/data-sources/images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The following arguments are supported:
* `image_names` - (Optional) The names of the OMIs, provided when they were created.
* `permissions_to_launch_account_ids` - (Optional) The account IDs of the users who have launch permissions for the OMIs.
* `permissions_to_launch_global_permission` - (Optional) If true, lists all public OMIs. If false, lists all private OMIs.
* `product_codes` - (Optional) The product code associated with the OMI (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10).
* `product_codes` - (Optional) The product codes associated with the OMI.
* `root_device_names` - (Optional) The name of the root device. This value must be /dev/sda1.
* `root_device_types` - (Optional) The types of root device used by the OMIs (always `bsu`).
* `states` - (Optional) The states of the OMIs (`pending` \| `available` \| `failed`).
Expand Down Expand Up @@ -77,16 +77,18 @@ If you specify a snapshot ID but no volume size, the volume is created with a si
For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops).
* `device_name` - The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
* `virtual_device_name` - The name of the virtual device (`ephemeralN`).
* `creation_date` - The date and time of creation of the OMI.
* `creation_date` - The date and time of creation of the OMI, in ISO 8601 date-time format.
* `description` - The description of the OMI.
* `file_location` - The location of the bucket where the OMI files are stored.
* `image_id` - The ID of the OMI.
* `image_name` - The name of the OMI.
* `image_type` - The type of the OMI.
* `permissions_to_launch` - 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.
* `product_codes` - The product code associated with the OMI (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10).
* `permissions_to_launch` - Permissions for the resource.
* `account_ids` - One or more account IDs that the permission is associated with.
* `global_permission` - A global permission for all accounts.<br />
(Request) Set this parameter to true to make the resource public (if the parent parameter is `Additions`) or to make the resource private (if the parent parameter is `Removals`).<br />
(Response) If true, the resource is public. If false, the resource is private.
* `product_codes` - The product codes associated with the OMI.
* `root_device_name` - The name of the root device.
* `root_device_type` - The type of root device used by the OMI (always `bsu`).
* `state` - The state of the OMI (`pending` \| `available` \| `failed`).
Expand Down
16 changes: 8 additions & 8 deletions docs/data-sources/security_group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,21 +62,21 @@ The following attributes are exported:
* `from_port_range` - The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
* `ip_protocol` - The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
* `ip_ranges` - One or more IP ranges for the security group rules, in CIDR notation (for example, `10.0.0.0/16`).
* `security_groups_members` - Information about one or more members of a security group.
* `account_id` - The account ID of a user.
* `security_group_id` - The ID of the security group.
* `security_group_name` - The name of the security group.
* `security_groups_members` - Information about one or more source or destination security groups.
* `account_id` - The account ID that owns the source or destination security group.
* `security_group_id` - The ID of a source or destination security group that you want to link to the security group of the rule.
* `security_group_name` - (Public Cloud only) The name of a source or destination security group that you want to link to the security group of the rule.
* `service_ids` - One or more service IDs to allow traffic from a Net to access the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](https://docs.outscale.com/api#readnetaccesspointservices).
* `to_port_range` - The end of the port range for the TCP and UDP protocols, or an ICMP code number.
* `net_id` - The ID of the Net for the security group.
* `outbound_rules` - The outbound rules associated with the security group.
* `from_port_range` - The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
* `ip_protocol` - The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
* `ip_ranges` - One or more IP ranges for the security group rules, in CIDR notation (for example, `10.0.0.0/16`).
* `security_groups_members` - Information about one or more members of a security group.
* `account_id` - The account ID of a user.
* `security_group_id` - The ID of the security group.
* `security_group_name` - The name of the security group.
* `security_groups_members` - Information about one or more source or destination security groups.
* `account_id` - The account ID that owns the source or destination security group.
* `security_group_id` - The ID of a source or destination security group that you want to link to the security group of the rule.
* `security_group_name` - (Public Cloud only) The name of a source or destination security group that you want to link to the security group of the rule.
* `service_ids` - One or more service IDs to allow traffic from a Net to access the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](https://docs.outscale.com/api#readnetaccesspointservices).
* `to_port_range` - The end of the port range for the TCP and UDP protocols, or an ICMP code number.
* `security_group_id` - The ID of the security group.
Expand Down
16 changes: 8 additions & 8 deletions docs/data-sources/security_groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,21 @@ The following attributes are exported:
* `from_port_range` - The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
* `ip_protocol` - The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
* `ip_ranges` - One or more IP ranges for the security group rules, in CIDR notation (for example, `10.0.0.0/16`).
* `security_groups_members` - Information about one or more members of a security group.
* `account_id` - The account ID of a user.
* `security_group_id` - The ID of the security group.
* `security_group_name` - The name of the security group.
* `security_groups_members` - Information about one or more source or destination security groups.
* `account_id` - The account ID that owns the source or destination security group.
* `security_group_id` - The ID of a source or destination security group that you want to link to the security group of the rule.
* `security_group_name` - (Public Cloud only) The name of a source or destination security group that you want to link to the security group of the rule.
* `service_ids` - One or more service IDs to allow traffic from a Net to access the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](https://docs.outscale.com/api#readnetaccesspointservices).
* `to_port_range` - The end of the port range for the TCP and UDP protocols, or an ICMP code number.
* `net_id` - The ID of the Net for the security group.
* `outbound_rules` - The outbound rules associated with the security group.
* `from_port_range` - The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
* `ip_protocol` - The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
* `ip_ranges` - One or more IP ranges for the security group rules, in CIDR notation (for example, `10.0.0.0/16`).
* `security_groups_members` - Information about one or more members of a security group.
* `account_id` - The account ID of a user.
* `security_group_id` - The ID of the security group.
* `security_group_name` - The name of the security group.
* `security_groups_members` - Information about one or more source or destination security groups.
* `account_id` - The account ID that owns the source or destination security group.
* `security_group_id` - The ID of a source or destination security group that you want to link to the security group of the rule.
* `security_group_name` - (Public Cloud only) The name of a source or destination security group that you want to link to the security group of the rule.
* `service_ids` - One or more service IDs to allow traffic from a Net to access the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](https://docs.outscale.com/api#readnetaccesspointservices).
* `to_port_range` - The end of the port range for the TCP and UDP protocols, or an ICMP code number.
* `security_group_id` - The ID of the security group.
Expand Down
10 changes: 7 additions & 3 deletions docs/data-sources/snapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The following arguments are supported:
* `account_aliases` - (Optional) The account aliases of the owners of the snapshots.
* `account_ids` - (Optional) The account IDs of the owners of the snapshots.
* `descriptions` - (Optional) The descriptions of the snapshots.
* `from_creation_date` - (Optional) The beginning of the time period, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`).
* `permissions_to_create_volume_account_ids` - (Optional) The account IDs of one or more users who have permissions to create volumes.
* `permissions_to_create_volume_global_permission` - (Optional) If true, lists all public volumes. If false, lists all private volumes.
* `progresses` - (Optional) The progresses of the snapshots, as a percentage.
Expand All @@ -40,6 +41,7 @@ The following arguments are supported:
* `tag_keys` - (Optional) The keys of the tags associated with the snapshots.
* `tag_values` - (Optional) The values of the tags associated with the snapshots.
* `tags` - (Optional) The key/value combinations of the tags associated with the snapshots, in the following format: `TAGKEY=TAGVALUE`.
* `to_creation_date` - (Optional) The end of the time period, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
* `volume_ids` - (Optional) The IDs of the volumes used to create the snapshots.
* `volume_sizes` - (Optional) The sizes of the volumes used to create the snapshots, in gibibytes (GiB).

Expand All @@ -51,9 +53,11 @@ The following attributes are exported:
* `account_id` - The account ID of the owner of the snapshot.
* `creation_date` - The date and time of creation 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.
* `permissions_to_create_volume` - Permissions for the resource.
* `account_ids` - One or more account IDs that the permission is associated with.
* `global_permission` - A global permission for all accounts.<br />
(Request) Set this parameter to true to make the resource public (if the parent parameter is `Additions`) or to make the resource private (if the parent parameter is `Removals`).<br />
(Response) 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`).
Expand Down
10 changes: 7 additions & 3 deletions docs/data-sources/snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ The following arguments are supported:
* `account_aliases` - (Optional) The account aliases of the owners of the snapshots.
* `account_ids` - (Optional) The account IDs of the owners of the snapshots.
* `descriptions` - (Optional) The descriptions of the snapshots.
* `from_creation_date` - (Optional) The beginning of the time period, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`).
* `permissions_to_create_volume_account_ids` - (Optional) The account IDs of one or more users who have permissions to create volumes.
* `permissions_to_create_volume_global_permission` - (Optional) If true, lists all public volumes. If false, lists all private volumes.
* `progresses` - (Optional) The progresses of the snapshots, as a percentage.
Expand All @@ -44,6 +45,7 @@ The following arguments are supported:
* `tag_keys` - (Optional) The keys of the tags associated with the snapshots.
* `tag_values` - (Optional) The values of the tags associated with the snapshots.
* `tags` - (Optional) The key/value combinations of the tags associated with the snapshots, in the following format: `TAGKEY=TAGVALUE`.
* `to_creation_date` - (Optional) The end of the time period, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
* `volume_ids` - (Optional) The IDs of the volumes used to create the snapshots.
* `volume_sizes` - (Optional) The sizes of the volumes used to create the snapshots, in gibibytes (GiB).

Expand All @@ -56,9 +58,11 @@ The following attributes are exported:
* `account_id` - The account ID of the owner of the snapshot.
* `creation_date` - The date and time of creation 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.
* `permissions_to_create_volume` - Permissions for the resource.
* `account_ids` - One or more account IDs that the permission is associated with.
* `global_permission` - A global permission for all accounts.<br />
(Request) Set this parameter to true to make the resource public (if the parent parameter is `Additions`) or to make the resource private (if the parent parameter is `Removals`).<br />
(Response) 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`).
Expand Down
Loading
Loading