Adding upstream version 7.3.0+dfsg.upstream/7.3.0+dfsgupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

6 files changed, 310 insertions, 0 deletions

diff --git a/ansible_collections/amazon/aws/plugins/doc_fragments/aws.py b/ansible_collections/amazon/aws/plugins/doc_fragments/aws.py
new file mode 100644
index 00000000..1a3833ff
--- /dev/null
+++ b/ansible_collections/amazon/aws/plugins/doc_fragments/aws.py
@@ -0,0 +1,133 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2014, Will Thames <will@thames.id.au>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # AWS only documentation fragment
+    DOCUMENTATION = r'''
+options:
+  access_key:
+    description:
+      - AWS access key ID.
+      - See the AWS documentation for more information about access tokens
+        U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
+      - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY)
+        environment variables may also be used in decreasing order of
+        preference.
+      - The I(aws_access_key) and I(profile) options are mutually exclusive.
+      - The I(aws_access_key_id) alias was added in release 5.1.0 for
+        consistency with the AWS botocore SDK.
+      - The I(ec2_access_key) alias has been deprecated and will be removed in a
+        release after 2024-12-01.
+      - Support for the C(EC2_ACCESS_KEY) environment variable has been
+        deprecated and will be removed in a release after 2024-12-01.
+    type: str
+    aliases: ['aws_access_key_id', 'aws_access_key', 'ec2_access_key']
+  secret_key:
+    description:
+      - AWS secret access key.
+      - See the AWS documentation for more information about access tokens
+        U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
+      - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY)
+        environment variables may also be used in decreasing order of
+        preference.
+      - The I(secret_key) and I(profile) options are mutually exclusive.
+      - The I(aws_secret_access_key) alias was added in release 5.1.0 for
+        consistency with the AWS botocore SDK.
+      - The I(ec2_secret_key) alias has been deprecated and will be removed in a
+        release after 2024-12-01.
+      - Support for the C(EC2_SECRET_KEY) environment variable has been
+        deprecated and will be removed in a release after 2024-12-01.
+    type: str
+    aliases: ['aws_secret_access_key', 'aws_secret_key', 'ec2_secret_key']
+  session_token:
+    description:
+      - AWS STS session token for use with temporary credentials.
+      - See the AWS documentation for more information about access tokens
+        U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
+      - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN)
+        environment variables may also be used in decreasing order of preference.
+      - The I(security_token) and I(profile) options are mutually exclusive.
+      - Aliases I(aws_session_token) and I(session_token) were added in release
+        3.2.0, with the parameter being renamed from I(security_token) to
+        I(session_token) in release 6.0.0.
+      - The I(security_token), I(aws_security_token), and I(access_token)
+        aliases have been deprecated and will be removed in a release after
+        2024-12-01.
+      - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment
+        variables has been deprecated and will be removed in a release after
+        2024-12-01.
+    type: str
+    aliases: ['aws_session_token', 'security_token', 'aws_security_token', 'access_token']
+  profile:
+    description:
+      - A named AWS profile to use for authentication.
+      - See the AWS documentation for more information about named profiles
+        U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
+      - The C(AWS_PROFILE) environment variable may also be used.
+      - The I(profile) option is mutually exclusive with the I(aws_access_key),
+        I(aws_secret_key) and I(security_token) options.
+    type: str
+    aliases: ['aws_profile']
+
+  endpoint_url:
+    description:
+      - URL to connect to instead of the default AWS endpoints.  While this
+        can be used to connection to other AWS-compatible services the
+        amazon.aws and community.aws collections are only tested against
+        AWS.
+      - The  C(AWS_URL) or C(EC2_URL) environment variables may also be used,
+        in decreasing order of preference.
+      - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be
+        removed in a release after 2024-12-01.
+      - Support for the C(EC2_URL) environment variable has been deprecated and
+        will be removed in a release after 2024-12-01.
+    type: str
+    aliases: ['ec2_url', 'aws_endpoint_url', 's3_url' ]
+  aws_ca_bundle:
+    description:
+      - The location of a CA Bundle to use when validating SSL certificates.
+      - The C(AWS_CA_BUNDLE) environment variable may also be used.
+    type: path
+  validate_certs:
+    description:
+      - When set to C(false), SSL certificates will not be validated for
+        communication with the AWS APIs.
+      - Setting I(validate_certs=false) is strongly discouraged, as an
+        alternative, consider setting I(aws_ca_bundle) instead.
+    type: bool
+    default: true
+  aws_config:
+    description:
+      - A dictionary to modify the botocore configuration.
+      - Parameters can be found in the AWS documentation
+        U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
+    type: dict
+  debug_botocore_endpoint_logs:
+    description:
+      - Use a C(botocore.endpoint) logger to parse the unique (rather than total)
+        C("resource:action") API calls made during a task, outputing the set to
+        the resource_actions key in the task results. Use the
+        C(aws_resource_action) callback to output to total list made during
+        a playbook.
+      - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
+    type: bool
+    default: false
+notes:
+  - B(Caution:) For modules, environment variables and configuration files are
+    read from the Ansible 'host' context and not the 'controller' context.
+    As such, files may need to be explicitly copied to the 'host'.  For lookup
+    and connection plugins, environment variables and configuration files are
+    read from the Ansible 'controller' context and not the 'host' context.
+  - The AWS SDK (boto3) that Ansible uses may also read defaults for credentials
+    and other settings, such as the region, from its configuration files in the
+    Ansible 'host' context (typically C(~/.aws/credentials)).
+    See U(https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html)
+    for more information.
+'''
diff --git a/ansible_collections/amazon/aws/plugins/doc_fragments/aws_credentials.py b/ansible_collections/amazon/aws/plugins/doc_fragments/aws_credentials.py
new file mode 100644
index 00000000..73eff046
--- /dev/null
+++ b/ansible_collections/amazon/aws/plugins/doc_fragments/aws_credentials.py
@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2017,  Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Plugin options for AWS credentials
+    DOCUMENTATION = r'''
+options:
+  aws_profile:
+    description: The AWS profile
+    type: str
+    aliases: [ boto_profile ]
+    env:
+      - name: AWS_DEFAULT_PROFILE
+      - name: AWS_PROFILE
+  aws_access_key:
+    description: The AWS access key to use.
+    type: str
+    aliases: [ aws_access_key_id ]
+    env:
+      - name: EC2_ACCESS_KEY
+      - name: AWS_ACCESS_KEY
+      - name: AWS_ACCESS_KEY_ID
+  aws_secret_key:
+    description: The AWS secret key that corresponds to the access key.
+    type: str
+    aliases: [ aws_secret_access_key ]
+    env:
+      - name: EC2_SECRET_KEY
+      - name: AWS_SECRET_KEY
+      - name: AWS_SECRET_ACCESS_KEY
+  aws_security_token:
+    description: The AWS security token if using temporary access and secret keys.
+    type: str
+    env:
+      - name: EC2_SECURITY_TOKEN
+      - name: AWS_SESSION_TOKEN
+      - name: AWS_SECURITY_TOKEN
+'''
diff --git a/ansible_collections/amazon/aws/plugins/doc_fragments/aws_region.py b/ansible_collections/amazon/aws/plugins/doc_fragments/aws_region.py
new file mode 100644
index 00000000..52152660
--- /dev/null
+++ b/ansible_collections/amazon/aws/plugins/doc_fragments/aws_region.py
@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2017,  Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Plugin option for AWS region
+    DOCUMENTATION = r'''
+options:
+  region:
+    description: The region for which to create the connection.
+    type: str
+    env:
+      - name: EC2_REGION
+      - name: AWS_REGION
+'''
diff --git a/ansible_collections/amazon/aws/plugins/doc_fragments/boto3.py b/ansible_collections/amazon/aws/plugins/doc_fragments/boto3.py
new file mode 100644
index 00000000..a88e2e01
--- /dev/null
+++ b/ansible_collections/amazon/aws/plugins/doc_fragments/boto3.py
@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022,  Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Minimum requirements for the collection
+    DOCUMENTATION = r'''
+options: {}
+requirements:
+  - python >= 3.6
+  - boto3 >= 1.18.0
+  - botocore >= 1.21.0
+'''
diff --git a/ansible_collections/amazon/aws/plugins/doc_fragments/ec2.py b/ansible_collections/amazon/aws/plugins/doc_fragments/ec2.py
new file mode 100644
index 00000000..017652b5
--- /dev/null
+++ b/ansible_collections/amazon/aws/plugins/doc_fragments/ec2.py
@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2015, Ansible, Inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # EC2 only documentation fragment
+    DOCUMENTATION = r'''
+options:
+    region:
+        description:
+          - The AWS region to use.
+          - For global services such as IAM, Route53 and CloudFront, I(region)
+            is ignored.
+          - The C(AWS_REGION) or C(EC2_REGION) environment variables may also
+            be used.
+          - See the Amazon AWS documentation for more information
+            U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
+          - The C(ec2_region) alias has been deprecated and will be removed in
+            a release after 2024-12-01
+          - Support for the C(EC2_REGION) environment variable has been
+            deprecated and will be removed in a release after 2024-12-01.
+        type: str
+        aliases: [ aws_region, ec2_region ]
+'''
diff --git a/ansible_collections/amazon/aws/plugins/doc_fragments/tags.py b/ansible_collections/amazon/aws/plugins/doc_fragments/tags.py
new file mode 100644
index 00000000..9d381cb8
--- /dev/null
+++ b/ansible_collections/amazon/aws/plugins/doc_fragments/tags.py
@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022,  Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Standard Tagging related parameters
+    DOCUMENTATION = r'''
+options:
+  tags:
+    description:
+      - A dictionary representing the tags to be applied to the resource.
+      - If the I(tags) parameter is not set then tags will not be modified.
+    type: dict
+    required: false
+    aliases: ['resource_tags']
+  purge_tags:
+    description:
+      - If I(purge_tags=true) and I(tags) is set, existing tags will be purged
+        from the resource to match exactly what is defined by I(tags) parameter.
+      - If the I(tags) parameter is not set then tags will not be modified, even
+        if I(purge_tags=True).
+      - Tag keys beginning with C(aws:) are reserved by Amazon and can not be
+        modified.  As such they will be ignored for the purposes of the
+        I(purge_tags) parameter.  See the Amazon documentation for more information
+        U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions).
+    type: bool
+    default: true
+    required: false
+'''
+
+    # Some modules had a default of purge_tags=False, this was generally
+    # deprecated in release 4.0.0
+    DEPRECATED_PURGE = r'''
+options:
+  tags:
+    description:
+      - A dictionary representing the tags to be applied to the resource.
+      - If the I(tags) parameter is not set then tags will not be modified.
+    type: dict
+    required: false
+    aliases: ['resource_tags']
+  purge_tags:
+    description:
+      - If I(purge_tags=true) and I(tags) is set, existing tags will be purged
+        from the resource to match exactly what is defined by I(tags) parameter.
+      - If the I(tags) parameter is not set then tags will not be modified, even
+        if I(purge_tags=True).
+      - Tag keys beginning with C(aws:) are reserved by Amazon and can not be
+        modified.  As such they will be ignored for the purposes of the
+        I(purge_tags) parameter.  See the Amazon documentation for more information
+        U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions).
+      - The current default value of C(False) has been deprecated.  The default
+        value will change to C(True) in release 5.0.0.
+    type: bool
+    required: false
+'''