EFS: Added backup option #1502
Open
EFS: Added backup option #1502
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Docs Build 📝Thank you for contribution!✨ The docsite for this PR is available for download as an artifact from this run: You can compare to the docs for the File changes:
Click to see the diff comparison.NOTE: only file modifications are shown here. New and deleted files are excluded. diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/efs_module.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/efs_module.html
index 192ec97..714b458 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/efs_module.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/efs_module.html
@@ -207,6 +207,19 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-backup"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-backup"><strong>backup</strong></p>
+<a class="ansibleOptionLink" href="#parameter-backup" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>Changes the file system backup policy. Use this option to start or stop automatic backups of the file system.</p>
+<p>By default, automatic backup of the file system is disabled.</p>
+<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
+<ul class="simple">
+<li><p><span class="ansible-option-choices-entry">enabled</span></p></li>
+<li><p><span class="ansible-option-choices-entry">disabled</span></p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-debug_botocore_endpoint_logs"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-debug-botocore-endpoint-logs"><strong>debug_botocore_endpoint_logs</strong></p>
<a class="ansibleOptionLink" href="#parameter-debug_botocore_endpoint_logs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@@ -218,7 +231,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-encrypt"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-encrypt"><strong>encrypt</strong></p>
<a class="ansibleOptionLink" href="#parameter-encrypt" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@@ -230,7 +243,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-endpoint_url"></div>
<div class="ansibleOptionAnchor" id="parameter-ec2_url"></div>
<div class="ansibleOptionAnchor" id="parameter-aws_endpoint_url"></div>
@@ -241,28 +254,28 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
<td><div class="ansible-option-cell"><p>URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.</p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-id"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-id"><strong>id</strong></p>
<a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>ID of Amazon EFS. Either name or ID required for delete.</p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-kms_key_id"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-kms-key-id"><strong>kms_key_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-kms_key_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. The key id can be Key ID, Key ID ARN, Key Alias or Key Alias ARN.</p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-name"><strong>name</strong></p>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete.</p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-performance_mode"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-performance-mode"><strong>performance_mode</strong></p>
<a class="ansibleOptionLink" href="#parameter-performance_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@@ -274,7 +287,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-profile"></div>
<div class="ansibleOptionAnchor" id="parameter-aws_profile"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-profile"><span id="ansible-collections-community-aws-efs-module-parameter-aws-profile"></span><strong>profile</strong></p>
<a class="ansibleOptionLink" href="#parameter-profile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_profile</span></p>
@@ -283,14 +296,14 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
<td><div class="ansible-option-cell"><p>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-provisioned_throughput_in_mibps"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-provisioned-throughput-in-mibps"><strong>provisioned_throughput_in_mibps</strong></p>
<a class="ansibleOptionLink" href="#parameter-provisioned_throughput_in_mibps" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps.</p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-purge_tags"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-purge-tags"><strong>purge_tags</strong></p>
<a class="ansibleOptionLink" href="#parameter-purge_tags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@@ -304,7 +317,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-region"></div>
<div class="ansibleOptionAnchor" id="parameter-aws_region"></div>
<div class="ansibleOptionAnchor" id="parameter-ec2_region"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-region"><span id="ansible-collections-community-aws-efs-module-parameter-ec2-region"></span><span id="ansible-collections-community-aws-efs-module-parameter-aws-region"></span><strong>region</strong></p>
@@ -314,7 +327,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
<td><div class="ansible-option-cell"><p>The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See <a class="reference external" href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region</a></p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-security_token"></div>
<div class="ansibleOptionAnchor" id="parameter-aws_session_token"></div>
<div class="ansibleOptionAnchor" id="parameter-session_token"></div>
@@ -328,7 +341,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
<p>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-state"><strong>state</strong></p>
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@@ -340,7 +353,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-tags"></div>
<div class="ansibleOptionAnchor" id="parameter-resource_tags"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-tags"><span id="ansible-collections-community-aws-efs-module-parameter-resource-tags"></span><strong>tags</strong></p>
<a class="ansibleOptionLink" href="#parameter-tags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: resource_tags</span></p>
@@ -349,35 +362,35 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
<td><div class="ansible-option-cell"><p>List of tags of Amazon EFS. Should be defined as dictionary In case of ‘present’ state with list of tags and existing EFS (matched by ‘name’), tags of EFS will be replaced with provided data.</p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-targets"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-targets"><strong>targets</strong></p>
<a class="ansibleOptionLink" href="#parameter-targets" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: This data may be modified for existing EFS using state ‘present’ and new list of mount targets.</p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-targets/ip_address"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-targets-ip-address"><strong>ip_address</strong></p>
<a class="ansibleOptionLink" href="#parameter-targets/ip_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>A valid IPv4 address within the address range of the specified subnet.</p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-targets/security_groups"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-targets-security-groups"><strong>security_groups</strong></p>
<a class="ansibleOptionLink" href="#parameter-targets/security_groups" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>List of security group IDs, of the form ‘sg-xxxxxxxx’. These must be for the same VPC as subnet specified</p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-targets/subnet_id"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-targets-subnet-id"><strong>subnet_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-targets/subnet_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The ID of the subnet to add the mount target in.</p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-throughput_mode"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-throughput-mode"><strong>throughput_mode</strong></p>
<a class="ansibleOptionLink" href="#parameter-throughput_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@@ -389,7 +402,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-transition_to_ia"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-transition-to-ia"><strong>transition_to_ia</strong></p>
<a class="ansibleOptionLink" href="#parameter-transition_to_ia" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
<p><span class="ansible-option-versionadded">added in community.aws 2.1.0</span></p>
@@ -408,7 +421,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-validate-certs"><strong>validate_certs</strong></p>
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@@ -420,7 +433,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-wait"><strong>wait</strong></p>
<a class="ansibleOptionLink" href="#parameter-wait" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@@ -432,7 +445,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-efs-m
</ul>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div><p class="ansible-option-title" id="ansible-collections-community-aws-efs-module-parameter-wait-timeout"><strong>wait_timeout</strong></p>
<a class="ansibleOptionLink" href="#parameter-wait_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td>
|
ansibullbot
added
community_review
feature
|
@markuman, this feature requires |
|
@akamanzi cool to see your PR. https://github.com/mattclay/aws-terminator/blob/master/aws/policy/storage-services.yaml That means you must made a 2nd pull request there and reference to your PR here. Unfortunately I'm out of office until end of month, maybe @alinabuzachis can assist you there. |
|
@markuman, thanks for getting back. @alinabuzachis, I made the second PR to the |
goneri
suggested changes
Sep 21, 2022
| @@ -79,6 +79,12 @@ | |||
| description: | |||
| - If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps. | |||
| type: float | |||
| backup: | |||
There was a problem hiding this comment.
Can you call it backup_policy to be consistent with AWS's naming.
There was a problem hiding this comment.
This makes sense, I will change this
| @@ -274,6 +280,7 @@ class EFSConnection(object): | |||
| STATE_AVAILABLE = 'available' | |||
| STATE_DELETING = 'deleting' | |||
| STATE_DELETED = 'deleted' | |||
| BACKUP_DISABLED = 'DISABLED' | |||
There was a problem hiding this comment.
I'm not sure the constant increase the readability.
There was a problem hiding this comment.
would BACKUP_POLICY_DISABLED or BACKUP_POLICY_STATUS_DISABLED improve on readability?
| """ | ||
| changed = False | ||
| state = self.get_file_system_state(name) | ||
| if state in [self.STATE_AVAILABLE, self.STATE_CREATING]: |
There was a problem hiding this comment.
If state doesn't match the condition, we silently ignore it and return "unchanged" even if the value is not the one expected.
There was a problem hiding this comment.
Not sure I understand what you mean by this, isn't the "unchanged" when the changed= False?
| ) | ||
| fs_id = self.get_file_system_id(name) | ||
| current_backup_policy = self.get_backup_policy(fs_id) | ||
| params = dict() |
There was a problem hiding this comment.
The code is valide, but params in general is already used for the module parameters. Can you use a different name for your variable?
| @@ -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() | |||
There was a problem hiding this comment.
backup is already a string, you don't need the str() cast.
| @@ -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) | |||
There was a problem hiding this comment.
It should changed |=, not just =, this way we preserve the value if it's set True above.
e.g:
>>> changed = False
>>> changed |= False
>>> changed |= True
>>> changed |= False
>>> changed
True
abikouo
pushed a commit
to abikouo/community.aws
that referenced
this pull request
Oct 24, 2023
…error occurred (AccessControlListNotSupported) when calling the PutObject operation: The bucket does not allow ACLs (ansible-collections#1502) Comment on permission because of botocore.exceptions.ClientError: An error occurred (AccessControlListNotSupported) when calling the PutObject operation: The bucket does not allow ACLs SUMMARY Comment on permission because of botocore.exceptions.ClientError: An error occurred (AccessControlListNotSupported) when calling the PutObject operation: The bucket does not allow ACLs ISSUE TYPE Bugfix Pull Request Docs Pull Request Feature Pull Request New Module Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Jill R Reviewed-by: Alina Buzachis
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Added backup option to the
efsmodule which enables automatic backup of the file system.Addresses issue #1266
ISSUE TYPE
COMPONENT NAME
Impacted component:
efsmoduleADDITIONAL INFORMATION
To enable automatic backup, you can add the following to the playbook
Disabling automatic backup: