minor updates

ansible-collections · Jul 2, 2024 · a960c25 · a960c25
1 parent 3386baf
commit a960c25
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 37 deletions.
diff --git a/changelogs/fragments/20240107-refactor_ec2_vol-modules.yml b/changelogs/fragments/20240107-refactor_ec2_vol-modules.yml
@@ -1,3 +1,4 @@
 ---
 minor_changes:
-  - ec2_vol - refactored code to use ``AnsibleEC2Error`` as well as moving shared code into module_utils.ec2 (https://github.com/ansible-collections/amazon.aws/pull/2170).  - ec2_vol_info - refactored code to use ``AnsibleEC2Error`` as well as moving shared code into module_utils.ec2 (https://github.com/ansible-collections/amazon.aws/pull/2170).
+  - ec2_vol - refactored code to use ``AnsibleEC2Error`` as well as moving shared code into module_utils.ec2 (https://github.com/ansible-collections/amazon.aws/pull/2170).
+  - ec2_vol_info - refactored code to use ``AnsibleEC2Error`` as well as moving shared code into module_utils.ec2 (https://github.com/ansible-collections/amazon.aws/pull/2170).
diff --git a/plugins/modules/ec2_vol.py b/plugins/modules/ec2_vol.py
@@ -11,12 +11,12 @@
 short_description: Create and attach a volume, return volume ID and device map
 description:
   - Creates an EBS volume and optionally attaches it to an instance.
-  - If both I(instance) and I(name) are given and the instance has a device at the device name, then no volume is created and no attachment is made.
+  - If both O(instance) and O(name) are given and the instance has a device at the device name, then no volume is created and no attachment is made.
 options:
   instance:
     description:
       - Instance ID if you wish to attach the volume.
-      - Set to C(None) to detach the volume.
+      - Set to V(None) to detach the volume.
     type: str
   name:
     description:
@@ -32,9 +32,9 @@
     type: int
   volume_type:
     description:
-      - Type of EBS volume; C(standard) (magnetic), C(gp2) (SSD), C(gp3) (SSD), C(io1) (Provisioned IOPS), C(io2) (Provisioned IOPS),
-        C(st1) (Throughput Optimized HDD), C(sc1) (Cold HDD).
-      - C(standard) is the old EBS default and continues to remain the Ansible default for backwards compatibility.
+      - Type of EBS volume; V(standard) (magnetic), V(gp2) (SSD), V(gp3) (SSD), V(io1) (Provisioned IOPS), V(io2) (Provisioned IOPS),
+        V(st1) (Throughput Optimized HDD), V(sc1) (Cold HDD).
+      - V(standard) is the old EBS default and continues to remain the Ansible default for backwards compatibility.
     default: standard
     choices: ['standard', 'gp2', 'io1', 'st1', 'sc1', 'gp3', 'io2']
     type: str
@@ -72,15 +72,15 @@
   state:
     description:
       - Whether to ensure the volume is present or absent.
-      - I(state=list) was deprecated in release 1.1.0 and is no longer available
+      - O(state=list) was deprecated in release 1.1.0 and is no longer available
         with release 4.0.0.
-      - The C(list) functionality has been moved to a dedicated module M(amazon.aws.ec2_vol_info).
+      - The V(list) functionality has been moved to a dedicated module M(amazon.aws.ec2_vol_info).
     default: present
     choices: ['absent', 'present']
     type: str
   modify_volume:
     description:
-      - The volume won't be modified unless this key is C(true).
+      - The volume won't be modified unless this key is V(true).
     type: bool
     default: false
     version_added: 1.4.0
@@ -93,7 +93,7 @@
     version_added: 1.4.0
   multi_attach:
     description:
-      - If set to C(true), Multi-Attach will be enabled when creating the volume.
+      - If set to V(true), Multi-Attach will be enabled when creating the volume.
       - When you create a new volume, Multi-Attach is disabled by default.
       - This parameter is supported with io1 and io2 volumes only.
     type: bool
@@ -107,7 +107,7 @@
 author:
   - "Lester Wade (@lwade)"
 notes:
-  - Support for I(purge_tags) was added in release 1.5.0.
+  - Support for O(purge_tags) was added in release 1.5.0.
 extends_documentation_fragment:
   - amazon.aws.common.modules
   - amazon.aws.region.modules
@@ -205,45 +205,96 @@
 
 RETURN = r"""
 device:
-    description: device name of attached volume
+    description: Device name of attached volume.
     returned: when success
     type: str
     sample: "/dev/sdf"
 volume_id:
-    description: the id of volume
+    description: The id of volume.
     returned: when success
     type: str
     sample: "vol-35b333d9"
 volume_type:
-    description: the volume type
+    description: The volume type.
     returned: when success
     type: str
     sample: "standard"
 volume:
-    description: a dictionary containing detailed attributes of the volume
+    description: A dictionary containing detailed attributes of the volume.
     returned: when success
-    type: str
-    sample: {
-        "attachment_set": [{
-            "attach_time": "2015-10-23T00:22:29.000Z",
-            "deleteOnTermination": "false",
-            "device": "/dev/sdf",
-            "instance_id": "i-8356263c",
-            "status": "attached"
-        }],
-        "create_time": "2015-10-21T14:36:08.870Z",
-        "encrypted": false,
-        "id": "vol-35b333d9",
-        "iops": null,
-        "size": 1,
-        "snapshot_id": "",
-        "status": "in-use",
-        "tags": {
-            "env": "dev"
-        },
-        "type": "standard",
-        "zone": "us-east-1b"
-    }
+    type: dict
+    contains:
+        attachment_set:
+            description:
+                - Information about the volume attachments.
+                - This was changed in version 2.0.0 from a dictionary to a list of dictionaries.
+            type: list
+            elements: dict
+            returned: when success
+            sample: [{
+                "attach_time": "2015-10-23T00:22:29.000Z",
+                "deleteOnTermination": "false",
+                "device": "/dev/sdf",
+                "instance_id": "i-8356263c",
+                "status": "attached"
+            }]
+        create_time:
+            description: The time stamp when volume creation was initiated.
+            type: str
+            returned: when success
+            sample: "2015-10-21T14:36:08.870Z"
+        encrypted:
+            description: Indicates whether the volume is encrypted.
+            type: bool
+            returned: when success
+            sample: False
+        id:
+            description: The ID of the volume.
+            type: str
+            returned: when success
+            sample: "vol-35b333d9"
+        iops:
+            description: The number of I/O operations per second (IOPS) that the volume supports.
+            type: int
+            returned: when success
+            sample: null
+        size:
+            description: The size of the volume, in GiBs.
+            type: int
+            returned: when success
+            sample: 1
+        snapshot_id:
+            description: The snapshot from which the volume was created, if applicable.
+            type: str
+            returned: when success
+            sample: ""
+        status:
+            description: The volume state.
+            type: str
+            returned: when success
+            sample: "in-use"
+        tags:
+            description: Any tags assigned to the volume.
+            type: dict
+            returned: when success
+            sample: {
+                env: "dev"
+                }
+        type:
+            description: The volume type. This can be gp2, io1, st1, sc1, or standard.
+            type: str
+            returned: when success
+            sample: "standard"
+        zone:
+            description: The Availability Zone of the volume.
+            type: str
+            returned: when success
+            sample: "us-east-1b"
+        throughput:
+            description: The throughput that the volume supports, in MiB/s.
+            type: int
+            returned: when success
+            sample: 131
 """
 
 import time