diff --git a/docs/data-sources/access_key.md b/docs/data-sources/access_key.md index 089ffdd5e..fa54706df 100644 --- a/docs/data-sources/access_key.md +++ b/docs/data-sources/access_key.md @@ -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 diff --git a/docs/data-sources/access_keys.md b/docs/data-sources/access_keys.md index 7af4a47e9..89cc1fa36 100644 --- a/docs/data-sources/access_keys.md +++ b/docs/data-sources/access_keys.md @@ -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 diff --git a/docs/data-sources/image.md b/docs/data-sources/image.md index 93d32753e..590bf56f6 100644 --- a/docs/data-sources/image.md +++ b/docs/data-sources/image.md @@ -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`). @@ -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.
+(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`).
+(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. diff --git a/docs/data-sources/images.md b/docs/data-sources/images.md index 6f1bebff3..826ffaa82 100644 --- a/docs/data-sources/images.md +++ b/docs/data-sources/images.md @@ -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`). @@ -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.
+(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`).
+(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`). diff --git a/docs/data-sources/security_group.md b/docs/data-sources/security_group.md index dc8538e95..0e31195f1 100644 --- a/docs/data-sources/security_group.md +++ b/docs/data-sources/security_group.md @@ -62,10 +62,10 @@ 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. @@ -73,10 +73,10 @@ 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. * `security_group_id` - The ID of the security group. diff --git a/docs/data-sources/security_groups.md b/docs/data-sources/security_groups.md index fb6c143af..1086903de 100644 --- a/docs/data-sources/security_groups.md +++ b/docs/data-sources/security_groups.md @@ -67,10 +67,10 @@ 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. @@ -78,10 +78,10 @@ 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. * `security_group_id` - The ID of the security group. diff --git a/docs/data-sources/snapshot.md b/docs/data-sources/snapshot.md index 7aa251f33..d7f91644c 100644 --- a/docs/data-sources/snapshot.md +++ b/docs/data-sources/snapshot.md @@ -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. @@ -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). @@ -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.
+(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`).
+(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`). diff --git a/docs/data-sources/snapshots.md b/docs/data-sources/snapshots.md index f2545c046..3bff01fab 100644 --- a/docs/data-sources/snapshots.md +++ b/docs/data-sources/snapshots.md @@ -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. @@ -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). @@ -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.
+(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`).
+(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`). diff --git a/docs/data-sources/vm.md b/docs/data-sources/vm.md index 4c1561618..9687ee28f 100644 --- a/docs/data-sources/vm.md +++ b/docs/data-sources/vm.md @@ -42,7 +42,7 @@ The following attributes are exported: * `block_device_mappings_created` - The block device mapping of the VM. * `bsu` - Information about the created BSU volume. * `delete_on_vm_deletion` - If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. - * `link_date` - The time and date of attachment of the volume to the VM. + * `link_date` - The date and time of attachment of the volume to the VM, in ISO 8601 date-time format. * `state` - The state of the volume. * `volume_id` - The ID of the volume. * `device_name` - The name of the device. @@ -93,7 +93,7 @@ The following attributes are exported: * `tenancy` - The tenancy of the VM (`default` \| `dedicated`). * `private_dns_name` - The name of the private DNS. * `private_ip` - The primary private IP of the VM. -* `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10). +* `product_codes` - The product codes associated with the OMI used to create the VM. * `public_dns_name` - The name of the public DNS. * `public_ip` - The public IP of the VM. * `reservation_id` - The reservation ID of the VM. diff --git a/docs/data-sources/vms.md b/docs/data-sources/vms.md index b67a0893f..e4c1c8670 100644 --- a/docs/data-sources/vms.md +++ b/docs/data-sources/vms.md @@ -47,7 +47,7 @@ The following attributes are exported: * `block_device_mappings_created` - The block device mapping of the VM. * `bsu` - Information about the created BSU volume. * `delete_on_vm_deletion` - If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. - * `link_date` - The time and date of attachment of the volume to the VM. + * `link_date` - The date and time of attachment of the volume to the VM, in ISO 8601 date-time format. * `state` - The state of the volume. * `volume_id` - The ID of the volume. * `device_name` - The name of the device. @@ -98,7 +98,7 @@ The following attributes are exported: * `tenancy` - The tenancy of the VM (`default` \| `dedicated`). * `private_dns_name` - The name of the private DNS. * `private_ip` - The primary private IP of the VM. - * `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10). + * `product_codes` - The product codes associated with the OMI used to create the VM. * `public_dns_name` - The name of the public DNS. * `public_ip` - The public IP of the VM. * `reservation_id` - The reservation ID of the VM. diff --git a/docs/data-sources/volume.md b/docs/data-sources/volume.md index 42c130604..4dbb489a2 100644 --- a/docs/data-sources/volume.md +++ b/docs/data-sources/volume.md @@ -29,10 +29,10 @@ data "outscale_volume" "outscale_volume01" { 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: - * `creation_dates` - (Optional) The dates and times of creation of the volumes. + * `creation_dates` - (Optional) The dates and times of creation of the volumes, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). * `link_volume_delete_on_vm_deletion` - (Optional) Whether the volumes are deleted or not when terminating the VMs. * `link_volume_device_names` - (Optional) The VM device names. - * `link_volume_link_dates` - (Optional) The dates and times of creation of the volumes. + * `link_volume_link_dates` - (Optional) The dates and times of creation of the volumes, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). * `link_volume_link_states` - (Optional) The attachment states of the volumes (`attaching` \| `detaching` \| `attached` \| `detached`). * `link_volume_vm_ids` - (Optional) One or more IDs of VMs. * `snapshot_ids` - (Optional) The snapshots from which the volumes were created. diff --git a/docs/data-sources/volumes.md b/docs/data-sources/volumes.md index 2571f2704..fc174db94 100644 --- a/docs/data-sources/volumes.md +++ b/docs/data-sources/volumes.md @@ -33,10 +33,10 @@ data "outscale_volumes" "outscale_volumes01" { 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: - * `creation_dates` - (Optional) The dates and times of creation of the volumes. + * `creation_dates` - (Optional) The dates and times of creation of the volumes, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). * `link_volume_delete_on_vm_deletion` - (Optional) Whether the volumes are deleted or not when terminating the VMs. * `link_volume_device_names` - (Optional) The VM device names. - * `link_volume_link_dates` - (Optional) The dates and times of creation of the volumes. + * `link_volume_link_dates` - (Optional) The dates and times of creation of the volumes, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). * `link_volume_link_states` - (Optional) The attachment states of the volumes (`attaching` \| `detaching` \| `attached` \| `detached`). * `link_volume_vm_ids` - (Optional) One or more IDs of VMs. * `snapshot_ids` - (Optional) The snapshots from which the volumes were created. diff --git a/docs/resources/access_key.md b/docs/resources/access_key.md index 12725f742..889367d7e 100644 --- a/docs/resources/access_key.md +++ b/docs/resources/access_key.md @@ -29,7 +29,7 @@ resource "outscale_access_key" "access_key01" { The following arguments are supported: -* `expiration_date` - (Optional) The date and time at which you want the access key to expire, in ISO 8601 format (for example, `2017-06-14` or `2017-06-14T00:00:00Z`). To remove an existing expiration date, use the method without specifying this parameter. +* `expiration_date` - (Optional) The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`, or `2020-06-14`). To remove an existing expiration date, use the method without specifying this parameter. * `state` - (Optional) The state for the access key (`ACTIVE` | `INACTIVE`). ## Attribute Reference diff --git a/docs/resources/image.md b/docs/resources/image.md index f45fb7c23..9aca6fe19 100644 --- a/docs/resources/image.md +++ b/docs/resources/image.md @@ -89,6 +89,7 @@ For more information about volume types, see [About Volumes > Volume Types and I * `image_name` - (Optional) A unique name for the new OMI.
Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). * `no_reboot` - (Optional) If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. +* `product_codes` - (Optional) The product codes associated with the OMI. * `root_device_name` - (Optional) The name of the root device. You must specify only one of the following parameters: `file_location`, `root_device_name`, `source_image_id` or `vm_id`. * `source_image_id` - (Optional) The ID of the OMI you want to copy. You must specify only one of the following parameters: `file_location`, `root_device_name`, `source_image_id` or `vm_id`. * `source_region_name` - (Optional) The name of the source Region, which must be the same as the Region of your account. @@ -116,16 +117,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.
+(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`).
+(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. diff --git a/docs/resources/image_launch_permission.md b/docs/resources/image_launch_permission.md index 3c4fa6976..a1431a913 100644 --- a/docs/resources/image_launch_permission.md +++ b/docs/resources/image_launch_permission.md @@ -55,7 +55,9 @@ The following attributes are exported: * `description` - The description of the OMI. * `image_id` - The ID 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. +* `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.
+(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`).
+(Response) If true, the resource is public. If false, the resource is private. diff --git a/docs/resources/security_group.md b/docs/resources/security_group.md index d9ce096d7..2b4556253 100644 --- a/docs/resources/security_group.md +++ b/docs/resources/security_group.md @@ -70,10 +70,10 @@ 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. @@ -81,10 +81,10 @@ 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. * `remove_default_outbound_rule` - If false, the security group is created with a default outbound rule allowing all outbound flows. If true, the security group is created without a default outbound rule. diff --git a/docs/resources/security_group_rule.md b/docs/resources/security_group_rule.md index d4ffe6809..92c1c9f62 100644 --- a/docs/resources/security_group_rule.md +++ b/docs/resources/security_group_rule.md @@ -72,15 +72,15 @@ The following arguments are supported: * `from_port_range` - (Optional) The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. * `ip_protocol` - (Optional) 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` - (Optional) One or more IP ranges for the security group rules, in CIDR notation (for example, `10.0.0.0/16`). - * `security_groups_members` - (Optional) Information about one or more members of a security group. - * `account_id` - (Optional) The account ID of a user. - * `security_group_id` - (Required) The ID of the security group. - * `security_group_name` - (Optional) The name of the security group. + * `security_groups_members` - (Optional) Information about one or more source or destination security groups. + * `account_id` - (Optional) The account ID that owns the source or destination security group. + * `security_group_id` - (Required) The ID of a source or destination security group that you want to link to the security group of the rule. + * `security_group_name` - (Optional) (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` - (Optional) 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` - (Optional) The end of the port range for the TCP and UDP protocols, or an ICMP code number. -* `security_group_account_id_to_link` - (Optional) The account ID of the owner of the security group for which you want to create a rule. +* `security_group_account_id_to_link` - (Optional) The account ID that owns the source or destination security group specified in the `security_group_name_to_link` parameter. * `security_group_id` - (Required) The ID of the security group for which you want to create a rule. -* `security_group_name_to_link` - (Optional) The ID of the source security group. If you are in the Public Cloud, you can also specify the name of the source security group. +* `security_group_name_to_link` - (Optional) The ID of a source or destination security group that you want to link to the security group of the rule. * `to_port_range` - (Optional) The end of the port range for the TCP and UDP protocols, or an ICMP code number. If you specify this parameter, you cannot specify the `rules` parameter and its subparameters. ## Attribute Reference @@ -93,10 +93,10 @@ 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. @@ -104,10 +104,10 @@ 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. * `security_group_id` - The ID of the security group. diff --git a/docs/resources/snapshot.md b/docs/resources/snapshot.md index 3e5ef2a50..df4d3cd90 100644 --- a/docs/resources/snapshot.md +++ b/docs/resources/snapshot.md @@ -64,9 +64,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.
+(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`).
+(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`). diff --git a/docs/resources/snapshot_attributes.md b/docs/resources/snapshot_attributes.md index ce18ffc88..1bddbf3d0 100644 --- a/docs/resources/snapshot_attributes.md +++ b/docs/resources/snapshot_attributes.md @@ -71,5 +71,6 @@ The following arguments are supported: 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. * `snapshot_id` - The ID of the snapshot. diff --git a/docs/resources/vm.md b/docs/resources/vm.md index 5c548778d..02d7bbc3f 100644 --- a/docs/resources/vm.md +++ b/docs/resources/vm.md @@ -227,7 +227,7 @@ The following attributes are exported: * `block_device_mappings_created` - The block device mapping of the VM. * `bsu` - Information about the created BSU volume. * `delete_on_vm_deletion` - If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. - * `link_date` - The time and date of attachment of the volume to the VM. + * `link_date` - The date and time of attachment of the volume to the VM, in ISO 8601 date-time format. * `state` - The state of the volume. * `volume_id` - The ID of the volume. * `device_name` - The name of the device. @@ -277,7 +277,7 @@ The following attributes are exported: * `placement_tenancy` - The tenancy of the VM (`default` | `dedicated`). * `private_dns_name` - The name of the private DNS. * `private_ip` - The primary private IP of the VM. -* `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10). +* `product_codes` - The product codes associated with the OMI used to create the VM. * `public_dns_name` - The name of the public DNS. * `public_ip` - The public IP of the VM. * `reservation_id` - The reservation ID of the VM. diff --git a/scripts/docs/doc-terraform-template b/scripts/docs/doc-terraform-template index 0e26e517a..d9914cb8a 160000 --- a/scripts/docs/doc-terraform-template +++ b/scripts/docs/doc-terraform-template @@ -1 +1 @@ -Subproject commit 0e26e517aef011ed2003532b02dbadf8c9a9dbf3 +Subproject commit d9914cb8ae34c1a2c6b5606d025b012b3da1945e