Update parameter naming, aliases, and requirements

Signed-off-by: Webster Mudge <wmudge@cloudera.com>

Author: wmudge

plugins/modules/dw_cluster.py

@@ -35,17 +35,19 @@
 requirements:
   - cdpy
 options:
-  name:
+  cluster_id:
     description:
       - The identifier of the Data Warehouse Cluster.
-      - Required if C(state=absent) and C(env) is not specified.
+      - Required if I(state=absent) and I(env) is not specified.
     type: str
     aliases:
       - id
+      - name
   env:
     description:
       - The name of the target environment.
-      - Required if C(state=present) or C(state=absent) and C(id) is not specified.
+      - Required if I(state=present).
+      - Required if I(state=absent) and I(cluster_id) is not specified.
     type: str
     aliases:
       - environment
@@ -63,24 +65,24 @@
   aws_public_subnets:
     description:
       - List of zero or more Public AWS Subnet IDs used for deployment.
-      - Required if C(state=present) and the C(env) is deployed to AWS.
+      - Required if I(state=present) and the I(env) is deployed to AWS.
     type: list
     elements: str
   aws_private_subnets:
     description:
       - List of zero or more Private AWS Subnet IDs used for deployment.
-      - Required if C(state=present) and the C(env) is deployed to AWS.
+      - Required if I(state=present) and the I(env) is deployed to AWS.
     type: list
     elements: str
   az_subnet:
     description:
       - The Azure Subnet Name.
-      - Required if C(state=present) and the C(env) is deployed to Azure.
+      - Required if I(state=present) and the I(env) is deployed to Azure.
     type: str
   az_enable_az:
     description: 
       - Flag to enable Availability Zone mode.
-      - Required if C(state=present) and the C(env) is deployed to Azure.
+      - Required if I(state=present) and the I(env) is deployed to Azure.
     type: bool
   state:
     description: The state of the Data Warehouse Cluster
@@ -154,45 +156,49 @@
   description: Details for the Data Warehouse cluster
   type: dict
   contains:
-    name:
-      description: The name of the cluster.
+    id:
+      description: The cluster identifier.
       returned: always
       type: str
     environmentCrn:
-      description: The crn of the cluster's environment.
+      description: The CRN of the cluster's Environment
       returned: always
       type: str
     crn:
       description: The cluster's CRN.
       returned: always
       type: str
     creationDate:
-      description: The creation time of the cluster in UTC.
+      description: The creation timestamp of the cluster in UTC.
       returned: always
       type: str
     status:
-      description: The status of the cluster.
+      description: The status of the cluster
       returned: always
       type: str
     creator:
-      description: The details regarding the cluster creator.
+      description: The cluster creator details.
       returned: always
       type: dict
       contains:
         crn:
+          description: The Actor CRN.
           type: str
-          description: The creator's CRN
+          returned: always
         email:
+          description: Email address (users).
           type: str
-          description: Email address
+          returned: when supported
         workloadUsername:
+          description: Username (users).
           type: str
-          description: Username
+          returned: when supported
         machineUsername:
+          description: Username (machine users).
           type: str
-          description: Username for machine users
+          returned: when supported
     cloudPlatform:
-      description: The cloud platform of the environment housing the Data Warehouse cluster
+      description: The cloud platform of the environment that was used to create this cluster.
       returned: always
       type: str
 sdk_out:
@@ -325,14 +331,14 @@ def process(self):
 def main():
     module = AnsibleModule(
         argument_spec=CdpModule.argument_spec(
-            name=dict(type='str', aliases=['id']),
+            cluster_id=dict(type='str', aliases=['id', 'name']),
             env=dict(type='str', aliases=['environment', 'env_crn']),
             overlay=dict(type='bool', default=False),
             private_load_balancer=dict(type='bool', default=False),
-            az_subnet=dict(type='str', default=None),
-            az_enable_az=dict(type='bool', default=None),
-            aws_public_subnets=dict(type='list', default=None),
-            aws_private_subnets=dict(type='list', default=None),
+            az_subnet=dict(type='str'),
+            az_enable_az=dict(type='bool'),
+            aws_public_subnets=dict(type='list'),
+            aws_private_subnets=dict(type='list'),
             state=dict(type='str', choices=['present', 'absent'], default='present'),
             force=dict(type='bool', default=False),
             wait=dict(type='bool', default=True),
@@ -344,7 +350,7 @@ def main():
             ['aws_public_subnets', 'aws_private_subnets']
         ],
         required_if=[
-            ['state', 'absent', ['name', 'env']],
+            ['state', 'absent', ['cluster_id', 'env'], True],
             ['state', 'present', ['env']]
         ],
         supports_check_mode=True

plugins/modules/dw_virtual_warehouse.py

@@ -40,6 +40,8 @@
       - The identifier of the Virtual Warehouse.
       - Required if C(state=absent).
     type: str
+    aliases:
+      - vw_id
   cluster_id:
     description: 
       - The identifier of the parent Data Warehouse Cluster of the Virtual Warehouse.
@@ -246,7 +248,7 @@
 virtual_warehouse:
   description: The details about the CDP Data Warehouse Virtual Warehouse.
   type: dict
-  suboptions:
+  contains:
     id:
       description: The identifier of the Virtual Warehouse.
       returned: always
@@ -272,25 +274,25 @@
       returned: always
       type: str
     creator:
-      description: The CRN of the Virtual Warehouse creator.
+      description: Details about the Virtual Warehouse creator.
       returned: always
       type: dict
       suboptions:
         crn:
+          description: The creator's Actor CRN.
           type: str
-          description: The creator's Actor CRN
           returned: always
         email:
+          description: Email address (for users).
           type: str
-          description: Email address (for users)
           returned: when supported
         workloadUsername:
+          description: Username (for users).
           type: str
-          description: Username (for users)
           returned: when supported
         machineUsername:
+          description: Username (for machine users).
           type: str
-          description: Username (for machine users)
           returned: when supported
     tags:
       description: Custom tags applied to the Virtual Warehouse.
@@ -420,7 +422,7 @@ def process(self):
 def main():
     module = AnsibleModule(
         argument_spec=CdpModule.argument_spec(
-            id=dict(type='str'),
+            id=dict(type='str', aliases=['vw_id']),
             cluster_id=dict(required=True, type='str'),
             dbc_id=dict(type='str'),
             type = dict(type='str'),