cloudwatchlogs_log_group.py: retention handling improvement (#48004)

* cloudwatchlogs_log_group.py: retention handling improvement

* add purge_retention_policy to cloudwatchlogs_log_group.py

* update version added for purge_retention_policy feature

* make retention and purge_retention_policy mutually exclusive

* make purge_retention_policy and overwrite mutually exclusive

* changelog

Co-authored-by: Sloane Hertel <shertel@redhat.com>
Co-authored-by: Mark Chappell <mchappel@redhat.com>

changelogs/fragments/480004-cloudwatchlogs_log_group-KeyError.yaml

@@ -0,0 +1,4 @@
+---
+bugfixes:
+  - cloudwatchlogs_log_group - Fix a KeyError when updating a log group that does not have a retention period
+    (https://github.com/ansible/ansible/issues/47945)

lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group.py

@@ -50,11 +50,21 @@ options:
       description:
         - The number of days to retain the log events in the specified log group.
         - "Valid values are: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]"
+        - Mutually exclusive with I(purge_retention_policy).
       required: false
       type: int
+    purge_retention_policy:
+      description:
+        - "Whether to purge the retention policy or not."
+        - "Mutually exclusive with I(retention) and I(overwrite)."
+      default: false
+      required: false
+      type: bool
+      version_added: "2.10"
     overwrite:
       description:
         - Whether an existing log group should be overwritten on create.
+        - Mutually exclusive with I(purge_retention_policy).
       default: false
       required: false
       type: bool
@@ -183,6 +193,17 @@ def input_retention_policy(client, log_group_name, retention, module):
                          exception=traceback.format_exc())
 
 
+def delete_retention_policy(client, log_group_name, module):
+    try:
+        client.delete_retention_policy(logGroupName=log_group_name)
+    except botocore.exceptions.ClientError as e:
+        module.fail_json(msg="Unable to delete retention policy for log group {0}: {1}".format(log_group_name, to_native(e)),
+                         exception=traceback.format_exc(), **camel_dict_to_snake_dict(e.response))
+    except botocore.exceptions.BotoCoreError as e:
+        module.fail_json(msg="Unable to delete retention policy for log group {0}: {1}".format(log_group_name, to_native(e)),
+                         exception=traceback.format_exc())
+
+
 def delete_log_group(client, log_group_name, module):
     desc_log_group = describe_log_group(client=client,
                                         log_group_name=log_group_name,
@@ -223,10 +244,12 @@ def main():
         kms_key_id=dict(required=False, type='str'),
         tags=dict(required=False, type='dict'),
         retention=dict(required=False, type='int'),
+        purge_retention_policy=dict(required=False, type='bool', default=False),
         overwrite=dict(required=False, type='bool', default=False)
     ))
 
-    module = AnsibleModule(argument_spec=argument_spec)
+    mutually_exclusive = [['retention', 'purge_retention_policy'], ['purge_retention_policy', 'overwrite']]
+    module = AnsibleModule(argument_spec=argument_spec, mutually_exclusive=mutually_exclusive)
 
     if not HAS_BOTO3:
         module.fail_json(msg='boto3 is required.')
@@ -246,15 +269,31 @@ def main():
             break
 
     if state == 'present':
-        if found_log_group and module.params['overwrite'] is True:
-            changed = True
-            delete_log_group(client=logs, log_group_name=module.params['log_group_name'], module=module)
-            found_log_group = create_log_group(client=logs,
-                                               log_group_name=module.params['log_group_name'],
-                                               kms_key_id=module.params['kms_key_id'],
-                                               tags=module.params['tags'],
-                                               retention=module.params['retention'],
-                                               module=module)
+        if found_log_group:
+            if module.params['overwrite'] is True:
+                changed = True
+                delete_log_group(client=logs, log_group_name=module.params['log_group_name'], module=module)
+                found_log_group = create_log_group(client=logs,
+                                                   log_group_name=module.params['log_group_name'],
+                                                   kms_key_id=module.params['kms_key_id'],
+                                                   tags=module.params['tags'],
+                                                   retention=module.params['retention'],
+                                                   module=module)
+            elif module.params['purge_retention_policy']:
+                if found_log_group.get('retentionInDays'):
+                    changed = True
+                    delete_retention_policy(client=logs,
+                                            log_group_name=module.params['log_group_name'],
+                                            module=module)
+            elif module.params['retention'] != found_log_group.get('retentionInDays'):
+                if module.params['retention'] is not None:
+                    changed = True
+                    input_retention_policy(client=logs,
+                                           log_group_name=module.params['log_group_name'],
+                                           retention=module.params['retention'],
+                                           module=module)
+                    found_log_group['retentionInDays'] = module.params['retention']
+
         elif not found_log_group:
             changed = True
             found_log_group = create_log_group(client=logs,
@@ -263,14 +302,6 @@ def main():
                                                tags=module.params['tags'],
                                                retention=module.params['retention'],
                                                module=module)
-        elif found_log_group:
-            if module.params['retention'] != found_log_group['retentionInDays']:
-                changed = True
-                input_retention_policy(client=logs,
-                                       log_group_name=module.params['log_group_name'],
-                                       retention=module.params['retention'],
-                                       module=module)
-                found_log_group['retentionInDays'] = module.params['retention']
 
         module.exit_json(changed=changed, **camel_dict_to_snake_dict(found_log_group))