EFS: Added backup option

changelogs/fragments/1502-efs-add-backup-option.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - efs - adds ``backup`` option to enable/disable automatic backups on the file system (https://github.com/ansible-collections/community.aws/issues/1266).

plugins/modules/efs.py

@@ -79,6 +79,12 @@
         description:
             - If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps.
         type: float
+    backup:
+        description:
+            - Changes the file system backup policy. Use this option to start or stop automatic backups of the file system.
+            - By default, automatic backup of the file system is disabled.
+        choices: ['enabled', 'disabled']
+        type: str
     wait:
         description:
             - "In case of 'present' state should wait for EFS 'available' life cycle state (of course, if current state not 'deleting' or 'deleted')
@@ -274,6 +280,7 @@ class EFSConnection(object):
     STATE_AVAILABLE = 'available'
     STATE_DELETING = 'deleting'
     STATE_DELETED = 'deleted'
+    BACKUP_DISABLED = 'DISABLED'
 
     def __init__(self, module):
         self.connection = module.client('efs')
@@ -413,6 +420,24 @@ def get_provisioned_throughput_in_mibps(self, **kwargs):
         ))
         return info.get('ProvisionedThroughputInMibps', None)
 
+    def get_backup_policy(self, fs_id):
+        """
+         Returns the status of Filesystem backup policy
+        """
+        try:
+            info = self.connection.describe_backup_policy(FileSystemId=fs_id)
+            return info['BackupPolicy']['Status']
+        except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
+            # PolicyNotFound error returned whenever default backup policy is in effect
+            # In this case, we return disabled status
+            # By default, the automatic backup is disabled
+            if e.response['Error']['Code'] == 'PolicyNotFound':
+                return self.BACKUP_DISABLED
+            else:
+                self.module.fail_json_aws(e, msg="Unable to get file system backup policy.")
+
+        return self.BACKUP_DISABLED
+
     def create_file_system(self, name, performance_mode, encrypt, kms_key_id, throughput_mode, provisioned_throughput_in_mibps):
         """
          Creates new filesystem with selected name
@@ -502,6 +527,30 @@ def update_lifecycle_policy(self, name, transition_to_ia):
                 changed = True
         return changed
 
+    def change_backup_policy(self, name, status):
+        """
+        Enable/disable automatic backup policy of the FileSystem.
+        """
+        changed = False
+        state = self.get_file_system_state(name)
+        if state in [self.STATE_AVAILABLE, self.STATE_CREATING]:
+            wait_for(
+                lambda: self.get_file_system_state(name),
+                self.STATE_AVAILABLE,
+                self.wait_timeout
+            )
+            fs_id = self.get_file_system_id(name)
+            current_backup_policy = self.get_backup_policy(fs_id)
+            params = dict()
+            if status != current_backup_policy:
+                params['Status'] = status
+                try:
+                    self.connection.put_backup_policy(FileSystemId=fs_id, BackupPolicy=params)
+                    changed = True
+                except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
+                    self.module.fail_json_aws(e, msg="Unable to update backup policy status.")
+        return changed
+
     def converge_file_system(self, name, tags, purge_tags, targets, throughput_mode, provisioned_throughput_in_mibps):
         """
          Change attributes (mount targets and tags) of filesystem by name
@@ -726,6 +775,7 @@ def main():
         transition_to_ia=dict(required=False, type='str', choices=["None", "7", "14", "30", "60", "90"], default=None),
         throughput_mode=dict(required=False, type='str', choices=["bursting", "provisioned"], default=None),
         provisioned_throughput_in_mibps=dict(required=False, type='float'),
+        backup=dict(required=False, type='str', choices=["enabled", "disabled"], default=None),
         wait=dict(required=False, type="bool", default=False),
         wait_timeout=dict(required=False, type="int", default=0)
     )
@@ -754,6 +804,7 @@ def main():
     transition_to_ia = module.params.get('transition_to_ia')
     throughput_mode = module.params.get('throughput_mode')
     provisioned_throughput_in_mibps = module.params.get('provisioned_throughput_in_mibps')
+    backup = module.params.get('backup')
     state = str(module.params.get('state')).lower()
     changed = False
 
@@ -767,6 +818,9 @@ def main():
                                                   throughput_mode=throughput_mode, provisioned_throughput_in_mibps=provisioned_throughput_in_mibps) or changed
         if transition_to_ia:
             changed |= connection.update_lifecycle_policy(name, transition_to_ia)
+        if backup:
+            backup = str(backup).upper()
+            changed = connection.change_backup_policy(name, backup)
         result = first_or_default(connection.get_file_systems(CreationToken=name))
 
     elif state == 'absent':

tests/integration/targets/efs/tasks/main.yml

@@ -304,6 +304,74 @@
           - efs_result is not changed
 
     # ============================================================
+    - name: Efs enable automatic backup 
+      efs:
+        state: present
+        name: "{{ efs_name }}-test-efs"
+        tags:
+            Name: "{{ efs_name }}-test-tag"
+            Purpose: file-storage
+        targets:
+            - subnet_id: "{{testing_subnet_a.subnet.id}}"
+            - subnet_id: "{{testing_subnet_b.subnet.id}}"
+        backup: 'enabled'
+      register: efs_result
+
+    - assert:
+        that:
+          - efs_result is changed
+
+    - name: Efs enable automatic backup - idempotency
+      efs:
+        state: present
+        name: "{{ efs_name }}-test-efs"
+        tags:
+            Name: "{{ efs_name }}-test-tag"
+            Purpose: file-storage
+        targets:
+            - subnet_id: "{{testing_subnet_a.subnet.id}}"
+            - subnet_id: "{{testing_subnet_b.subnet.id}}"
+        backup: 'enabled'
+      register: efs_result
+
+    - assert:
+        that:
+          - efs_result is not changed
+
+    - name: Efs disable automatic backup 
+      efs:
+        state: present
+        name: "{{ efs_name }}-test-efs"
+        tags:
+            Name: "{{ efs_name }}-test-tag"
+            Purpose: file-storage
+        targets:
+            - subnet_id: "{{testing_subnet_a.subnet.id}}"
+            - subnet_id: "{{testing_subnet_b.subnet.id}}"
+        backup: 'disabled'
+      register: efs_result
+
+    - assert:
+        that:
+          - efs_result is changed
+
+    - name: Efs disable automatic backup - idempotency
+      efs:
+        state: present
+        name: "{{ efs_name }}-test-efs"
+        tags:
+            Name: "{{ efs_name }}-test-tag"
+            Purpose: file-storage
+        targets:
+            - subnet_id: "{{testing_subnet_a.subnet.id}}"
+            - subnet_id: "{{testing_subnet_b.subnet.id}}"
+        backup: 'disabled'
+      register: efs_result
+
+    - assert:
+        that:
+          - efs_result is not changed
+    # ============================================================
     - name: Query unknown EFS by tag
       efs_info:
         tags: