diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 5be40e94986..d16cf927037 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,24 @@ community.aws Release Notes .. contents:: Topics +v1.2.0 +====== + +Minor Changes +------------- + +- Add retries for aws_api_gateway when AWS throws `TooManyRequestsException` +- Migrate the remaning boto3 based modules to the module based helpers for creating AWS connections. + +Bugfixes +-------- + +- aws_codecommit - fixes issue where module execution would fail if an existing repository has empty description (https://github.com/ansible-collections/community.aws/pull/195) +- aws_kms_info - fixes issue where module execution fails because certain AWS KMS keys (e.g. aws/acm) do not permit the calling the API kms:GetKeyRotationStatus (example - https://forums.aws.amazon.com/thread.jspa?threadID=312992) (https://github.com/ansible-collections/community.aws/pull/199) +- ec2_instance - Fix a bug where tags were updated in check_mode. +- ec2_instance - fixes issue where security groups were not changed if the instance already existed. https://github.com/ansible-collections/community.aws/pull/22 +- iam - Fix false positive warning regarding use of ``no_log`` on ``update_password`` + v1.1.0 ====== @@ -19,14 +37,14 @@ Deprecated Features - data_pipeline - the ``version`` option has been deprecated and will be removed in a later release. It has always been ignored by the module. - ec2_eip - the ``wait_timeout`` option has been deprecated and will be removed in a later release. It has had no effect since Ansible 2.3. -- ec2_lc - the ``associate_public_ip_address`` option has been deprecated and will be removed in a later release. It has always been ignored by the module. +- ec2_lc - the ``associate_public_ip_address`` option has been deprecated and will be removed after a later release. It has always been ignored by the module. - elb_network_lb - in a later release, the default behaviour for the ``state`` option will change from ``absent`` to ``present``. To maintain the existing behavior explicitly set state to ``absent``. -- iam_managed_policy - the ``fail_on_delete`` option has been deprecated and will be removed in a later release. It has always been ignored by the module. +- iam_managed_policy - the ``fail_on_delete`` option has been deprecated and will be removed after a later release. It has always been ignored by the module. - iam_policy - in a later release, the default value for the ``skip_duplicates`` option will change from ``true`` to ``false``. To maintain the existing behavior explicitly set it to ``true``. -- iam_policy - the ``policy_document`` option has been deprecated and will be removed in a later release. To maintain the existing behavior use the ``policy_json`` option and read the file with the ``lookup`` plugin. +- iam_policy - the ``policy_document`` option has been deprecated and will be removed after a later release. To maintain the existing behavior use the ``policy_json`` option and read the file with the ``lookup`` plugin. - iam_role - in a later release, the ``purge_policies`` option (also know as ``purge_policy``) default value will change from ``true`` to ``false`` -- s3_lifecycle - the ``requester_pays`` option has been deprecated and will be removed in a later release. It has always been ignored by the module. -- s3_sync - the ``retries`` option has been deprecated and will be removed in a later release. It has always been ignored by the module. +- s3_lifecycle - the ``requester_pays`` option has been deprecated and will be removed after a later release. It has always been ignored by the module. +- s3_sync - the ``retries`` option has been deprecated and will be removed after 2022-06-01. It has always been ignored by the module. v1.0.0 ====== @@ -39,10 +57,10 @@ Minor Changes - aws_acm - Update automatic retries to stabilize the integration tests. - aws_codecommit - Support updating the description - aws_kms - Adds the ``enable_key_rotation`` option to enable or disable automatically key rotation. -- aws_kms: code refactor, some error messages updated +- aws_kms - code refactor, some error messages updated - aws_kms_info - Adds the ``enable_key_rotation`` info to the return value. -- ec2_asg - Add the ability to use mixed_instance_policy in launch template driven autoscaling groups - ec2_asg - Add support for Max Instance Lifetime +- ec2_asg - Add the ability to use mixed_instance_policy in launch template driven autoscaling groups - ec2_asg - Migrated to AnsibleAWSModule - ec2_placement_group - make ``name`` a required field. - ecs_task_definition - Add network_mode=default to support Windows ECS tasks. @@ -74,7 +92,7 @@ Deprecated Features - ec2_key - The ``wait_timeout`` option had no effect and will be removed after 2022-06-01 - ec2_key - The ``wait`` option had no effect and will be removed after 2022-06-01 - ec2_lc - The ``associate_public_ip_address`` option had no effect and will be removed after 2022-06-01 -- elb_network_lb: The current default value of the ``state`` option has been deprecated and will change from absent to present after 2022-06-01 +- elb_network_lb - The current default value of the ``state`` option has been deprecated and will change from absent to present after 2022-06-01 - iam_managed_policy - The ``fail_on_delete`` option had no effect and will be removed after 2022-06-01 - iam_policy - The ``policy_document`` will be removed after 2022-06-01. To maintain the existing behavior use the ``policy_json`` option and read the file with the ``lookup`` plugin. - iam_policy - The default value of ``skip_duplicates`` will change after 2022-06-01 from ``true`` to ``false``. @@ -96,7 +114,7 @@ Bugfixes - cloudfront_distribution - Always add field_level_encryption_id to cache behaviour to match AWS requirements - 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) - cloudwatchlogs_log_group_info - remove limitation of max 50 results -- ec2_asg: Ensure "wait" is honored during replace operations +- ec2_asg - Ensure "wait" is honored during replace operations - ec2_launch_template - Update output to include latest_version and default_version, matching the documentation - ec2_transit_gateway - Use AWSRetry before ClientError is handled when describing transit gateways - ec2_transit_gateway - fixed issue where auto_attach set to yes was not being honored (https://github.com/ansible/ansible/issues/61907) diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 0494c2b8cef..b1e25c93aa4 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -77,11 +77,11 @@ releases: - aws_codecommit - Support updating the description - aws_kms - Adds the ``enable_key_rotation`` option to enable or disable automatically key rotation. - - aws_kms - code refactor, some error messages updated' + - aws_kms - code refactor, some error messages updated - aws_kms_info - Adds the ``enable_key_rotation`` info to the return value. + - ec2_asg - Add support for Max Instance Lifetime - ec2_asg - Add the ability to use mixed_instance_policy in launch template driven autoscaling groups - - ec2_asg - Add support for Max Instance Lifetime - ec2_asg - Migrated to AnsibleAWSModule - ec2_placement_group - make ``name`` a required field. - ecs_task_definition - Add network_mode=default to support Windows ECS tasks. @@ -683,7 +683,8 @@ releases: option will change from ``absent`` to ``present``. To maintain the existing behavior explicitly set state to ``absent``. - iam_managed_policy - the ``fail_on_delete`` option has been deprecated and - will be removed after a later release. It has always been ignored by the module. + will be removed after a later release. It has always been ignored by the + module. - iam_policy - in a later release, the default value for the ``skip_duplicates`` option will change from ``true`` to ``false``. To maintain the existing behavior explicitly set it to ``true``. @@ -704,3 +705,28 @@ releases: - porting-guide.yml - sanity_fix_future_boilerplate.yml release_date: '2020-08-13' + 1.2.0: + changes: + bugfixes: + - aws_codecommit - fixes issue where module execution would fail if an existing + repository has empty description (https://github.com/ansible-collections/community.aws/pull/195) + - aws_kms_info - fixes issue where module execution fails because certain AWS + KMS keys (e.g. aws/acm) do not permit the calling the API kms:GetKeyRotationStatus + (example - https://forums.aws.amazon.com/thread.jspa?threadID=312992) (https://github.com/ansible-collections/community.aws/pull/199) + - ec2_instance - Fix a bug where tags were updated in check_mode. + - ec2_instance - fixes issue where security groups were not changed if the instance + already existed. https://github.com/ansible-collections/community.aws/pull/22 + - iam - Fix false positive warning regarding use of ``no_log`` on ``update_password`` + minor_changes: + - Add retries for aws_api_gateway when AWS throws `TooManyRequestsException` + - Migrate the remaning boto3 based modules to the module based helpers for creating + AWS connections. + fragments: + - 161-retries.yml + - 188-boto3_conn.yml + - 189-ec2_instance-check_mode-tags.yml + - 195-aws_codecommit-empty-description.yaml + - 199-aws_kms_info-key-rotation-status.yaml + - 22-ec2_instance-mod-sgs.yml + - iam_no_log.yml + release_date: '2020-08-28' diff --git a/changelogs/fragments/161-retries.yml b/changelogs/fragments/161-retries.yml deleted file mode 100644 index c6d257f0b7e..00000000000 --- a/changelogs/fragments/161-retries.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- Add retries for aws_api_gateway when AWS throws `TooManyRequestsException` diff --git a/changelogs/fragments/188-boto3_conn.yml b/changelogs/fragments/188-boto3_conn.yml deleted file mode 100644 index 6572d78a728..00000000000 --- a/changelogs/fragments/188-boto3_conn.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- Migrate the remaning boto3 based modules to the module based helpers for creating AWS connections. diff --git a/changelogs/fragments/189-ec2_instance-check_mode-tags.yml b/changelogs/fragments/189-ec2_instance-check_mode-tags.yml deleted file mode 100644 index fd215f64e16..00000000000 --- a/changelogs/fragments/189-ec2_instance-check_mode-tags.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_instance - Fix a bug where tags were updated in check_mode. diff --git a/changelogs/fragments/195-aws_codecommit-empty-description.yaml b/changelogs/fragments/195-aws_codecommit-empty-description.yaml deleted file mode 100644 index 2ab88e6bc7a..00000000000 --- a/changelogs/fragments/195-aws_codecommit-empty-description.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- aws_codecommit - fixes issue where module execution would fail if an existing repository has empty description (https://github.com/ansible-collections/community.aws/pull/195) diff --git a/changelogs/fragments/199-aws_kms_info-key-rotation-status.yaml b/changelogs/fragments/199-aws_kms_info-key-rotation-status.yaml deleted file mode 100644 index be3f33c23d8..00000000000 --- a/changelogs/fragments/199-aws_kms_info-key-rotation-status.yaml +++ /dev/null @@ -1,5 +0,0 @@ -bugfixes: -- aws_kms_info - fixes issue where module execution fails because certain AWS KMS keys (e.g. aws/acm) - do not permit the calling the API kms:GetKeyRotationStatus - (example - https://forums.aws.amazon.com/thread.jspa?threadID=312992) - (https://github.com/ansible-collections/community.aws/pull/199) diff --git a/changelogs/fragments/22-ec2_instance-mod-sgs.yml b/changelogs/fragments/22-ec2_instance-mod-sgs.yml deleted file mode 100644 index c8145d6624c..00000000000 --- a/changelogs/fragments/22-ec2_instance-mod-sgs.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_instance - fixes issue where security groups were not changed if the instance already existed. https://github.com/ansible-collections/community.aws/pull/22 diff --git a/changelogs/fragments/iam_no_log.yml b/changelogs/fragments/iam_no_log.yml deleted file mode 100644 index 12aaf5b186b..00000000000 --- a/changelogs/fragments/iam_no_log.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - iam - Fix false positive warning regarding use of ``no_log`` on ``update_password`` diff --git a/docs/community.aws.aws_acm_info_module.rst b/docs/community.aws.aws_acm_info_module.rst index 74b7b666a8e..01527f459d0 100644 --- a/docs/community.aws.aws_acm_info_module.rst +++ b/docs/community.aws.aws_acm_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -191,6 +195,8 @@ Parameters @@ -223,6 +229,8 @@ Parameters @@ -233,7 +241,8 @@ Parameters
list - / elements=string
+ / elements=string +
Parameter Choices/Defaults Comments
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
Uses a boto profile. Only works with boto >= 2.24.0.
+
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
+
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
    Choices: @@ -292,7 +301,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -509,7 +518,8 @@ Common return values are documented `here
    list - / elements=string
    + / elements=string +
always @@ -565,7 +575,8 @@ Common return values are documented `here
list - / elements=string
+ / elements=string + 		always @@ -746,7 +757,8 @@ Common return values are documented `here
list - / elements=string
+ / elements=string + 		always @@ -913,7 +925,8 @@ Common return values are documented `here
list - / elements=string
+ / elements=string + 		always diff --git a/docs/community.aws.aws_acm_module.rst b/docs/community.aws.aws_acm_module.rst index 40b9be63f00..5a0ac96dc79 100644 --- a/docs/community.aws.aws_acm_module.rst +++ b/docs/community.aws.aws_acm_module.rst @@ -52,7 +52,7 @@ Parameters .. raw:: html - + @@ -70,6 +70,8 @@ Parameters @@ -120,6 +122,8 @@ Parameters @@ -282,6 +286,8 @@ Parameters @@ -314,6 +320,8 @@ Parameters @@ -364,7 +372,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -435,7 +443,8 @@ Common return values are documented `here
list - / elements=string
+ / elements=string +
Parameter Choices/Defaults Comments
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
Uses a boto profile. Only works with boto >= 2.24.0.
+
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
+
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
when state=absent diff --git a/docs/community.aws.aws_api_gateway_module.rst b/docs/community.aws.aws_api_gateway_module.rst index 7b3da60f236..c8b19465013 100644 --- a/docs/community.aws.aws_api_gateway_module.rst +++ b/docs/community.aws.aws_api_gateway_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html - + @@ -72,6 +72,8 @@ Parameters @@ -122,6 +124,8 @@ Parameters @@ -255,6 +259,8 @@ Parameters @@ -287,6 +293,8 @@ Parameters @@ -454,7 +462,7 @@ Notes .. note:: - A future version of this module will probably use tags or another ID so that an API can be create only once. - As an early work around an intermediate version will probably do the same using a tag embedded in the API name. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_application_scaling_policy_module.rst b/docs/community.aws.aws_application_scaling_policy_module.rst index 566b546f187..8fc9b7307b2 100644 --- a/docs/community.aws.aws_application_scaling_policy_module.rst +++ b/docs/community.aws.aws_application_scaling_policy_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
Parameter Choices/Defaults Comments
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
Uses a boto profile. Only works with boto >= 2.24.0.
+
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
+
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
- + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -200,7 +204,8 @@ Parameters
string - / required
+ / required + @@ -215,7 +220,8 @@ Parameters
string - / required
+ / required + @@ -266,7 +274,8 @@ Parameters
string - / required
+ / required + @@ -281,7 +290,8 @@ Parameters
string - / required
+ / required + @@ -322,7 +334,8 @@ Parameters
string - / required
+ / required +
Parameter Choices/Defaults Comments
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
    Choices: @@ -240,6 +246,8 @@ Parameters
Uses a boto profile. Only works with boto >= 2.24.0.
+
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
+
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
    Choices: @@ -312,6 +322,8 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
    Choices: @@ -344,7 +357,8 @@ Parameters
    string - / required
    + / required +
    Choices: @@ -517,7 +531,7 @@ Notes .. note:: - for details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/application-autoscaling.html#ApplicationAutoScaling.Client.put_scaling_policy - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -882,7 +896,8 @@ Common return values are documented `here
    list - / elements=dictionary
    + / elements=dictionary +
when state present and the policy type is StepScaling diff --git a/docs/community.aws.aws_batch_compute_environment_module.rst b/docs/community.aws.aws_batch_compute_environment_module.rst index d270d6a5d6b..b280808e998 100644 --- a/docs/community.aws.aws_batch_compute_environment_module.rst +++ b/docs/community.aws.aws_batch_compute_environment_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -132,7 +136,8 @@ Parameters
string - / required
+ / required + @@ -168,7 +173,8 @@ Parameters
string - / required
+ / required + @@ -282,7 +289,9 @@ Parameters
list - / elements=string / required
+ / elements=string + / required + @@ -297,7 +306,8 @@ Parameters
integer - / required
+ / required + @@ -312,7 +322,8 @@ Parameters
integer - / required
+ / required + @@ -333,6 +344,8 @@ Parameters @@ -359,7 +372,9 @@ Parameters
list - / elements=string / required
+ / elements=string + / required + @@ -380,6 +395,8 @@ Parameters @@ -390,7 +407,8 @@ Parameters
string - / required
+ / required + @@ -439,7 +457,9 @@ Parameters
list - / elements=string / required
+ / elements=string + / required + @@ -469,7 +489,8 @@ Parameters
string - / required
+ / required +
Parameter Choices/Defaults Comments
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
    Choices: @@ -267,7 +273,8 @@ Parameters
    string - / required
    + / required +
Uses a boto profile. Only works with boto >= 2.24.0.
+
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
+
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
    Choices: @@ -508,7 +529,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_batch_job_definition_module.rst b/docs/community.aws.aws_batch_job_definition_module.rst index e41b3ad6bc6..4e151ca1de1 100644 --- a/docs/community.aws.aws_batch_job_definition_module.rst +++ b/docs/community.aws.aws_batch_job_definition_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -71,6 +71,8 @@ Parameters @@ -121,6 +123,8 @@ Parameters @@ -131,7 +135,8 @@ Parameters
    list - / elements=string
    + / elements=string + @@ -181,7 +186,8 @@ Parameters
    list - / elements=dictionary
    + / elements=dictionary + @@ -229,7 +235,8 @@ Parameters
    string - / required
    + / required + @@ -259,7 +266,8 @@ Parameters
    string - / required
    + / required + @@ -289,7 +297,8 @@ Parameters
    integer - / required
    + / required + @@ -304,7 +313,8 @@ Parameters
    list - / elements=dictionary
    + / elements=dictionary + @@ -404,6 +414,8 @@ Parameters @@ -451,6 +463,8 @@ Parameters @@ -480,7 +494,8 @@ Parameters
    string - / required
    + / required + @@ -495,7 +510,8 @@ Parameters
    list - / elements=dictionary
    + / elements=dictionary + @@ -593,7 +609,8 @@ Parameters
    integer - / required
    + / required + @@ -608,7 +625,8 @@ Parameters
    list - / elements=dictionary
    + / elements=dictionary + @@ -657,7 +675,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_batch_job_queue_module.rst b/docs/community.aws.aws_batch_job_queue_module.rst index 108aec0d249..700a240b99c 100644 --- a/docs/community.aws.aws_batch_job_queue_module.rst +++ b/docs/community.aws.aws_batch_job_queue_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
    Parameter Choices/Defaults Comments
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_access_key, access_key
    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_secret_key, secret_key
    Uses a boto profile. Only works with boto >= 2.24.0.
    +
    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
    +
    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

    aliases: aws_profile
    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: aws_security_token, access_token
    - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -116,7 +120,9 @@ Parameters
    list - / elements=dictionary / required
    + / elements=dictionary + / required + @@ -199,7 +205,8 @@ Parameters
    string - / required
    + / required + @@ -233,7 +240,8 @@ Parameters
    integer - / required
    + / required + @@ -254,6 +262,8 @@ Parameters @@ -286,6 +296,8 @@ Parameters @@ -335,7 +347,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_codebuild_module.rst b/docs/community.aws.aws_codebuild_module.rst index fe5872f9bbe..113984f2af1 100644 --- a/docs/community.aws.aws_codebuild_module.rst +++ b/docs/community.aws.aws_codebuild_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
    Parameter Choices/Defaults Comments
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_access_key, access_key
    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_secret_key, secret_key
    Uses a boto profile. Only works with boto >= 2.24.0.
    +
    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
    +
    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

    aliases: aws_profile
    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: aws_security_token, access_token
    - + @@ -49,7 +49,8 @@ Parameters
    dictionary - / required
    + / required + @@ -148,7 +149,8 @@ Parameters
    - - / required
    + / required + @@ -170,6 +172,8 @@ Parameters @@ -220,6 +224,8 @@ Parameters @@ -246,7 +252,8 @@ Parameters
    - - / required
    + / required + @@ -262,7 +269,8 @@ Parameters
    - - / required
    + / required + @@ -359,7 +367,8 @@ Parameters
    - - / required
    + / required + @@ -393,7 +402,8 @@ Parameters
    - - / required
    + / required + @@ -425,7 +435,8 @@ Parameters
    - - / required
    + / required + @@ -441,7 +452,8 @@ Parameters
    string - / required
    + / required + @@ -462,6 +474,8 @@ Parameters @@ -494,6 +508,8 @@ Parameters @@ -519,7 +535,8 @@ Parameters
    dictionary - / required
    + / required + @@ -603,7 +620,8 @@ Parameters
    string - / required
    + / required + @@ -638,7 +656,8 @@ Parameters
    list - / elements=dictionary
    + / elements=dictionary + @@ -738,7 +757,7 @@ Notes .. note:: - For details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_codecommit_module.rst b/docs/community.aws.aws_codecommit_module.rst index ac3d996b448..c99a8d6d4fd 100644 --- a/docs/community.aws.aws_codecommit_module.rst +++ b/docs/community.aws.aws_codecommit_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
    Parameter Choices/Defaults Comments
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_access_key, access_key
    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_secret_key, secret_key
    Uses a boto profile. Only works with boto >= 2.24.0.
    +
    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
    +
    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

    aliases: aws_profile
    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: aws_security_token, access_token
    - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -167,7 +171,8 @@ Parameters
    string - / required
    + / required + @@ -188,6 +193,8 @@ Parameters @@ -220,6 +227,8 @@ Parameters @@ -230,7 +239,8 @@ Parameters
    string - / required
    + / required +
    Parameter Choices/Defaults Comments
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_access_key, access_key
    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: ec2_secret_key, secret_key
    Uses a boto profile. Only works with boto >= 2.24.0.
    +
    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
    +
    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

    aliases: aws_profile
    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

    aliases: aws_security_token, access_token
      Choices: @@ -269,7 +279,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_codepipeline_module.rst b/docs/community.aws.aws_codepipeline_module.rst index d9a93479a0e..807b7d38626 100644 --- a/docs/community.aws.aws_codepipeline_module.rst +++ b/docs/community.aws.aws_codepipeline_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -49,7 +49,8 @@ Parameters
      dictionary - / required
      + / required + @@ -103,6 +104,8 @@ Parameters @@ -153,6 +156,8 @@ Parameters @@ -198,7 +203,8 @@ Parameters
      string - / required
      + / required + @@ -219,6 +225,8 @@ Parameters @@ -245,7 +253,8 @@ Parameters
      string - / required
      + / required + @@ -266,6 +275,8 @@ Parameters @@ -276,7 +287,9 @@ Parameters
      list - / elements=dictionary / required
      + / elements=dictionary + / required + @@ -292,7 +305,8 @@ Parameters
      list - / elements=dictionary
      + / elements=dictionary + @@ -381,7 +395,7 @@ Notes .. note:: - for details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/codepipeline.html - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_config_aggregation_authorization_module.rst b/docs/community.aws.aws_config_aggregation_authorization_module.rst index 4e91d76e0ec..e864f003df8 100644 --- a/docs/community.aws.aws_config_aggregation_authorization_module.rst +++ b/docs/community.aws.aws_config_aggregation_authorization_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
      - + @@ -49,7 +49,8 @@ Parameters
      string - / required
      + / required + @@ -64,7 +65,8 @@ Parameters
      string - / required
      + / required + @@ -85,6 +87,8 @@ Parameters @@ -135,6 +139,8 @@ Parameters @@ -186,6 +192,8 @@ Parameters @@ -218,6 +226,8 @@ Parameters @@ -267,7 +277,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_config_aggregator_module.rst b/docs/community.aws.aws_config_aggregator_module.rst index 5f2bd66cc21..129f99b2ed7 100644 --- a/docs/community.aws.aws_config_aggregator_module.rst +++ b/docs/community.aws.aws_config_aggregator_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
      - + @@ -49,7 +49,9 @@ Parameters
      list - / elements=dictionary / required
      + / elements=dictionary + / required + @@ -65,7 +67,8 @@ Parameters
      list - / elements=string
      + / elements=string + @@ -101,7 +104,8 @@ Parameters
      list - / elements=string
      + / elements=string + @@ -123,6 +127,8 @@ Parameters @@ -173,6 +179,8 @@ Parameters @@ -218,7 +226,8 @@ Parameters
      string - / required
      + / required + @@ -233,7 +242,8 @@ Parameters
      dictionary - / required
      + / required + @@ -269,7 +279,8 @@ Parameters
      list - / elements=string
      + / elements=string + @@ -307,6 +318,8 @@ Parameters @@ -339,6 +352,8 @@ Parameters @@ -388,7 +403,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_config_delivery_channel_module.rst b/docs/community.aws.aws_config_delivery_channel_module.rst index 8adc38fe662..9b4ecccb2db 100644 --- a/docs/community.aws.aws_config_delivery_channel_module.rst +++ b/docs/community.aws.aws_config_delivery_channel_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -172,7 +176,8 @@ Parameters
      string - / required
      + / required + @@ -193,6 +198,8 @@ Parameters @@ -219,7 +226,8 @@ Parameters
      string - / required
      + / required + @@ -255,6 +263,8 @@ Parameters @@ -319,7 +329,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_config_recorder_module.rst b/docs/community.aws.aws_config_recorder_module.rst index 00e5dd1864c..88e2a320de5 100644 --- a/docs/community.aws.aws_config_recorder_module.rst +++ b/docs/community.aws.aws_config_recorder_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
      string - / required
      + / required + @@ -171,6 +176,8 @@ Parameters @@ -290,6 +297,8 @@ Parameters @@ -339,7 +348,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_config_rule_module.rst b/docs/community.aws.aws_config_rule_module.rst index 5ca9cbd3490..68a63f10445 100644 --- a/docs/community.aws.aws_config_rule_module.rst +++ b/docs/community.aws.aws_config_rule_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -202,7 +206,8 @@ Parameters
      string - / required
      + / required + @@ -223,6 +228,8 @@ Parameters @@ -335,6 +342,8 @@ Parameters @@ -345,7 +354,8 @@ Parameters
      dictionary - / required
      + / required + @@ -452,7 +462,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_direct_connect_confirm_connection_module.rst b/docs/community.aws.aws_direct_connect_confirm_connection_module.rst index a2d4ec8e631..6b7cbd7617e 100644 --- a/docs/community.aws.aws_direct_connect_confirm_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_confirm_connection_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
      - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -189,6 +193,8 @@ Parameters @@ -221,6 +227,8 @@ Parameters @@ -251,7 +259,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_direct_connect_connection_module.rst b/docs/community.aws.aws_direct_connect_connection_module.rst index 87858e73181..b5144c71813 100644 --- a/docs/community.aws.aws_direct_connect_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_connection_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -260,6 +264,8 @@ Parameters @@ -292,6 +298,8 @@ Parameters @@ -302,7 +310,8 @@ Parameters
      string - / required
      + / required +
      Parameter Choices/Defaults Comments
      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_access_key, access_key
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: ec2_secret_key, secret_key
      Uses a boto profile. Only works with boto >= 2.24.0.
      +
      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
      +
      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

      aliases: aws_profile
      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
      +
      If profile is set this parameter is ignored.
      +
      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

      aliases: aws_security_token, access_token
        Choices: @@ -341,7 +350,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_direct_connect_gateway_module.rst b/docs/community.aws.aws_direct_connect_gateway_module.rst index 838fa801f73..fb8c2dc052b 100644 --- a/docs/community.aws.aws_direct_connect_gateway_module.rst +++ b/docs/community.aws.aws_direct_connect_gateway_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html - + @@ -73,6 +73,8 @@ Parameters @@ -123,6 +125,8 @@ Parameters @@ -205,6 +209,8 @@ Parameters @@ -237,6 +243,8 @@ Parameters @@ -318,7 +326,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst b/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst index 13b327e3191..3ccba0b5fc9 100644 --- a/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst +++ b/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
        Parameter Choices/Defaults Comments
        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
        +
        If profile is set this parameter is ignored.
        +
        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

        aliases: ec2_access_key, access_key
        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
        +
        If profile is set this parameter is ignored.
        +
        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

        aliases: ec2_secret_key, secret_key
        Uses a boto profile. Only works with boto >= 2.24.0.
        +
        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
        +
        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

        aliases: aws_profile
        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
        +
        If profile is set this parameter is ignored.
        +
        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

        aliases: aws_security_token, access_token
        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -299,6 +303,8 @@ Parameters @@ -331,6 +337,8 @@ Parameters @@ -341,7 +349,8 @@ Parameters
        string - / required
        + / required +
        Parameter Choices/Defaults Comments
        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
        +
        If profile is set this parameter is ignored.
        +
        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

        aliases: ec2_access_key, access_key
        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
        +
        If profile is set this parameter is ignored.
        +
        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

        aliases: ec2_secret_key, secret_key
        Uses a boto profile. Only works with boto >= 2.24.0.
        +
        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
        +
        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

        aliases: aws_profile
        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
        +
        If profile is set this parameter is ignored.
        +
        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

        aliases: aws_security_token, access_token
          Choices: @@ -417,7 +426,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_direct_connect_virtual_interface_module.rst b/docs/community.aws.aws_direct_connect_virtual_interface_module.rst index 18d055c93a0..01cda9b0587 100644 --- a/docs/community.aws.aws_direct_connect_virtual_interface_module.rst +++ b/docs/community.aws.aws_direct_connect_virtual_interface_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -100,6 +100,8 @@ Parameters @@ -150,6 +152,8 @@ Parameters @@ -176,7 +180,8 @@ Parameters
          list - / elements=string
          + / elements=string + @@ -257,7 +262,8 @@ Parameters
          string - / required
          + / required + @@ -294,6 +300,8 @@ Parameters @@ -345,6 +353,8 @@ Parameters @@ -355,7 +365,8 @@ Parameters
          string - / required
          + / required +
          Parameter Choices/Defaults Comments
          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
          +
          If profile is set this parameter is ignored.
          +
          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

          aliases: ec2_access_key, access_key
          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
          +
          If profile is set this parameter is ignored.
          +
          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

          aliases: ec2_secret_key, secret_key
          Uses a boto profile. Only works with boto >= 2.24.0.
          +
          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
          +
          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

          aliases: aws_profile
          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
          +
          If profile is set this parameter is ignored.
          +
          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

          aliases: aws_security_token, access_token
            Choices: @@ -441,7 +452,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_eks_cluster_module.rst b/docs/community.aws.aws_eks_cluster_module.rst index 3e55dd4097f..52a13fe9642 100644 --- a/docs/community.aws.aws_eks_cluster_module.rst +++ b/docs/community.aws.aws_eks_cluster_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
            string - / required
            + / required + @@ -171,6 +176,8 @@ Parameters @@ -212,7 +219,8 @@ Parameters
            list - / elements=string
            + / elements=string + @@ -233,6 +241,8 @@ Parameters @@ -262,7 +272,8 @@ Parameters
            list - / elements=string
            + / elements=string + @@ -347,7 +358,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_elasticbeanstalk_app_module.rst b/docs/community.aws.aws_elasticbeanstalk_app_module.rst index 7c50f8ac67f..1701e846825 100644 --- a/docs/community.aws.aws_elasticbeanstalk_app_module.rst +++ b/docs/community.aws.aws_elasticbeanstalk_app_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
            Parameter Choices/Defaults Comments
            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: ec2_access_key, access_key
            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: ec2_secret_key, secret_key
            Uses a boto profile. Only works with boto >= 2.24.0.
            +
            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
            +
            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

            aliases: aws_profile
            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: aws_security_token, access_token
            - + @@ -69,6 +69,8 @@ Parameters @@ -119,6 +121,8 @@ Parameters @@ -185,6 +189,8 @@ Parameters @@ -217,6 +223,8 @@ Parameters @@ -285,7 +293,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_glue_connection_module.rst b/docs/community.aws.aws_glue_connection_module.rst index 82645217a19..3980d4fdf83 100644 --- a/docs/community.aws.aws_glue_connection_module.rst +++ b/docs/community.aws.aws_glue_connection_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
            Parameter Choices/Defaults Comments
            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: ec2_access_key, access_key
            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: ec2_secret_key, secret_key
            Uses a boto profile. Only works with boto >= 2.24.0.
            +
            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
            +
            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

            aliases: aws_profile
            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: aws_security_token, access_token
            - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -214,7 +218,8 @@ Parameters
            list - / elements=string
            + / elements=string + @@ -229,7 +234,8 @@ Parameters
            string - / required
            + / required + @@ -250,6 +256,8 @@ Parameters @@ -276,7 +284,8 @@ Parameters
            list - / elements=string
            + / elements=string + @@ -297,6 +306,8 @@ Parameters @@ -307,7 +318,8 @@ Parameters
            string - / required
            + / required +
            Parameter Choices/Defaults Comments
            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: ec2_access_key, access_key
            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: ec2_secret_key, secret_key
            Uses a boto profile. Only works with boto >= 2.24.0.
            +
            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
            +
            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

            aliases: aws_profile
            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
            +
            If profile is set this parameter is ignored.
            +
            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

            aliases: aws_security_token, access_token
              Choices: @@ -361,7 +373,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_glue_job_module.rst b/docs/community.aws.aws_glue_job_module.rst index 1856b2389e9..56dd091dbcc 100644 --- a/docs/community.aws.aws_glue_job_module.rst +++ b/docs/community.aws.aws_glue_job_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html - + @@ -69,6 +69,8 @@ Parameters @@ -119,6 +121,8 @@ Parameters @@ -161,7 +165,8 @@ Parameters
              list - / elements=string
              + / elements=string + @@ -271,7 +276,8 @@ Parameters
              string - / required
              + / required + @@ -292,6 +298,8 @@ Parameters @@ -340,6 +348,8 @@ Parameters @@ -350,7 +360,8 @@ Parameters
              string - / required
              + / required +
              Parameter Choices/Defaults Comments
              AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
              +
              If profile is set this parameter is ignored.
              +
              Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

              aliases: ec2_access_key, access_key
              AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
              +
              If profile is set this parameter is ignored.
              +
              Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

              aliases: ec2_secret_key, secret_key
              Uses a boto profile. Only works with boto >= 2.24.0.
              +
              Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
              +
              aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

              aliases: aws_profile
              AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
              +
              If profile is set this parameter is ignored.
              +
              Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

              aliases: aws_security_token, access_token
                Choices: @@ -404,7 +415,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_inspector_target_module.rst b/docs/community.aws.aws_inspector_target_module.rst index 6c61e1fcf03..bb8e5cfb35b 100644 --- a/docs/community.aws.aws_inspector_target_module.rst +++ b/docs/community.aws.aws_inspector_target_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
                string - / required
                + / required + @@ -171,6 +176,8 @@ Parameters @@ -203,6 +210,8 @@ Parameters @@ -268,7 +277,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_kms_info_module.rst b/docs/community.aws.aws_kms_info_module.rst index 420b18fbb8d..d40ded1373d 100644 --- a/docs/community.aws.aws_kms_info_module.rst +++ b/docs/community.aws.aws_kms_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                Parameter Choices/Defaults Comments
                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_access_key, access_key
                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_secret_key, secret_key
                Uses a boto profile. Only works with boto >= 2.24.0.
                +
                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                +
                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                aliases: aws_profile
                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: aws_security_token, access_token
                - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -189,6 +193,8 @@ Parameters @@ -221,6 +227,8 @@ Parameters @@ -251,7 +259,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -390,7 +398,7 @@ Common return values are documented `here diff --git a/docs/community.aws.aws_kms_module.rst b/docs/community.aws.aws_kms_module.rst index 0e9ab4a7da5..f5372c760ab 100644 --- a/docs/community.aws.aws_kms_module.rst +++ b/docs/community.aws.aws_kms_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                Parameter Choices/Defaults Comments
                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_access_key, access_key
                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_secret_key, secret_key
                Uses a boto profile. Only works with boto >= 2.24.0.
                +
                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                +
                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                aliases: aws_profile
                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: aws_security_token, access_token
                always -
                Whether the automatically key rotation every year is enabled.
                +
                Whether the automatically key rotation every year is enabled. Returns None if key rotation status can't be determined.
                - + @@ -69,6 +69,8 @@ Parameters @@ -119,6 +121,8 @@ Parameters @@ -217,7 +221,8 @@ Parameters
                list - / elements=dictionary
                + / elements=dictionary + @@ -252,7 +257,8 @@ Parameters
                string - / required
                + / required + @@ -268,7 +274,8 @@ Parameters
                list - / elements=string
                + / elements=string + @@ -454,6 +462,8 @@ Parameters @@ -524,6 +534,8 @@ Parameters @@ -588,7 +600,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_region_info_module.rst b/docs/community.aws.aws_region_info_module.rst index cad84e911e2..344c84cc87f 100644 --- a/docs/community.aws.aws_region_info_module.rst +++ b/docs/community.aws.aws_region_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                Parameter Choices/Defaults Comments
                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_access_key, access_key
                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_secret_key, secret_key
                  Choices: @@ -369,7 +376,8 @@ Parameters
                  list - / elements=string
                  + / elements=string +
                Uses a boto profile. Only works with boto >= 2.24.0.
                +
                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                +
                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                aliases: aws_profile
                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: aws_security_token, access_token
                - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -178,6 +182,8 @@ Parameters @@ -210,6 +216,8 @@ Parameters @@ -240,7 +248,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_s3_bucket_info_module.rst b/docs/community.aws.aws_s3_bucket_info_module.rst index c0b8306aaa0..b76abae9775 100644 --- a/docs/community.aws.aws_s3_bucket_info_module.rst +++ b/docs/community.aws.aws_s3_bucket_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                Parameter Choices/Defaults Comments
                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_access_key, access_key
                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_secret_key, secret_key
                Uses a boto profile. Only works with boto >= 2.24.0.
                +
                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                +
                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                aliases: aws_profile
                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: aws_security_token, access_token
                - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -156,6 +160,8 @@ Parameters @@ -188,6 +194,8 @@ Parameters @@ -218,7 +226,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_s3_cors_module.rst b/docs/community.aws.aws_s3_cors_module.rst index bbbd16da1ca..7ba7f85729d 100644 --- a/docs/community.aws.aws_s3_cors_module.rst +++ b/docs/community.aws.aws_s3_cors_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                Parameter Choices/Defaults Comments
                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_access_key, access_key
                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_secret_key, secret_key
                Uses a boto profile. Only works with boto >= 2.24.0.
                +
                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                +
                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                aliases: aws_profile
                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: aws_security_token, access_token
                - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -148,7 +152,8 @@ Parameters
                string - / required
                + / required + @@ -169,6 +174,8 @@ Parameters @@ -195,7 +202,8 @@ Parameters
                list - / elements=string
                + / elements=string + @@ -216,6 +224,8 @@ Parameters @@ -226,7 +236,8 @@ Parameters
                string - / required
                + / required +
                Parameter Choices/Defaults Comments
                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_access_key, access_key
                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: ec2_secret_key, secret_key
                Uses a boto profile. Only works with boto >= 2.24.0.
                +
                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                +
                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                aliases: aws_profile
                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                +
                If profile is set this parameter is ignored.
                +
                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                aliases: aws_security_token, access_token
                  Choices: @@ -265,7 +276,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_secret_module.rst b/docs/community.aws.aws_secret_module.rst index b376dcf4c13..8505e4f1691 100644 --- a/docs/community.aws.aws_secret_module.rst +++ b/docs/community.aws.aws_secret_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -180,7 +184,8 @@ Parameters
                  string - / required
                  + / required + @@ -201,6 +206,8 @@ Parameters @@ -317,6 +324,8 @@ Parameters @@ -381,7 +390,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_ses_identity_module.rst b/docs/community.aws.aws_ses_identity_module.rst index 445b309d524..67a60de22aa 100644 --- a/docs/community.aws.aws_ses_identity_module.rst +++ b/docs/community.aws.aws_ses_identity_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -338,7 +342,8 @@ Parameters
                  string - / required
                  + / required + @@ -360,6 +365,8 @@ Parameters @@ -392,6 +399,8 @@ Parameters @@ -441,7 +450,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_ses_identity_policy_module.rst b/docs/community.aws.aws_ses_identity_policy_module.rst index 0404b1a3526..b3c9277026a 100644 --- a/docs/community.aws.aws_ses_identity_policy_module.rst +++ b/docs/community.aws.aws_ses_identity_policy_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -151,7 +155,8 @@ Parameters
                  string - / required
                  + / required + @@ -182,7 +187,8 @@ Parameters
                  string - / required
                  + / required + @@ -203,6 +209,8 @@ Parameters @@ -235,6 +243,8 @@ Parameters @@ -284,7 +294,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_ses_rule_set_module.rst b/docs/community.aws.aws_ses_rule_set_module.rst index ff95e898d93..7dc1b09cc2e 100644 --- a/docs/community.aws.aws_ses_rule_set_module.rst +++ b/docs/community.aws.aws_ses_rule_set_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + @@ -77,6 +77,8 @@ Parameters @@ -127,6 +129,8 @@ Parameters @@ -191,7 +195,8 @@ Parameters
                  string - / required
                  + / required + @@ -212,6 +217,8 @@ Parameters @@ -244,6 +251,8 @@ Parameters @@ -293,7 +302,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_sgw_info_module.rst b/docs/community.aws.aws_sgw_info_module.rst index 628f900e2cc..0e75bd134a2 100644 --- a/docs/community.aws.aws_sgw_info_module.rst +++ b/docs/community.aws.aws_sgw_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -232,6 +236,8 @@ Parameters @@ -264,6 +270,8 @@ Parameters @@ -294,7 +302,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_ssm_connection.rst b/docs/community.aws.aws_ssm_connection.rst index 83d87eef8ef..da3d5c515df 100644 --- a/docs/community.aws.aws_ssm_connection.rst +++ b/docs/community.aws.aws_ssm_connection.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + diff --git a/docs/community.aws.aws_ssm_parameter_store_module.rst b/docs/community.aws.aws_ssm_parameter_store_module.rst index 61ecc63feda..a0f653a9fe1 100644 --- a/docs/community.aws.aws_ssm_parameter_store_module.rst +++ b/docs/community.aws.aws_ssm_parameter_store_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Configuration
                  - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -201,7 +205,8 @@ Parameters
                  string - / required
                  + / required + @@ -242,6 +247,8 @@ Parameters @@ -274,6 +281,8 @@ Parameters @@ -359,7 +368,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_step_functions_state_machine_execution_module.rst b/docs/community.aws.aws_step_functions_state_machine_execution_module.rst index c739e85b155..e8bd554f809 100644 --- a/docs/community.aws.aws_step_functions_state_machine_execution_module.rst +++ b/docs/community.aws.aws_step_functions_state_machine_execution_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + @@ -72,6 +72,8 @@ Parameters @@ -122,6 +124,8 @@ Parameters @@ -251,6 +255,8 @@ Parameters @@ -283,6 +289,8 @@ Parameters @@ -328,7 +336,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_step_functions_state_machine_module.rst b/docs/community.aws.aws_step_functions_state_machine_module.rst index dff3042b9aa..f56bd56ad87 100644 --- a/docs/community.aws.aws_step_functions_state_machine_module.rst +++ b/docs/community.aws.aws_step_functions_state_machine_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -165,7 +169,8 @@ Parameters
                  string - / required
                  + / required + @@ -186,6 +191,8 @@ Parameters @@ -253,6 +260,8 @@ Parameters @@ -317,7 +326,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_waf_condition_module.rst b/docs/community.aws.aws_waf_condition_module.rst index 4fe42e72fd5..5c6fc396cdd 100644 --- a/docs/community.aws.aws_waf_condition_module.rst +++ b/docs/community.aws.aws_waf_condition_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                  - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -148,7 +152,8 @@ Parameters
                  list - / elements=dictionary
                  + / elements=dictionary + @@ -332,7 +337,8 @@ Parameters
                  list - / elements=string
                  + / elements=string + @@ -409,7 +415,8 @@ Parameters
                  string - / required
                  + / required + @@ -430,6 +437,8 @@ Parameters @@ -481,6 +490,8 @@ Parameters @@ -510,7 +521,8 @@ Parameters
                  string - / required
                  + / required +
                  Parameter Choices/Defaults Comments
                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_access_key, access_key
                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: ec2_secret_key, secret_key
                  Uses a boto profile. Only works with boto >= 2.24.0.
                  +
                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                  +
                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                  aliases: aws_profile
                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                  +
                  If profile is set this parameter is ignored.
                  +
                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                  aliases: aws_security_token, access_token
                    Choices: @@ -573,7 +585,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_waf_info_module.rst b/docs/community.aws.aws_waf_info_module.rst index 61c8b7ae285..ee5162922a9 100644 --- a/docs/community.aws.aws_waf_info_module.rst +++ b/docs/community.aws.aws_waf_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -171,6 +175,8 @@ Parameters @@ -203,6 +209,8 @@ Parameters @@ -252,7 +260,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_waf_rule_module.rst b/docs/community.aws.aws_waf_rule_module.rst index d90ed10f9c1..2d818d5aa82 100644 --- a/docs/community.aws.aws_waf_rule_module.rst +++ b/docs/community.aws.aws_waf_rule_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -113,7 +117,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -129,7 +134,8 @@ Parameters
                    string - / required
                    + / required + @@ -145,7 +151,8 @@ Parameters
                    boolean - / required
                    + / required + @@ -263,6 +272,8 @@ Parameters @@ -314,6 +325,8 @@ Parameters @@ -382,7 +395,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.aws_waf_web_acl_module.rst b/docs/community.aws.aws_waf_web_acl_module.rst index 0a6c11d9ef8..a4ebfac329b 100644 --- a/docs/community.aws.aws_waf_web_acl_module.rst +++ b/docs/community.aws.aws_waf_web_acl_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                      Choices: @@ -165,7 +172,8 @@ Parameters
                      string - / required
                      + / required +
                      Choices: @@ -242,7 +250,8 @@ Parameters
                      string - / required
                      + / required +
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -186,7 +190,8 @@ Parameters
                    string - / required
                    + / required + @@ -207,6 +212,8 @@ Parameters @@ -252,7 +259,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -268,7 +276,8 @@ Parameters
                    string - / required
                    + / required + @@ -284,7 +293,8 @@ Parameters
                    string - / required
                    + / required + @@ -300,7 +310,8 @@ Parameters
                    integer - / required
                    + / required + @@ -342,6 +353,8 @@ Parameters @@ -410,7 +423,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudformation_exports_info_module.rst b/docs/community.aws.cloudformation_exports_info_module.rst index da610f3d474..c98f1b87b50 100644 --- a/docs/community.aws.cloudformation_exports_info_module.rst +++ b/docs/community.aws.cloudformation_exports_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -155,6 +159,8 @@ Parameters @@ -187,6 +193,8 @@ Parameters @@ -217,7 +225,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudformation_stack_set_module.rst b/docs/community.aws.cloudformation_stack_set_module.rst index a7ba8a2aac1..0758f018607 100644 --- a/docs/community.aws.cloudformation_stack_set_module.rst +++ b/docs/community.aws.cloudformation_stack_set_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -49,7 +49,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -88,6 +89,8 @@ Parameters @@ -138,6 +141,8 @@ Parameters @@ -148,7 +153,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -362,6 +369,8 @@ Parameters @@ -408,7 +417,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -430,6 +440,8 @@ Parameters @@ -585,7 +597,7 @@ Notes .. note:: - To make an individual stack, you want the :ref:`amazon.aws.cloudformation ` module. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudfront_distribution_module.rst b/docs/community.aws.cloudfront_distribution_module.rst index 0f409f72045..4f70c08585e 100644 --- a/docs/community.aws.cloudfront_distribution_module.rst +++ b/docs/community.aws.cloudfront_distribution_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                      Choices: @@ -324,7 +330,8 @@ Parameters
                      string - / required
                      + / required +
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -63,7 +63,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -85,6 +86,8 @@ Parameters @@ -135,6 +138,8 @@ Parameters @@ -145,7 +150,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -197,7 +203,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -216,7 +223,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -292,7 +300,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -344,7 +353,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -362,7 +372,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -472,7 +483,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -550,7 +562,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -650,7 +663,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -802,7 +816,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -821,7 +836,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -897,7 +913,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -949,7 +966,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -967,7 +985,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -1077,7 +1096,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -1155,7 +1175,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -1447,7 +1468,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -1463,7 +1485,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -1617,7 +1640,8 @@ Parameters
                    list - / elements=string
                    + / elements=string + @@ -1731,6 +1755,8 @@ Parameters @@ -1931,6 +1957,8 @@ Parameters @@ -2153,7 +2181,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudfront_info_module.rst b/docs/community.aws.cloudfront_info_module.rst index 4e9509dd0c3..7074801fb1e 100644 --- a/docs/community.aws.cloudfront_info_module.rst +++ b/docs/community.aws.cloudfront_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -74,6 +74,8 @@ Parameters @@ -124,6 +126,8 @@ Parameters @@ -434,6 +438,8 @@ Parameters @@ -466,6 +472,8 @@ Parameters @@ -556,7 +564,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudfront_invalidation_module.rst b/docs/community.aws.cloudfront_invalidation_module.rst index 7c64f2e6d18..b1b02e912a9 100644 --- a/docs/community.aws.cloudfront_invalidation_module.rst +++ b/docs/community.aws.cloudfront_invalidation_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -69,6 +69,8 @@ Parameters @@ -119,6 +121,8 @@ Parameters @@ -202,6 +206,8 @@ Parameters @@ -234,6 +240,8 @@ Parameters @@ -244,7 +252,9 @@ Parameters
                    list - / elements=string / required
                    + / elements=string + / required + @@ -280,7 +290,7 @@ Notes .. note:: - does not support check mode - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudfront_origin_access_identity_module.rst b/docs/community.aws.cloudfront_origin_access_identity_module.rst index 33afee9fb02..289f3ec9c44 100644 --- a/docs/community.aws.cloudfront_origin_access_identity_module.rst +++ b/docs/community.aws.cloudfront_origin_access_identity_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -200,6 +204,8 @@ Parameters @@ -232,6 +238,8 @@ Parameters @@ -282,7 +290,7 @@ Notes .. note:: - Does not support check mode. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudtrail_module.rst b/docs/community.aws.cloudtrail_module.rst index de5f1f40b07..e7b031c8d9e 100644 --- a/docs/community.aws.cloudtrail_module.rst +++ b/docs/community.aws.cloudtrail_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -303,6 +307,8 @@ Parameters @@ -368,6 +374,8 @@ Parameters @@ -454,7 +462,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudwatchevent_rule_module.rst b/docs/community.aws.cloudwatchevent_rule_module.rst index 7c56bee0820..70f28a0ccaa 100644 --- a/docs/community.aws.cloudwatchevent_rule_module.rst +++ b/docs/community.aws.cloudwatchevent_rule_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -179,7 +183,8 @@ Parameters
                    string - / required
                    + / required + @@ -200,6 +205,8 @@ Parameters @@ -262,6 +269,8 @@ Parameters @@ -292,7 +301,8 @@ Parameters
                    list - / elements=dictionary
                    + / elements=dictionary + @@ -308,7 +318,8 @@ Parameters
                    string - / required
                    + / required + @@ -375,7 +386,8 @@ Parameters
                    string - / required
                    + / required + @@ -463,7 +475,7 @@ Notes .. note:: - A rule must contain at least an *event_pattern* or *schedule_expression*. A rule can have both an *event_pattern* and a *schedule_expression*, in which case the rule will trigger on matching events as well as on a schedule. - When specifying targets, *input* and *input_path* are mutually-exclusive and optional parameters. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst index d9bb44238d4..b63996742f1 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -172,6 +176,8 @@ Parameters @@ -204,6 +210,8 @@ Parameters @@ -234,7 +242,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst b/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst index c32f7470e6b..7c2bd4c35ee 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                    - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -151,7 +155,8 @@ Parameters
                    string - / required
                    + / required + @@ -181,7 +186,8 @@ Parameters
                    string - / required
                    + / required + @@ -282,6 +288,8 @@ Parameters @@ -314,6 +322,8 @@ Parameters @@ -324,7 +334,8 @@ Parameters
                    string - / required
                    + / required +
                    Parameter Choices/Defaults Comments
                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_access_key, access_key
                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: ec2_secret_key, secret_key
                    Uses a boto profile. Only works with boto >= 2.24.0.
                    +
                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                    +
                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                    aliases: aws_profile
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                    +
                    If profile is set this parameter is ignored.
                    +
                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                    aliases: aws_security_token, access_token
                      Choices: @@ -363,7 +374,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.cloudwatchlogs_log_group_module.rst b/docs/community.aws.cloudwatchlogs_log_group_module.rst index c00633fbf5b..ec0487c2247 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -166,7 +170,8 @@ Parameters
                      string - / required
                      + / required + @@ -207,6 +212,8 @@ Parameters @@ -276,6 +283,8 @@ Parameters @@ -341,7 +350,7 @@ Notes .. note:: - For details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/logs.html. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.data_pipeline_module.rst b/docs/community.aws.data_pipeline_module.rst index eb515b19242..cb76f528188 100644 --- a/docs/community.aws.data_pipeline_module.rst +++ b/docs/community.aws.data_pipeline_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -167,7 +171,8 @@ Parameters
                      string - / required
                      + / required + @@ -182,7 +187,8 @@ Parameters
                      list - / elements=dictionary
                      + / elements=dictionary + @@ -198,7 +204,8 @@ Parameters
                      list - / elements=dictionary
                      + / elements=dictionary + @@ -301,7 +308,8 @@ Parameters
                      list - / elements=dictionary
                      + / elements=dictionary + @@ -317,7 +325,8 @@ Parameters
                      list - / elements=dictionary
                      + / elements=dictionary + @@ -390,6 +399,8 @@ Parameters @@ -422,6 +433,8 @@ Parameters @@ -503,7 +516,8 @@ Parameters
                      list - / elements=dictionary
                      + / elements=dictionary + @@ -567,7 +581,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.dms_endpoint_module.rst b/docs/community.aws.dms_endpoint_module.rst index d7dad3d6be2..b60dcf6ec23 100644 --- a/docs/community.aws.dms_endpoint_module.rst +++ b/docs/community.aws.dms_endpoint_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -223,7 +227,8 @@ Parameters
                      string - / required
                      + / required + @@ -238,7 +243,8 @@ Parameters
                      string - / required
                      + / required + @@ -461,6 +470,8 @@ Parameters @@ -626,7 +637,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.dms_replication_subnet_group_module.rst b/docs/community.aws.dms_replication_subnet_group_module.rst index 426d49daf4b..3d5ede46d58 100644 --- a/docs/community.aws.dms_replication_subnet_group_module.rst +++ b/docs/community.aws.dms_replication_subnet_group_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                        Choices: @@ -257,7 +263,8 @@ Parameters
                        string - / required
                        + / required +
                        Choices: @@ -398,6 +405,8 @@ Parameters
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -132,7 +136,8 @@ Parameters
                      string - / required
                      + / required + @@ -163,7 +168,8 @@ Parameters
                      string - / required
                      + / required + @@ -184,6 +190,8 @@ Parameters @@ -216,6 +224,8 @@ Parameters @@ -245,7 +255,9 @@ Parameters
                      list - / elements=string / required
                      + / elements=string + / required + @@ -280,7 +292,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.dynamodb_table_module.rst b/docs/community.aws.dynamodb_table_module.rst index ed55ec8bf02..2830a0ad5d1 100644 --- a/docs/community.aws.dynamodb_table_module.rst +++ b/docs/community.aws.dynamodb_table_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -57,6 +57,8 @@ Parameters @@ -107,6 +109,8 @@ Parameters @@ -188,7 +192,8 @@ Parameters
                      list - / elements=dictionary
                      + / elements=dictionary + @@ -255,7 +261,8 @@ Parameters
                      string - / required
                      + / required + @@ -319,7 +326,8 @@ Parameters
                      string - / required
                      + / required + @@ -352,7 +360,8 @@ Parameters
                      string - / required
                      + / required + @@ -373,6 +382,8 @@ Parameters @@ -456,6 +467,8 @@ Parameters @@ -553,7 +566,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.dynamodb_ttl_module.rst b/docs/community.aws.dynamodb_ttl_module.rst index 18d3190e114..ad349c13c71 100644 --- a/docs/community.aws.dynamodb_ttl_module.rst +++ b/docs/community.aws.dynamodb_ttl_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Default:
                      []
                      @@ -207,7 +212,8 @@ Parameters
                      string - / required
                      + / required +
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -50,7 +50,8 @@ Parameters
                      string - / required
                      + / required + @@ -72,6 +73,8 @@ Parameters @@ -122,6 +125,8 @@ Parameters @@ -173,6 +178,8 @@ Parameters @@ -205,6 +212,8 @@ Parameters @@ -234,7 +243,8 @@ Parameters
                      string - / required
                      + / required + @@ -269,7 +279,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_ami_copy_module.rst b/docs/community.aws.ec2_ami_copy_module.rst index a0aeffd6970..552943b4c2b 100644 --- a/docs/community.aws.ec2_ami_copy_module.rst +++ b/docs/community.aws.ec2_ami_copy_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -220,6 +224,8 @@ Parameters @@ -252,6 +258,8 @@ Parameters @@ -262,7 +270,8 @@ Parameters
                      string - / required
                      + / required + @@ -277,7 +286,8 @@ Parameters
                      string - / required
                      + / required + @@ -382,7 +392,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_asg_info_module.rst b/docs/community.aws.ec2_asg_info_module.rst index a7c3dc2461e..425666502e3 100644 --- a/docs/community.aws.ec2_asg_info_module.rst +++ b/docs/community.aws.ec2_asg_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -172,6 +176,8 @@ Parameters @@ -204,6 +210,8 @@ Parameters @@ -249,7 +257,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst index c89630575a7..c00bb25e6bc 100644 --- a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst +++ b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -50,7 +50,8 @@ Parameters
                      string - / required
                      + / required + @@ -71,6 +72,8 @@ Parameters @@ -121,6 +124,8 @@ Parameters @@ -201,7 +206,8 @@ Parameters
                      string - / required
                      + / required + @@ -254,6 +260,8 @@ Parameters @@ -301,6 +309,8 @@ Parameters @@ -371,7 +381,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_asg_module.rst b/docs/community.aws.ec2_asg_module.rst index bbf66a874cf..194fe290b56 100644 --- a/docs/community.aws.ec2_asg_module.rst +++ b/docs/community.aws.ec2_asg_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -50,7 +50,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -72,6 +73,8 @@ Parameters @@ -122,6 +125,8 @@ Parameters @@ -333,7 +338,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -434,7 +440,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -499,7 +507,8 @@ Parameters
                      string - / required
                      + / required + @@ -529,7 +538,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -627,7 +639,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -648,6 +661,8 @@ Parameters @@ -677,7 +692,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -714,7 +731,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -729,7 +747,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -819,7 +839,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_customer_gateway_info_module.rst b/docs/community.aws.ec2_customer_gateway_info_module.rst index 893ead7e0b6..4263316fbd5 100644 --- a/docs/community.aws.ec2_customer_gateway_info_module.rst +++ b/docs/community.aws.ec2_customer_gateway_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Default:
                      ["GroupMinSize", "GroupMaxSize", "GroupDesiredCapacity", "GroupInServiceInstances", "GroupPendingInstances", "GroupStandbyInstances", "GroupTerminatingInstances", "GroupTotalInstances"]
                      @@ -483,7 +490,8 @@ Parameters
                      list - / elements=string
                      + / elements=string +                       		Default:
                      ["autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR"]
                      @@ -566,6 +576,8 @@ Parameters
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      Default:
                      []
                      @@ -697,7 +713,8 @@ Parameters
                      list - / elements=dictionary
                      + / elements=dictionary +                       		Default:
                      "Default"
                      @@ -768,7 +787,8 @@ Parameters
                      list - / elements=string
                      + / elements=string +
                      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -115,7 +119,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -186,6 +191,8 @@ Parameters @@ -218,6 +225,8 @@ Parameters @@ -248,7 +257,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_customer_gateway_module.rst b/docs/community.aws.ec2_customer_gateway_module.rst index 2abee19b453..c4ff5ff1c53 100644 --- a/docs/community.aws.ec2_customer_gateway_module.rst +++ b/docs/community.aws.ec2_customer_gateway_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -165,7 +169,8 @@ Parameters
                      string - / required
                      + / required + @@ -180,7 +185,8 @@ Parameters
                      string - / required
                      + / required + @@ -201,6 +207,8 @@ Parameters @@ -252,6 +260,8 @@ Parameters @@ -303,7 +313,7 @@ Notes .. note:: - You cannot create more than one customer gateway with the same IP address. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. - Return values contain customer_gateway and customer_gateways keys which are identical dicts. You should use customer_gateway. See https://github.com/ansible/ansible-modules-extras/issues/2773 for details. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_eip_info_module.rst b/docs/community.aws.ec2_eip_info_module.rst index 010e0f66a18..48ac479ecbc 100644 --- a/docs/community.aws.ec2_eip_info_module.rst +++ b/docs/community.aws.ec2_eip_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -171,6 +175,8 @@ Parameters @@ -203,6 +209,8 @@ Parameters @@ -233,7 +241,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_eip_module.rst b/docs/community.aws.ec2_eip_module.rst index e33ab8148a5..366ec5f2da1 100644 --- a/docs/community.aws.ec2_eip_module.rst +++ b/docs/community.aws.ec2_eip_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -73,6 +73,8 @@ Parameters @@ -123,6 +125,8 @@ Parameters @@ -225,6 +229,8 @@ Parameters @@ -328,6 +334,8 @@ Parameters @@ -425,7 +433,7 @@ Notes .. note:: - There may be a delay between the time the EIP is assigned and when the cloud instance is reachable via the new address. Use wait_for and pause to delay further playbook execution until the instance is reachable, if necessary. - This module returns multiple changed statuses on disassociation or release. It returns an overall status based on any changes occurring. It also returns individual changed statuses for disassociation and release. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_elb_info_module.rst b/docs/community.aws.ec2_elb_info_module.rst index 84a9c91fa27..f03e94fba5d 100644 --- a/docs/community.aws.ec2_elb_info_module.rst +++ b/docs/community.aws.ec2_elb_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -149,7 +153,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -170,6 +175,8 @@ Parameters @@ -202,6 +209,8 @@ Parameters @@ -232,7 +241,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_elb_module.rst b/docs/community.aws.ec2_elb_module.rst index bd7ab66cae7..f8c22d56048 100644 --- a/docs/community.aws.ec2_elb_module.rst +++ b/docs/community.aws.ec2_elb_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                      - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -134,7 +138,8 @@ Parameters
                      list - / elements=string
                      + / elements=string + @@ -185,7 +190,8 @@ Parameters
                      string - / required
                      + / required + @@ -206,6 +212,8 @@ Parameters @@ -238,6 +246,8 @@ Parameters @@ -248,7 +258,8 @@ Parameters
                      string - / required
                      + / required +
                      Parameter Choices/Defaults Comments
                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_access_key, access_key
                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: ec2_secret_key, secret_key
                      Uses a boto profile. Only works with boto >= 2.24.0.
                      +
                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                      +
                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                      aliases: aws_profile
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                      +
                      If profile is set this parameter is ignored.
                      +
                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                      aliases: aws_security_token, access_token
                        Choices: @@ -322,7 +333,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_instance_info_module.rst b/docs/community.aws.ec2_instance_info_module.rst index c39ff9731e9..d55e2c6d153 100644 --- a/docs/community.aws.ec2_instance_info_module.rst +++ b/docs/community.aws.ec2_instance_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -167,7 +171,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -188,6 +193,8 @@ Parameters @@ -220,6 +227,8 @@ Parameters @@ -250,7 +259,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -1007,7 +1016,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        always @@ -1065,7 +1075,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always @@ -1179,7 +1190,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always @@ -1501,7 +1513,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always @@ -1626,7 +1639,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always diff --git a/docs/community.aws.ec2_instance_module.rst b/docs/community.aws.ec2_instance_module.rst index 4232d031243..b65b17689ae 100644 --- a/docs/community.aws.ec2_instance_module.rst +++ b/docs/community.aws.ec2_instance_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html - + @@ -73,6 +73,8 @@ Parameters @@ -123,6 +125,8 @@ Parameters @@ -172,7 +176,8 @@ Parameters
                        integer - / required
                        + / required + @@ -188,7 +193,8 @@ Parameters
                        integer - / required
                        + / required + @@ -762,6 +769,8 @@ Parameters @@ -822,7 +831,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -843,6 +853,8 @@ Parameters @@ -1032,7 +1044,8 @@ Parameters
                        list - / elements=dictionary
                        + / elements=dictionary + @@ -1101,7 +1114,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -1898,7 +1911,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                          Choices: @@ -377,7 +383,8 @@ Parameters
                          list - / elements=string
                          + / elements=string +
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        always @@ -1956,7 +1970,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always @@ -2070,7 +2085,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always @@ -2392,7 +2408,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always @@ -2517,7 +2534,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +                         		always diff --git a/docs/community.aws.ec2_launch_template_module.rst b/docs/community.aws.ec2_launch_template_module.rst index cf7011d2f19..6084bc6f570 100644 --- a/docs/community.aws.ec2_launch_template_module.rst +++ b/docs/community.aws.ec2_launch_template_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -116,7 +120,8 @@ Parameters
                        list - / elements=dictionary
                        + / elements=dictionary + @@ -496,7 +501,8 @@ Parameters
                        list - / elements=dictionary
                        + / elements=dictionary + @@ -785,7 +791,8 @@ Parameters
                        list - / elements=dictionary
                        + / elements=dictionary + @@ -873,7 +880,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -905,7 +913,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -1071,6 +1080,8 @@ Parameters @@ -1112,7 +1123,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -1127,12 +1139,13 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -1148,6 +1161,8 @@ Parameters @@ -1262,7 +1277,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_lc_find_module.rst b/docs/community.aws.ec2_lc_find_module.rst index 4a6a2a11e45..99a9b61cf2d 100644 --- a/docs/community.aws.ec2_lc_find_module.rst +++ b/docs/community.aws.ec2_lc_find_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        -
                        A list of security group names (VPC or EC2-Classic) that the new instances will be added to.
                        +
                        A list of security group names (Default VPC or EC2-Classic) that the new instances will be added to. For any VPC other than Default, you must use security_group_ids.
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -57,6 +57,8 @@ Parameters @@ -107,6 +109,8 @@ Parameters @@ -168,7 +172,8 @@ Parameters
                        string - / required
                        + / required + @@ -190,6 +195,8 @@ Parameters @@ -222,6 +229,8 @@ Parameters @@ -271,7 +280,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_lc_info_module.rst b/docs/community.aws.ec2_lc_info_module.rst index b9691bb00e2..3904079fd98 100644 --- a/docs/community.aws.ec2_lc_info_module.rst +++ b/docs/community.aws.ec2_lc_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -204,6 +211,8 @@ Parameters @@ -310,7 +319,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_lc_module.rst b/docs/community.aws.ec2_lc_module.rst index c72e37d26d7..68c6e2348b1 100644 --- a/docs/community.aws.ec2_lc_module.rst +++ b/docs/community.aws.ec2_lc_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Default:
                        []
                        @@ -172,6 +177,8 @@ Parameters
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -93,6 +93,8 @@ Parameters @@ -143,6 +145,8 @@ Parameters @@ -168,7 +172,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -347,7 +352,8 @@ Parameters
                        string - / required
                        + / required + @@ -388,6 +394,8 @@ Parameters @@ -429,7 +437,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -450,6 +459,8 @@ Parameters @@ -543,7 +554,8 @@ Parameters
                        list - / elements=dictionary
                        + / elements=dictionary + @@ -580,7 +592,8 @@ Parameters
                        string - / required
                        + / required + @@ -740,7 +753,7 @@ Notes .. note:: - Amazon ASG Autoscaling Launch Configurations are immutable once created, so modifying the configuration after it is changed will not modify the launch configuration on AWS. You must create a new config and assign it to the ASG instead. - encrypted volumes are supported on versions >= 2.4 - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_metric_alarm_module.rst b/docs/community.aws.ec2_metric_alarm_module.rst index 547c74d9bf8..6db3511014c 100644 --- a/docs/community.aws.ec2_metric_alarm_module.rst +++ b/docs/community.aws.ec2_metric_alarm_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -48,7 +48,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -69,6 +70,8 @@ Parameters @@ -119,6 +122,8 @@ Parameters @@ -237,7 +242,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -268,7 +274,8 @@ Parameters
                        string - / required
                        + / required + @@ -298,7 +305,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -334,6 +342,8 @@ Parameters @@ -366,6 +376,8 @@ Parameters @@ -518,7 +530,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_placement_group_info_module.rst b/docs/community.aws.ec2_placement_group_info_module.rst index 43407b43c14..a4304271945 100644 --- a/docs/community.aws.ec2_placement_group_info_module.rst +++ b/docs/community.aws.ec2_placement_group_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -149,7 +153,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -203,6 +210,8 @@ Parameters @@ -233,7 +242,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_placement_group_module.rst b/docs/community.aws.ec2_placement_group_module.rst index 1a96c08bfe0..d86500ecad8 100644 --- a/docs/community.aws.ec2_placement_group_module.rst +++ b/docs/community.aws.ec2_placement_group_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Default:
                        []
                        @@ -171,6 +176,8 @@ Parameters
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -148,7 +152,8 @@ Parameters
                        string - / required
                        + / required + @@ -169,6 +174,8 @@ Parameters @@ -201,6 +208,8 @@ Parameters @@ -269,7 +278,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_scaling_policy_module.rst b/docs/community.aws.ec2_scaling_policy_module.rst index ae3a92357be..70daec2511a 100644 --- a/docs/community.aws.ec2_scaling_policy_module.rst +++ b/docs/community.aws.ec2_scaling_policy_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -68,7 +68,8 @@ Parameters
                        string - / required
                        + / required + @@ -89,6 +90,8 @@ Parameters @@ -139,6 +142,8 @@ Parameters @@ -214,7 +219,8 @@ Parameters
                        string - / required
                        + / required + @@ -235,6 +241,8 @@ Parameters @@ -282,6 +290,8 @@ Parameters @@ -331,7 +341,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_snapshot_copy_module.rst b/docs/community.aws.ec2_snapshot_copy_module.rst index 99e9a456acf..68b68e4fb3b 100644 --- a/docs/community.aws.ec2_snapshot_copy_module.rst +++ b/docs/community.aws.ec2_snapshot_copy_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -204,6 +208,8 @@ Parameters @@ -236,6 +242,8 @@ Parameters @@ -246,7 +254,8 @@ Parameters
                        string - / required
                        + / required + @@ -261,7 +270,8 @@ Parameters
                        string - / required
                        + / required + @@ -346,7 +356,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_transit_gateway_info_module.rst b/docs/community.aws.ec2_transit_gateway_info_module.rst index cf17e520a9c..3a3e807b3f0 100644 --- a/docs/community.aws.ec2_transit_gateway_info_module.rst +++ b/docs/community.aws.ec2_transit_gateway_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -171,6 +175,8 @@ Parameters @@ -203,6 +209,8 @@ Parameters @@ -213,7 +221,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -249,7 +258,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_transit_gateway_module.rst b/docs/community.aws.ec2_transit_gateway_module.rst index 9cf7c9c958a..a318344d39e 100644 --- a/docs/community.aws.ec2_transit_gateway_module.rst +++ b/docs/community.aws.ec2_transit_gateway_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -130,6 +130,8 @@ Parameters @@ -180,6 +182,8 @@ Parameters @@ -265,6 +269,8 @@ Parameters @@ -316,6 +322,8 @@ Parameters @@ -450,7 +458,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_egress_igw_module.rst b/docs/community.aws.ec2_vpc_egress_igw_module.rst index 05dad438d6f..0bbb3380bf9 100644 --- a/docs/community.aws.ec2_vpc_egress_igw_module.rst +++ b/docs/community.aws.ec2_vpc_egress_igw_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -154,6 +158,8 @@ Parameters @@ -186,6 +192,8 @@ Parameters @@ -234,7 +242,8 @@ Parameters
                        string - / required
                        + / required + @@ -250,7 +259,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_endpoint_info_module.rst b/docs/community.aws.ec2_vpc_endpoint_info_module.rst index 4950abae3a3..1baf738914d 100644 --- a/docs/community.aws.ec2_vpc_endpoint_info_module.rst +++ b/docs/community.aws.ec2_vpc_endpoint_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -171,6 +175,8 @@ Parameters @@ -181,7 +187,8 @@ Parameters
                        string - / required
                        + / required + @@ -251,7 +260,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -267,7 +277,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_endpoint_module.rst b/docs/community.aws.ec2_vpc_endpoint_module.rst index a6ecdaadc0c..9dc3dd6b3d8 100644 --- a/docs/community.aws.ec2_vpc_endpoint_module.rst +++ b/docs/community.aws.ec2_vpc_endpoint_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                          Choices: @@ -222,6 +229,8 @@ Parameters
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -205,6 +209,8 @@ Parameters @@ -231,7 +237,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -252,6 +259,8 @@ Parameters @@ -383,7 +392,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_igw_info_module.rst b/docs/community.aws.ec2_vpc_igw_info_module.rst index b73e80d8792..26501c07324 100644 --- a/docs/community.aws.ec2_vpc_igw_info_module.rst +++ b/docs/community.aws.ec2_vpc_igw_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -165,7 +169,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -186,6 +191,8 @@ Parameters @@ -218,6 +225,8 @@ Parameters @@ -248,7 +257,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_igw_module.rst b/docs/community.aws.ec2_vpc_igw_module.rst index 690f99603ec..7666f959200 100644 --- a/docs/community.aws.ec2_vpc_igw_module.rst +++ b/docs/community.aws.ec2_vpc_igw_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -156,6 +160,8 @@ Parameters @@ -188,6 +194,8 @@ Parameters @@ -252,7 +260,8 @@ Parameters
                        string - / required
                        + / required + @@ -268,7 +277,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_nacl_info_module.rst b/docs/community.aws.ec2_vpc_nacl_info_module.rst index 3aab5d5a7d9..2c65f0821ae 100644 --- a/docs/community.aws.ec2_vpc_nacl_info_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -166,7 +170,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -221,6 +228,8 @@ Parameters @@ -252,7 +261,7 @@ Notes .. note:: - By default, the module will return all Network ACLs. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -316,7 +325,8 @@ Common return values are documented `here
                        list - / elements=list
                        + / elements=list +
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Default:
                        []
                        @@ -189,6 +194,8 @@ Parameters
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        always @@ -335,7 +345,8 @@ Common return values are documented `here
                        list - / elements=list
                        + / elements=list +                         		always @@ -386,7 +397,8 @@ Common return values are documented `here
                        list - / elements=string
                        + / elements=string +                         		always diff --git a/docs/community.aws.ec2_vpc_nacl_module.rst b/docs/community.aws.ec2_vpc_nacl_module.rst index da56bd5b456..eea6e32831d 100644 --- a/docs/community.aws.ec2_vpc_nacl_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -151,7 +155,8 @@ Parameters
                        list - / elements=list
                        + / elements=list + @@ -253,6 +261,8 @@ Parameters @@ -283,7 +293,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -351,7 +362,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst b/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst index bb32c7a7ffa..15179783301 100644 --- a/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst +++ b/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Default:
                        []
                        @@ -167,7 +172,8 @@ Parameters
                        list - / elements=list
                        + / elements=list +                         		Default:
                        []
                        @@ -221,6 +227,8 @@ Parameters
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -165,7 +169,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -186,6 +191,8 @@ Parameters @@ -218,6 +225,8 @@ Parameters @@ -248,7 +257,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_nat_gateway_module.rst b/docs/community.aws.ec2_vpc_nat_gateway_module.rst index b115f2c6f43..7beb9612ce0 100644 --- a/docs/community.aws.ec2_vpc_nat_gateway_module.rst +++ b/docs/community.aws.ec2_vpc_nat_gateway_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -70,6 +70,8 @@ Parameters @@ -120,6 +122,8 @@ Parameters @@ -235,6 +239,8 @@ Parameters @@ -288,6 +294,8 @@ Parameters @@ -387,7 +395,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_peer_module.rst b/docs/community.aws.ec2_vpc_peer_module.rst index dd96bc3e077..f518d226230 100644 --- a/docs/community.aws.ec2_vpc_peer_module.rst +++ b/docs/community.aws.ec2_vpc_peer_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -217,6 +221,8 @@ Parameters @@ -249,6 +255,8 @@ Parameters @@ -330,7 +338,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_peering_info_module.rst b/docs/community.aws.ec2_vpc_peering_info_module.rst index 34e69f606aa..ffdb565fa5b 100644 --- a/docs/community.aws.ec2_vpc_peering_info_module.rst +++ b/docs/community.aws.ec2_vpc_peering_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -165,7 +169,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -186,6 +191,8 @@ Parameters @@ -218,6 +225,8 @@ Parameters @@ -248,7 +257,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_route_table_info_module.rst b/docs/community.aws.ec2_vpc_route_table_info_module.rst index 1bd7d93ee4b..56ae4dd03ea 100644 --- a/docs/community.aws.ec2_vpc_route_table_info_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -170,6 +174,8 @@ Parameters @@ -202,6 +208,8 @@ Parameters @@ -232,7 +240,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_route_table_module.rst b/docs/community.aws.ec2_vpc_route_table_module.rst index db7ed4ce224..f1d179eeac6 100644 --- a/docs/community.aws.ec2_vpc_route_table_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -173,6 +177,8 @@ Parameters @@ -183,7 +189,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -288,7 +295,8 @@ Parameters
                        list - / elements=dictionary
                        + / elements=dictionary + @@ -309,6 +317,8 @@ Parameters @@ -338,7 +348,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -405,7 +416,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_vgw_info_module.rst b/docs/community.aws.ec2_vpc_vgw_info_module.rst index a2c494ea25c..1d0fef4366b 100644 --- a/docs/community.aws.ec2_vpc_vgw_info_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -171,6 +175,8 @@ Parameters @@ -203,6 +209,8 @@ Parameters @@ -232,7 +240,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -248,7 +257,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_vgw_module.rst b/docs/community.aws.ec2_vpc_vgw_module.rst index 6a1ee4fb25c..8e6fe8c5908 100644 --- a/docs/community.aws.ec2_vpc_vgw_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -72,6 +72,8 @@ Parameters @@ -122,6 +124,8 @@ Parameters @@ -188,6 +192,8 @@ Parameters @@ -220,6 +226,8 @@ Parameters @@ -350,7 +358,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_vpn_info_module.rst b/docs/community.aws.ec2_vpc_vpn_info_module.rst index b9a88856f97..e8eda1b5c95 100644 --- a/docs/community.aws.ec2_vpc_vpn_info_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -171,6 +175,8 @@ Parameters @@ -203,6 +209,8 @@ Parameters @@ -232,7 +240,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -248,7 +257,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_vpc_vpn_module.rst b/docs/community.aws.ec2_vpc_vpn_module.rst index cd75eaf264b..72426420bc2 100644 --- a/docs/community.aws.ec2_vpc_vpn_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -380,6 +384,8 @@ Parameters @@ -444,7 +450,8 @@ Parameters
                        list - / elements=string
                        + / elements=string + @@ -465,6 +472,8 @@ Parameters @@ -528,7 +537,8 @@ Parameters
                        list - / elements=dictionary
                        + / elements=dictionary + @@ -642,7 +652,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ec2_win_password_module.rst b/docs/community.aws.ec2_win_password_module.rst index dbb14cb625c..dc384260d46 100644 --- a/docs/community.aws.ec2_win_password_module.rst +++ b/docs/community.aws.ec2_win_password_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
                        string - / required
                        + / required + @@ -218,6 +223,8 @@ Parameters @@ -250,6 +257,8 @@ Parameters @@ -316,7 +325,7 @@ Notes .. note:: - As of Ansible 2.4, this module requires the python cryptography module rather than the older pycrypto module. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ecs_attribute_module.rst b/docs/community.aws.ecs_attribute_module.rst index c0bf8c0b3ba..1bb479db5ac 100644 --- a/docs/community.aws.ecs_attribute_module.rst +++ b/docs/community.aws.ecs_attribute_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        - + @@ -49,7 +49,9 @@ Parameters
                        list - / elements=dictionary / required
                        + / elements=dictionary + / required + @@ -65,7 +67,8 @@ Parameters
                        string - / required
                        + / required + @@ -103,6 +106,8 @@ Parameters @@ -153,6 +158,8 @@ Parameters @@ -163,7 +170,8 @@ Parameters
                        string - / required
                        + / required + @@ -197,7 +205,8 @@ Parameters
                        string - / required
                        + / required + @@ -234,6 +243,8 @@ Parameters @@ -266,6 +277,8 @@ Parameters @@ -315,7 +328,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -385,7 +398,8 @@ Common return values are documented `here
                        list - / elements=dictionary
                        + / elements=dictionary +
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                        diff --git a/docs/community.aws.ecs_cluster_module.rst b/docs/community.aws.ecs_cluster_module.rst index c7cc3c9baf4..43831341e6a 100644 --- a/docs/community.aws.ecs_cluster_module.rst +++ b/docs/community.aws.ecs_cluster_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -165,7 +169,8 @@ Parameters
                        string - / required
                        + / required + @@ -186,6 +191,8 @@ Parameters @@ -234,6 +241,8 @@ Parameters @@ -244,7 +253,8 @@ Parameters
                        string - / required
                        + / required +
                        Parameter Choices/Defaults Comments
                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_access_key, access_key
                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: ec2_secret_key, secret_key
                        Uses a boto profile. Only works with boto >= 2.24.0.
                        +
                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                        +
                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                        aliases: aws_profile
                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                        +
                        If profile is set this parameter is ignored.
                        +
                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                        aliases: aws_security_token, access_token
                          Choices: @@ -286,7 +296,7 @@ Notes .. note:: - When deleting a cluster, the information returned is the state of the cluster prior to deletion. - It will also wait for a cluster to have instances registered to it. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ecs_ecr_module.rst b/docs/community.aws.ecs_ecr_module.rst index b3ca43aa53a..0c17a0863e7 100644 --- a/docs/community.aws.ecs_ecr_module.rst +++ b/docs/community.aws.ecs_ecr_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -202,7 +206,8 @@ Parameters
                          string - / required
                          + / required + @@ -238,6 +243,8 @@ Parameters @@ -326,6 +333,8 @@ Parameters @@ -375,7 +384,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ecs_service_info_module.rst b/docs/community.aws.ecs_service_info_module.rst index 3f88a3749d3..11414624b85 100644 --- a/docs/community.aws.ecs_service_info_module.rst +++ b/docs/community.aws.ecs_service_info_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          - + @@ -57,6 +57,8 @@ Parameters @@ -107,6 +109,8 @@ Parameters @@ -211,6 +215,8 @@ Parameters @@ -243,6 +249,8 @@ Parameters @@ -253,7 +261,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -288,7 +297,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -366,7 +375,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          always @@ -398,7 +408,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +                           		when events is true diff --git a/docs/community.aws.ecs_service_module.rst b/docs/community.aws.ecs_service_module.rst index a27bb6ae9cc..39b9fc3f3dd 100644 --- a/docs/community.aws.ecs_service_module.rst +++ b/docs/community.aws.ecs_service_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -316,7 +320,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -331,7 +336,8 @@ Parameters
                          string - / required
                          + / required + @@ -384,7 +390,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -400,7 +407,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -416,7 +424,8 @@ Parameters
                          list - / elements=dictionary
                          + / elements=dictionary + @@ -465,7 +474,8 @@ Parameters
                          list - / elements=dictionary
                          + / elements=dictionary + @@ -519,6 +529,8 @@ Parameters @@ -602,6 +614,8 @@ Parameters @@ -612,7 +626,8 @@ Parameters
                          list - / elements=dictionary
                          + / elements=dictionary + @@ -676,7 +691,8 @@ Parameters
                          string - / required
                          + / required +
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                            Choices: @@ -735,7 +751,7 @@ Notes - The service role specified must be assumable. (i.e. have a trust relationship for the ecs service, ecs.amazonaws.com) - For details of the parameters and returns see https://boto3.readthedocs.io/en/latest/reference/services/ecs.html. - An IAM role must have been previously created. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -901,7 +917,8 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
                            list - / elements=dictionary
                            + / elements=dictionary +
                          		always @@ -935,7 +952,8 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
                          list - / elements=dictionary
                          + / elements=dictionary +                           		always @@ -1041,7 +1059,8 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
                          list - / elements=dictionary
                          + / elements=dictionary +                           		always @@ -1095,7 +1114,8 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
                          list - / elements=dictionary
                          + / elements=dictionary +                           		always @@ -1333,7 +1353,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +                           		always @@ -1365,7 +1386,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +                           		always @@ -1465,7 +1487,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +                           		always @@ -1516,7 +1539,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +                           		always diff --git a/docs/community.aws.ecs_tag_module.rst b/docs/community.aws.ecs_tag_module.rst index 8a3fa75dd79..268a9b8b018 100644 --- a/docs/community.aws.ecs_tag_module.rst +++ b/docs/community.aws.ecs_tag_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -116,7 +120,8 @@ Parameters
                          string - / required
                          + / required + @@ -172,6 +177,8 @@ Parameters @@ -262,6 +269,8 @@ Parameters @@ -328,7 +337,7 @@ Notes .. note:: - none - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ecs_task_module.rst b/docs/community.aws.ecs_task_module.rst index 8f821a8f728..77ffea44c44 100644 --- a/docs/community.aws.ecs_task_module.rst +++ b/docs/community.aws.ecs_task_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -131,7 +135,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -231,7 +236,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -247,7 +253,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -263,7 +270,8 @@ Parameters
                          string - / required
                          + / required + @@ -336,6 +346,8 @@ Parameters @@ -426,7 +438,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file @@ -563,7 +575,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                            Choices: @@ -304,6 +312,8 @@ Parameters
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          only when details is true @@ -643,7 +656,8 @@ Common return values are documented `here
                          list - / elements=dictionary
                          + / elements=dictionary +                           		only when details is true diff --git a/docs/community.aws.ecs_taskdefinition_info_module.rst b/docs/community.aws.ecs_taskdefinition_info_module.rst index 5cd1be9bc22..d444d4579df 100644 --- a/docs/community.aws.ecs_taskdefinition_info_module.rst +++ b/docs/community.aws.ecs_taskdefinition_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -157,6 +161,8 @@ Parameters @@ -189,6 +195,8 @@ Parameters @@ -199,7 +207,8 @@ Parameters
                          string - / required
                          + / required + @@ -236,7 +245,7 @@ Notes .. note:: - For details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition - This module was called ``ecs_taskdefinition_facts`` before Ansible 2.9. The usage did not change. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.ecs_taskdefinition_module.rst b/docs/community.aws.ecs_taskdefinition_module.rst index 040b5a0cb47..9dec6ee0f82 100644 --- a/docs/community.aws.ecs_taskdefinition_module.rst +++ b/docs/community.aws.ecs_taskdefinition_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          - + @@ -71,6 +71,8 @@ Parameters @@ -121,6 +123,8 @@ Parameters @@ -131,7 +135,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -312,6 +317,8 @@ Parameters @@ -359,6 +366,8 @@ Parameters @@ -369,7 +378,8 @@ Parameters
                          string - / required
                          + / required + @@ -438,7 +449,8 @@ Parameters
                          string - / required
                          + / required + @@ -455,7 +467,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.efs_info_module.rst b/docs/community.aws.efs_info_module.rst index 85601f63fac..c7c354e76ab 100644 --- a/docs/community.aws.efs_info_module.rst +++ b/docs/community.aws.efs_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                            Choices: @@ -422,7 +432,8 @@ Parameters
                            list - / elements=dictionary
                            + / elements=dictionary +
                          - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -187,6 +191,8 @@ Parameters @@ -219,6 +225,8 @@ Parameters @@ -244,7 +252,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -280,7 +289,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.efs_module.rst b/docs/community.aws.efs_module.rst index 92481e55fe8..52bdeef7989 100644 --- a/docs/community.aws.efs_module.rst +++ b/docs/community.aws.efs_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -238,6 +242,8 @@ Parameters @@ -305,6 +311,8 @@ Parameters @@ -349,7 +357,8 @@ Parameters
                          list - / elements=dictionary
                          + / elements=dictionary + @@ -381,7 +390,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -397,7 +407,8 @@ Parameters
                          - - / required
                          + / required + @@ -488,7 +499,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elasticache_info_module.rst b/docs/community.aws.elasticache_info_module.rst index e2a78da6b3f..34c698e53f5 100644 --- a/docs/community.aws.elasticache_info_module.rst +++ b/docs/community.aws.elasticache_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -170,6 +174,8 @@ Parameters @@ -202,6 +208,8 @@ Parameters @@ -232,7 +240,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elasticache_module.rst b/docs/community.aws.elasticache_module.rst index 8aa849199f3..88963c4a5b1 100644 --- a/docs/community.aws.elasticache_module.rst +++ b/docs/community.aws.elasticache_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                          - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -161,7 +165,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -263,7 +268,8 @@ Parameters
                          string - / required
                          + / required + @@ -317,6 +323,8 @@ Parameters @@ -343,7 +351,8 @@ Parameters
                          list - / elements=string
                          + / elements=string + @@ -364,6 +373,8 @@ Parameters @@ -374,7 +385,8 @@ Parameters
                          string - / required
                          + / required +
                          Parameter Choices/Defaults Comments
                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_access_key, access_key
                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: ec2_secret_key, secret_key
                          Uses a boto profile. Only works with boto >= 2.24.0.
                          +
                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                          +
                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                          aliases: aws_profile
                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                          +
                          If profile is set this parameter is ignored.
                          +
                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                          aliases: aws_security_token, access_token
                            Choices: @@ -449,7 +461,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elasticache_parameter_group_module.rst b/docs/community.aws.elasticache_parameter_group_module.rst index d0109d76579..f458bbda6b8 100644 --- a/docs/community.aws.elasticache_parameter_group_module.rst +++ b/docs/community.aws.elasticache_parameter_group_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -190,7 +194,8 @@ Parameters
                            string - / required
                            + / required + @@ -211,6 +216,8 @@ Parameters @@ -243,6 +250,8 @@ Parameters @@ -253,7 +262,8 @@ Parameters
                            string - / required
                            + / required +
                            Parameter Choices/Defaults Comments
                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                            +
                            If profile is set this parameter is ignored.
                            +
                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                            aliases: ec2_access_key, access_key
                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                            +
                            If profile is set this parameter is ignored.
                            +
                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                            aliases: ec2_secret_key, secret_key
                            Uses a boto profile. Only works with boto >= 2.24.0.
                            +
                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                            +
                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                            aliases: aws_profile
                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                            +
                            If profile is set this parameter is ignored.
                            +
                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                            aliases: aws_security_token, access_token
                              Choices: @@ -308,7 +318,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elasticache_snapshot_module.rst b/docs/community.aws.elasticache_snapshot_module.rst index b6134273b09..3ac68c664bd 100644 --- a/docs/community.aws.elasticache_snapshot_module.rst +++ b/docs/community.aws.elasticache_snapshot_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -181,7 +185,8 @@ Parameters
                              string - / required
                              + / required + @@ -202,6 +207,8 @@ Parameters @@ -249,6 +256,8 @@ Parameters @@ -259,7 +268,8 @@ Parameters
                              string - / required
                              + / required +
                              Parameter Choices/Defaults Comments
                              AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                              +
                              If profile is set this parameter is ignored.
                              +
                              Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                              aliases: ec2_access_key, access_key
                              AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                              +
                              If profile is set this parameter is ignored.
                              +
                              Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                              aliases: ec2_secret_key, secret_key
                              Uses a boto profile. Only works with boto >= 2.24.0.
                              +
                              Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                              +
                              aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                              aliases: aws_profile
                              AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                              +
                              If profile is set this parameter is ignored.
                              +
                              Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                              aliases: aws_security_token, access_token
                                Choices: @@ -314,7 +324,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elasticache_subnet_group_module.rst b/docs/community.aws.elasticache_subnet_group_module.rst index 9fd7b01d723..f566eb8d07f 100644 --- a/docs/community.aws.elasticache_subnet_group_module.rst +++ b/docs/community.aws.elasticache_subnet_group_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -163,7 +167,8 @@ Parameters
                                string - / required
                                + / required + @@ -184,6 +189,8 @@ Parameters @@ -216,6 +223,8 @@ Parameters @@ -226,7 +235,8 @@ Parameters
                                string - / required
                                + / required + @@ -280,7 +291,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_application_lb_info_module.rst b/docs/community.aws.elb_application_lb_info_module.rst index c08d485cf83..fb0e67cc590 100644 --- a/docs/community.aws.elb_application_lb_info_module.rst +++ b/docs/community.aws.elb_application_lb_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                Parameter Choices/Defaults Comments
                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_access_key, access_key
                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_secret_key, secret_key
                                Uses a boto profile. Only works with boto >= 2.24.0.
                                +
                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                +
                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                aliases: aws_profile
                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: aws_security_token, access_token
                                  Choices: @@ -245,7 +255,8 @@ Parameters
                                  list - / elements=string
                                  + / elements=string +
                                - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -165,7 +170,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -186,6 +192,8 @@ Parameters @@ -218,6 +226,8 @@ Parameters @@ -248,7 +258,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_application_lb_module.rst b/docs/community.aws.elb_application_lb_module.rst index 8f42d1241dd..7ea443c49a2 100644 --- a/docs/community.aws.elb_application_lb_module.rst +++ b/docs/community.aws.elb_application_lb_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                Parameter Choices/Defaults Comments
                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_access_key, access_key
                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_secret_key, secret_key
                                Uses a boto profile. Only works with boto >= 2.24.0.
                                +
                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                +
                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                aliases: aws_profile
                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: aws_security_token, access_token
                                - + @@ -109,6 +109,8 @@ Parameters @@ -159,6 +161,8 @@ Parameters @@ -257,7 +261,8 @@ Parameters
                                list - / elements=dictionary
                                + / elements=dictionary + @@ -273,7 +278,8 @@ Parameters
                                list - / elements=dictionary
                                + / elements=dictionary + @@ -307,7 +313,9 @@ Parameters
                                list - / elements=dictionary / required
                                + / elements=dictionary + / required + @@ -358,7 +366,8 @@ Parameters
                                integer - / required
                                + / required + @@ -374,7 +383,8 @@ Parameters
                                string - / required
                                + / required + @@ -390,7 +400,8 @@ Parameters
                                list - / elements=dictionary
                                + / elements=dictionary + @@ -476,7 +487,8 @@ Parameters
                                string - / required
                                + / required + @@ -497,6 +509,8 @@ Parameters @@ -599,7 +613,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -651,7 +668,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -738,7 +756,7 @@ Notes .. note:: - Listeners are matched based on port. If a listener's port is changed then a new listener will be created. - Listener rules are matched based on priority. If a rule's priority is changed then a new rule will be created. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_classic_lb_info_module.rst b/docs/community.aws.elb_classic_lb_info_module.rst index 3a564897d1f..8a2658fb30c 100644 --- a/docs/community.aws.elb_classic_lb_info_module.rst +++ b/docs/community.aws.elb_classic_lb_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                Parameter Choices/Defaults Comments
                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_access_key, access_key
                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_secret_key, secret_key
                                Uses a boto profile. Only works with boto >= 2.24.0.
                                +
                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                +
                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                aliases: aws_profile
                                Default:
                                []
                                @@ -622,6 +637,8 @@ Parameters
                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: aws_security_token, access_token
                                - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -151,7 +155,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -172,6 +177,8 @@ Parameters @@ -204,6 +211,8 @@ Parameters @@ -234,7 +243,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_classic_lb_module.rst b/docs/community.aws.elb_classic_lb_module.rst index 198d6383a71..177e119e7e6 100644 --- a/docs/community.aws.elb_classic_lb_module.rst +++ b/docs/community.aws.elb_classic_lb_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                Parameter Choices/Defaults Comments
                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_access_key, access_key
                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_secret_key, secret_key
                                Uses a boto profile. Only works with boto >= 2.24.0.
                                +
                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                +
                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                aliases: aws_profile
                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: aws_security_token, access_token
                                - + @@ -69,6 +69,8 @@ Parameters @@ -119,6 +121,8 @@ Parameters @@ -228,7 +232,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -243,7 +248,8 @@ Parameters
                                list - / elements=dictionary
                                + / elements=dictionary + @@ -258,7 +264,8 @@ Parameters
                                string - / required
                                + / required + @@ -279,6 +286,8 @@ Parameters @@ -400,7 +409,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -415,7 +425,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -436,6 +447,8 @@ Parameters @@ -446,7 +459,8 @@ Parameters
                                string - / required
                                + / required + @@ -564,7 +579,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -580,7 +596,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_instance_module.rst b/docs/community.aws.elb_instance_module.rst index 69e6c3436b2..5f642a591d7 100644 --- a/docs/community.aws.elb_instance_module.rst +++ b/docs/community.aws.elb_instance_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                Parameter Choices/Defaults Comments
                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_access_key, access_key
                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_secret_key, secret_key
                                Uses a boto profile. Only works with boto >= 2.24.0.
                                +
                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                +
                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                aliases: aws_profile
                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: aws_security_token, access_token
                                  Choices: @@ -480,7 +494,8 @@ Parameters
                                  list - / elements=string
                                  + / elements=string +
                                - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -134,7 +138,8 @@ Parameters
                                list - / elements=string
                                + / elements=string + @@ -184,7 +189,8 @@ Parameters
                                string - / required
                                + / required + @@ -205,6 +211,8 @@ Parameters @@ -237,6 +245,8 @@ Parameters @@ -247,7 +257,8 @@ Parameters
                                string - / required
                                + / required +
                                Parameter Choices/Defaults Comments
                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_access_key, access_key
                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: ec2_secret_key, secret_key
                                Uses a boto profile. Only works with boto >= 2.24.0.
                                +
                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                +
                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                aliases: aws_profile
                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                +
                                If profile is set this parameter is ignored.
                                +
                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                aliases: aws_security_token, access_token
                                  Choices: @@ -321,7 +332,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_network_lb_module.rst b/docs/community.aws.elb_network_lb_module.rst index 7c93c2fdff0..ed7f91a05bf 100644 --- a/docs/community.aws.elb_network_lb_module.rst +++ b/docs/community.aws.elb_network_lb_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -187,7 +191,8 @@ Parameters
                                  list - / elements=dictionary
                                  + / elements=dictionary + @@ -203,7 +208,8 @@ Parameters
                                  list - / elements=dictionary
                                  + / elements=dictionary + @@ -237,7 +243,9 @@ Parameters
                                  list - / elements=dictionary / required
                                  + / elements=dictionary + / required + @@ -288,7 +296,8 @@ Parameters
                                  integer - / required
                                  + / required + @@ -304,7 +313,8 @@ Parameters
                                  string - / required
                                  + / required + @@ -336,7 +346,8 @@ Parameters
                                  string - / required
                                  + / required + @@ -357,6 +368,8 @@ Parameters @@ -448,6 +461,8 @@ Parameters @@ -478,7 +493,8 @@ Parameters
                                  list - / elements=dictionary
                                  + / elements=dictionary + @@ -494,7 +510,8 @@ Parameters
                                  list - / elements=string
                                  + / elements=string + @@ -582,7 +599,7 @@ Notes .. note:: - Listeners are matched based on port. If a listener's port is changed then a new listener will be created. - Listener rules are matched based on priority. If a rule's priority is changed then a new rule will be created. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_target_group_info_module.rst b/docs/community.aws.elb_target_group_info_module.rst index c7525a5fd49..83511da09a7 100644 --- a/docs/community.aws.elb_target_group_info_module.rst +++ b/docs/community.aws.elb_target_group_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                  Parameter Choices/Defaults Comments
                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_access_key, access_key
                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_secret_key, secret_key
                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                  +
                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                  +
                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                  aliases: aws_profile
                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: aws_security_token, access_token
                                  - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -184,7 +188,8 @@ Parameters
                                  list - / elements=string
                                  + / elements=string + @@ -205,6 +210,8 @@ Parameters @@ -237,6 +244,8 @@ Parameters @@ -247,7 +256,8 @@ Parameters
                                  list - / elements=string
                                  + / elements=string + @@ -282,7 +292,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_target_group_module.rst b/docs/community.aws.elb_target_group_module.rst index 13f0826806f..5b39b157349 100644 --- a/docs/community.aws.elb_target_group_module.rst +++ b/docs/community.aws.elb_target_group_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                  Parameter Choices/Defaults Comments
                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_access_key, access_key
                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_secret_key, secret_key
                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                  +
                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                  +
                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                  aliases: aws_profile
                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: aws_security_token, access_token
                                  - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -289,7 +293,8 @@ Parameters
                                  string - / required
                                  + / required + @@ -325,6 +330,8 @@ Parameters @@ -405,6 +412,8 @@ Parameters @@ -415,7 +424,8 @@ Parameters
                                  string - / required
                                  + / required + @@ -638,7 +649,7 @@ Notes .. note:: - Once a target group has been created, only its health check can then be modified using subsequent calls - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_target_info_module.rst b/docs/community.aws.elb_target_info_module.rst index e96e19a5ad1..918be270c54 100644 --- a/docs/community.aws.elb_target_info_module.rst +++ b/docs/community.aws.elb_target_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                  Parameter Choices/Defaults Comments
                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_access_key, access_key
                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_secret_key, secret_key
                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                  +
                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                  +
                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                  aliases: aws_profile
                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: aws_security_token, access_token
                                    Choices: @@ -537,7 +547,8 @@ Parameters
                                    list - / elements=dictionary
                                    + / elements=dictionary +
                                  - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -170,7 +174,8 @@ Parameters
                                  string - / required
                                  + / required + @@ -191,6 +196,8 @@ Parameters @@ -223,6 +230,8 @@ Parameters @@ -253,7 +262,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.elb_target_module.rst b/docs/community.aws.elb_target_module.rst index 11c9d8bfa21..d208c11de88 100644 --- a/docs/community.aws.elb_target_module.rst +++ b/docs/community.aws.elb_target_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                                  Parameter Choices/Defaults Comments
                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_access_key, access_key
                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_secret_key, secret_key
                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                  +
                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                  +
                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                  aliases: aws_profile
                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: aws_security_token, access_token
                                  - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -173,6 +177,8 @@ Parameters @@ -205,6 +211,8 @@ Parameters @@ -215,7 +223,8 @@ Parameters
                                  string - / required
                                  + / required + @@ -370,7 +380,7 @@ Notes .. note:: - If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.execute_lambda_module.rst b/docs/community.aws.execute_lambda_module.rst index c1b395144de..917a3c56e5a 100644 --- a/docs/community.aws.execute_lambda_module.rst +++ b/docs/community.aws.execute_lambda_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                  Parameter Choices/Defaults Comments
                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_access_key, access_key
                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_secret_key, secret_key
                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                  +
                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                  +
                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                  aliases: aws_profile
                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: aws_security_token, access_token
                                    Choices: @@ -279,7 +288,8 @@ Parameters
                                    string - / required
                                    + / required +
                                  - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -220,6 +224,8 @@ Parameters @@ -252,6 +258,8 @@ Parameters @@ -337,7 +345,7 @@ Notes .. note:: - Async invocation will always return an empty ``output`` key. - Synchronous invocation may result in a function timeout, resulting in an empty ``output`` key. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_cert_module.rst b/docs/community.aws.iam_cert_module.rst index 51e81660f00..f76ee1ed3dc 100644 --- a/docs/community.aws.iam_cert_module.rst +++ b/docs/community.aws.iam_cert_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                                  Parameter Choices/Defaults Comments
                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_access_key, access_key
                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_secret_key, secret_key
                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                  +
                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                  +
                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                  aliases: aws_profile
                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: aws_security_token, access_token
                                  - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -213,7 +217,8 @@ Parameters
                                  string - / required
                                  + / required + @@ -282,6 +287,8 @@ Parameters @@ -314,6 +321,8 @@ Parameters @@ -324,7 +333,8 @@ Parameters
                                  string - / required
                                  + / required +
                                  Parameter Choices/Defaults Comments
                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_access_key, access_key
                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: ec2_secret_key, secret_key
                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                  +
                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                  +
                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                  aliases: aws_profile
                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                  +
                                  If profile is set this parameter is ignored.
                                  +
                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                  aliases: aws_security_token, access_token
                                    Choices: @@ -364,7 +374,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_group_module.rst b/docs/community.aws.iam_group_module.rst index 1683e54b0ad..9ee2a4e6f82 100644 --- a/docs/community.aws.iam_group_module.rst +++ b/docs/community.aws.iam_group_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
                                    list - / elements=string
                                    + / elements=string + @@ -167,7 +172,8 @@ Parameters
                                    string - / required
                                    + / required + @@ -188,6 +194,8 @@ Parameters @@ -259,6 +267,8 @@ Parameters @@ -269,7 +279,8 @@ Parameters
                                    string - / required
                                    + / required + @@ -323,7 +335,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_managed_policy_module.rst b/docs/community.aws.iam_managed_policy_module.rst index 5eefe87b023..05567a58001 100644 --- a/docs/community.aws.iam_managed_policy_module.rst +++ b/docs/community.aws.iam_managed_policy_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                    Parameter Choices/Defaults Comments
                                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_access_key, access_key
                                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_secret_key, secret_key
                                    Uses a boto profile. Only works with boto >= 2.24.0.
                                    +
                                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                    +
                                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                    aliases: aws_profile
                                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: aws_security_token, access_token
                                      Choices: @@ -288,7 +299,8 @@ Parameters
                                      list - / elements=string
                                      + / elements=string +
                                    - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -238,7 +242,8 @@ Parameters
                                    string - / required
                                    + / required + @@ -259,6 +264,8 @@ Parameters @@ -291,6 +298,8 @@ Parameters @@ -340,7 +349,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_mfa_device_info_module.rst b/docs/community.aws.iam_mfa_device_info_module.rst index 05c0a39e602..96e267dd8ee 100644 --- a/docs/community.aws.iam_mfa_device_info_module.rst +++ b/docs/community.aws.iam_mfa_device_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                    Parameter Choices/Defaults Comments
                                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_access_key, access_key
                                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_secret_key, secret_key
                                    Uses a boto profile. Only works with boto >= 2.24.0.
                                    +
                                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                    +
                                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                    aliases: aws_profile
                                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: aws_security_token, access_token
                                    - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -157,6 +161,8 @@ Parameters @@ -189,6 +195,8 @@ Parameters @@ -234,7 +242,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_module.rst b/docs/community.aws.iam_module.rst index 1f5f78fa016..936ee464e94 100644 --- a/docs/community.aws.iam_module.rst +++ b/docs/community.aws.iam_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                                    Parameter Choices/Defaults Comments
                                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_access_key, access_key
                                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_secret_key, secret_key
                                    Uses a boto profile. Only works with boto >= 2.24.0.
                                    +
                                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                    +
                                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                    aliases: aws_profile
                                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: aws_security_token, access_token
                                    - + @@ -47,7 +47,8 @@ Parameters
                                    list - / elements=string
                                    + / elements=string + @@ -93,6 +94,8 @@ Parameters @@ -143,6 +146,8 @@ Parameters @@ -188,7 +193,8 @@ Parameters
                                    list - / elements=string
                                    + / elements=string + @@ -203,7 +209,8 @@ Parameters
                                    string - / required
                                    + / required + @@ -323,6 +331,8 @@ Parameters @@ -355,6 +365,8 @@ Parameters @@ -365,7 +377,8 @@ Parameters
                                    string - / required
                                    + / required +
                                    Parameter Choices/Defaults Comments
                                    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_access_key, access_key
                                    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: ec2_secret_key, secret_key
                                      Choices: @@ -239,7 +246,8 @@ Parameters
                                      string - / required
                                      + / required +
                                    Uses a boto profile. Only works with boto >= 2.24.0.
                                    +
                                    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                    +
                                    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                    aliases: aws_profile
                                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                    +
                                    If profile is set this parameter is ignored.
                                    +
                                    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                    aliases: aws_security_token, access_token
                                      Choices: @@ -459,7 +472,7 @@ Notes .. note:: - Currently boto does not support the removal of Managed Policies, the module will error out if your user/group/role has managed policies when you try to do state=absent. They will need to be removed manually. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_password_policy_module.rst b/docs/community.aws.iam_password_policy_module.rst index 472e6987eba..7d4133619ed 100644 --- a/docs/community.aws.iam_password_policy_module.rst +++ b/docs/community.aws.iam_password_policy_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -75,6 +75,8 @@ Parameters @@ -125,6 +127,8 @@ Parameters @@ -193,6 +197,8 @@ Parameters @@ -355,6 +361,8 @@ Parameters @@ -365,7 +373,8 @@ Parameters
                                      string - / required
                                      + / required +
                                      Parameter Choices/Defaults Comments
                                      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                      +
                                      If profile is set this parameter is ignored.
                                      +
                                      Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                      aliases: ec2_access_key, access_key
                                      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                      +
                                      If profile is set this parameter is ignored.
                                      +
                                      Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                      aliases: ec2_secret_key, secret_key
                                      Uses a boto profile. Only works with boto >= 2.24.0.
                                      +
                                      Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                      +
                                      aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                      aliases: aws_profile
                                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                      +
                                      If profile is set this parameter is ignored.
                                      +
                                      Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                      aliases: aws_security_token, access_token
                                        Choices: @@ -404,7 +413,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_policy_info_module.rst b/docs/community.aws.iam_policy_info_module.rst index ac6d53e14a8..3fffa1c62b7 100644 --- a/docs/community.aws.iam_policy_info_module.rst +++ b/docs/community.aws.iam_policy_info_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -148,7 +152,8 @@ Parameters
                                        string - / required
                                        + / required + @@ -163,7 +168,8 @@ Parameters
                                        string - / required
                                        + / required + @@ -236,6 +244,8 @@ Parameters @@ -266,7 +276,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_policy_module.rst b/docs/community.aws.iam_policy_module.rst index bd9c47e5974..bdbb15cc7c2 100644 --- a/docs/community.aws.iam_policy_module.rst +++ b/docs/community.aws.iam_policy_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                          Choices: @@ -204,6 +210,8 @@ Parameters
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                        - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -149,7 +153,8 @@ Parameters
                                        string - / required
                                        + / required + @@ -164,7 +169,8 @@ Parameters
                                        string - / required
                                        + / required + @@ -239,6 +246,8 @@ Parameters @@ -271,6 +280,8 @@ Parameters @@ -340,7 +351,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_role_info_module.rst b/docs/community.aws.iam_role_info_module.rst index b0735befda9..1c6c56914cb 100644 --- a/docs/community.aws.iam_role_info_module.rst +++ b/docs/community.aws.iam_role_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                          Choices: @@ -218,7 +224,8 @@ Parameters
                                          string - / required
                                          + / required +
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -189,6 +193,8 @@ Parameters @@ -221,6 +227,8 @@ Parameters @@ -251,7 +259,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_role_module.rst b/docs/community.aws.iam_role_module.rst index 82dfe70f8a6..efdb1928a51 100644 --- a/docs/community.aws.iam_role_module.rst +++ b/docs/community.aws.iam_role_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                        - + @@ -71,6 +71,8 @@ Parameters @@ -121,6 +123,8 @@ Parameters @@ -240,7 +244,8 @@ Parameters
                                        list - / elements=string
                                        + / elements=string + @@ -274,7 +279,8 @@ Parameters
                                        string - / required
                                        + / required + @@ -311,6 +317,8 @@ Parameters @@ -383,6 +391,8 @@ Parameters @@ -448,7 +458,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_saml_federation_module.rst b/docs/community.aws.iam_saml_federation_module.rst index 814dc3c4ec0..c741777dd30 100644 --- a/docs/community.aws.iam_saml_federation_module.rst +++ b/docs/community.aws.iam_saml_federation_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                        - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -149,7 +153,8 @@ Parameters
                                        string - / required
                                        + / required + @@ -170,6 +175,8 @@ Parameters @@ -217,6 +224,8 @@ Parameters @@ -266,7 +275,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_server_certificate_info_module.rst b/docs/community.aws.iam_server_certificate_info_module.rst index a4d72a5199d..a4201eccfc9 100644 --- a/docs/community.aws.iam_server_certificate_info_module.rst +++ b/docs/community.aws.iam_server_certificate_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                        - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -172,6 +176,8 @@ Parameters @@ -204,6 +210,8 @@ Parameters @@ -234,7 +242,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_user_info_module.rst b/docs/community.aws.iam_user_info_module.rst index 561eecfc007..f1d460c3ef6 100644 --- a/docs/community.aws.iam_user_info_module.rst +++ b/docs/community.aws.iam_user_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -203,6 +207,8 @@ Parameters @@ -235,6 +241,8 @@ Parameters @@ -265,7 +273,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.iam_user_module.rst b/docs/community.aws.iam_user_module.rst index 95a84bb2f1f..d3065e79540 100644 --- a/docs/community.aws.iam_user_module.rst +++ b/docs/community.aws.iam_user_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                        - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -150,7 +154,8 @@ Parameters
                                        list - / elements=string
                                        + / elements=string + @@ -167,7 +172,8 @@ Parameters
                                        string - / required
                                        + / required + @@ -188,6 +194,8 @@ Parameters @@ -240,6 +248,8 @@ Parameters @@ -250,7 +260,8 @@ Parameters
                                        string - / required
                                        + / required +
                                        Parameter Choices/Defaults Comments
                                        AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_access_key, access_key
                                        AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: ec2_secret_key, secret_key
                                        Uses a boto profile. Only works with boto >= 2.24.0.
                                        +
                                        Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                        +
                                        aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                        aliases: aws_profile
                                        AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                        +
                                        If profile is set this parameter is ignored.
                                        +
                                        Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                        aliases: aws_security_token, access_token
                                          Choices: @@ -289,7 +300,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.kinesis_stream_module.rst b/docs/community.aws.kinesis_stream_module.rst index 2ee9ef5c92d..721b75ed6eb 100644 --- a/docs/community.aws.kinesis_stream_module.rst +++ b/docs/community.aws.kinesis_stream_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html - + @@ -57,6 +57,8 @@ Parameters @@ -107,6 +109,8 @@ Parameters @@ -206,7 +210,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -227,6 +232,8 @@ Parameters @@ -277,6 +284,8 @@ Parameters @@ -393,7 +402,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.lambda_alias_module.rst b/docs/community.aws.lambda_alias_module.rst index 6afb9788adb..5ff81ec22f0 100644 --- a/docs/community.aws.lambda_alias_module.rst +++ b/docs/community.aws.lambda_alias_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -164,7 +168,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -195,7 +200,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -217,6 +223,8 @@ Parameters @@ -249,6 +257,8 @@ Parameters @@ -298,7 +308,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.lambda_event_module.rst b/docs/community.aws.lambda_event_module.rst index fee94cd64ba..15ae5096543 100644 --- a/docs/community.aws.lambda_event_module.rst +++ b/docs/community.aws.lambda_event_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -70,6 +70,8 @@ Parameters @@ -120,6 +122,8 @@ Parameters @@ -186,7 +190,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -208,6 +213,8 @@ Parameters @@ -240,6 +247,8 @@ Parameters @@ -250,7 +259,8 @@ Parameters
                                          dictionary - / required
                                          + / required + @@ -304,7 +314,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -396,7 +407,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.lambda_facts_module.rst b/docs/community.aws.lambda_facts_module.rst index 7396a687ec7..e3176d53608 100644 --- a/docs/community.aws.lambda_facts_module.rst +++ b/docs/community.aws.lambda_facts_module.rst @@ -43,7 +43,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -61,6 +61,8 @@ Parameters @@ -111,6 +113,8 @@ Parameters @@ -193,6 +197,8 @@ Parameters @@ -248,6 +254,8 @@ Parameters @@ -278,7 +286,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.lambda_info_module.rst b/docs/community.aws.lambda_info_module.rst index 80987bc814f..e7ae0f1acf7 100644 --- a/docs/community.aws.lambda_info_module.rst +++ b/docs/community.aws.lambda_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -187,6 +191,8 @@ Parameters @@ -242,6 +248,8 @@ Parameters @@ -272,7 +280,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.lambda_module.rst b/docs/community.aws.lambda_module.rst index 3fdfd9dbfa9..c3d07a7be52 100644 --- a/docs/community.aws.lambda_module.rst +++ b/docs/community.aws.lambda_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -225,7 +229,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -246,6 +251,8 @@ Parameters @@ -360,6 +367,8 @@ Parameters @@ -458,7 +467,8 @@ Parameters
                                          list - / elements=string
                                          + / elements=string + @@ -474,7 +484,8 @@ Parameters
                                          list - / elements=string
                                          + / elements=string + @@ -509,7 +520,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.lambda_policy_module.rst b/docs/community.aws.lambda_policy_module.rst index 70af795a55b..9f07149200a 100644 --- a/docs/community.aws.lambda_policy_module.rst +++ b/docs/community.aws.lambda_policy_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -50,7 +50,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -86,6 +87,8 @@ Parameters @@ -136,6 +139,8 @@ Parameters @@ -196,7 +201,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -216,7 +222,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -237,6 +244,8 @@ Parameters @@ -269,6 +278,8 @@ Parameters @@ -328,7 +339,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -379,7 +391,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.lightsail_module.rst b/docs/community.aws.lightsail_module.rst index c5adc12834d..fdf328bba65 100644 --- a/docs/community.aws.lightsail_module.rst +++ b/docs/community.aws.lightsail_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -198,7 +202,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -219,6 +224,8 @@ Parameters @@ -251,6 +258,8 @@ Parameters @@ -373,7 +382,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.rds_instance_info_module.rst b/docs/community.aws.rds_instance_info_module.rst index 1bdc6675e63..6071634a1f3 100644 --- a/docs/community.aws.rds_instance_info_module.rst +++ b/docs/community.aws.rds_instance_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -188,6 +192,8 @@ Parameters @@ -220,6 +226,8 @@ Parameters @@ -250,7 +258,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.rds_instance_module.rst b/docs/community.aws.rds_instance_module.rst index 231f76a2335..48984b9de6f 100644 --- a/docs/community.aws.rds_instance_module.rst +++ b/docs/community.aws.rds_instance_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -143,6 +143,8 @@ Parameters @@ -193,6 +195,8 @@ Parameters @@ -321,7 +325,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -367,7 +372,8 @@ Parameters
                                          list - / elements=string
                                          + / elements=string + @@ -478,7 +484,8 @@ Parameters
                                          list - / elements=string
                                          + / elements=string + @@ -922,6 +929,8 @@ Parameters @@ -1107,6 +1116,8 @@ Parameters @@ -1381,7 +1392,8 @@ Parameters
                                          list - / elements=string
                                          + / elements=string + @@ -1416,7 +1428,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.rds_module.rst b/docs/community.aws.rds_module.rst index 06b9909556a..46ed148e695 100644 --- a/docs/community.aws.rds_module.rst +++ b/docs/community.aws.rds_module.rst @@ -39,7 +39,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -77,6 +77,8 @@ Parameters @@ -127,6 +129,8 @@ Parameters @@ -190,7 +194,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -603,6 +610,8 @@ Parameters @@ -752,7 +761,8 @@ Parameters
                                          list - / elements=string
                                          + / elements=string + @@ -825,7 +835,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.rds_param_group_module.rst b/docs/community.aws.rds_param_group_module.rst index bac8698e955..89f14e0d3e0 100644 --- a/docs/community.aws.rds_param_group_module.rst +++ b/docs/community.aws.rds_param_group_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                            Choices: @@ -538,6 +543,8 @@ Parameters
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                          - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -202,7 +206,8 @@ Parameters
                                          string - / required
                                          + / required + @@ -239,6 +244,8 @@ Parameters @@ -290,6 +297,8 @@ Parameters @@ -300,7 +309,8 @@ Parameters
                                          string - / required
                                          + / required +
                                          Parameter Choices/Defaults Comments
                                          AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_access_key, access_key
                                          AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: ec2_secret_key, secret_key
                                          Uses a boto profile. Only works with boto >= 2.24.0.
                                          +
                                          Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                          +
                                          aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                          aliases: aws_profile
                                          AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                          +
                                          If profile is set this parameter is ignored.
                                          +
                                          Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                          aliases: aws_security_token, access_token
                                            Choices: @@ -354,7 +364,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.rds_snapshot_info_module.rst b/docs/community.aws.rds_snapshot_info_module.rst index fb8508d6c73..87b76fccabf 100644 --- a/docs/community.aws.rds_snapshot_info_module.rst +++ b/docs/community.aws.rds_snapshot_info_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -222,6 +226,8 @@ Parameters @@ -254,6 +260,8 @@ Parameters @@ -306,7 +314,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.rds_snapshot_module.rst b/docs/community.aws.rds_snapshot_module.rst index 8a7f1c418c6..903e7bd5f39 100644 --- a/docs/community.aws.rds_snapshot_module.rst +++ b/docs/community.aws.rds_snapshot_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                            Parameter Choices/Defaults Comments
                                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_access_key, access_key
                                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_secret_key, secret_key
                                            Uses a boto profile. Only works with boto >= 2.24.0.
                                            +
                                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                            +
                                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                            aliases: aws_profile
                                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: aws_security_token, access_token
                                            - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -130,7 +134,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -187,6 +192,8 @@ Parameters @@ -238,6 +245,8 @@ Parameters @@ -337,7 +346,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.rds_subnet_group_module.rst b/docs/community.aws.rds_subnet_group_module.rst index 324ddcae414..d72d4c4164d 100644 --- a/docs/community.aws.rds_subnet_group_module.rst +++ b/docs/community.aws.rds_subnet_group_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                                            Parameter Choices/Defaults Comments
                                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_access_key, access_key
                                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_secret_key, secret_key
                                            Uses a boto profile. Only works with boto >= 2.24.0.
                                            +
                                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                            +
                                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                            aliases: aws_profile
                                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: aws_security_token, access_token
                                            - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -164,7 +168,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -185,6 +190,8 @@ Parameters @@ -217,6 +224,8 @@ Parameters @@ -227,7 +236,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -282,7 +293,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.redshift_cross_region_snapshots_module.rst b/docs/community.aws.redshift_cross_region_snapshots_module.rst index 012aa06685d..2a3c96ac85e 100644 --- a/docs/community.aws.redshift_cross_region_snapshots_module.rst +++ b/docs/community.aws.redshift_cross_region_snapshots_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                            Parameter Choices/Defaults Comments
                                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_access_key, access_key
                                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_secret_key, secret_key
                                            Uses a boto profile. Only works with boto >= 2.24.0.
                                            +
                                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                            +
                                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                            aliases: aws_profile
                                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: aws_security_token, access_token
                                              Choices: @@ -246,7 +256,8 @@ Parameters
                                              list - / elements=string
                                              + / elements=string +
                                            - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -116,7 +120,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -151,7 +156,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -189,6 +195,8 @@ Parameters @@ -199,7 +207,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -221,6 +230,8 @@ Parameters @@ -248,7 +259,8 @@ Parameters
                                            integer - / required
                                            + / required + @@ -303,7 +315,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.redshift_info_module.rst b/docs/community.aws.redshift_info_module.rst index 87324f6c5e5..8de44f0b838 100644 --- a/docs/community.aws.redshift_info_module.rst +++ b/docs/community.aws.redshift_info_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                            Parameter Choices/Defaults Comments
                                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_access_key, access_key
                                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_secret_key, secret_key
                                            Uses a boto profile. Only works with boto >= 2.24.0.
                                            +
                                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                            +
                                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                            aliases: aws_profile
                                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: aws_security_token, access_token
                                            - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -173,6 +177,8 @@ Parameters @@ -205,6 +211,8 @@ Parameters @@ -250,7 +258,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.redshift_module.rst b/docs/community.aws.redshift_module.rst index 8aca4d1f59a..f1397c0a027 100644 --- a/docs/community.aws.redshift_module.rst +++ b/docs/community.aws.redshift_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                            Parameter Choices/Defaults Comments
                                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_access_key, access_key
                                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_secret_key, secret_key
                                            Uses a boto profile. Only works with boto >= 2.24.0.
                                            +
                                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                            +
                                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                            aliases: aws_profile
                                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: aws_security_token, access_token
                                            - + @@ -106,6 +106,8 @@ Parameters @@ -156,6 +158,8 @@ Parameters @@ -182,7 +186,8 @@ Parameters
                                            list - / elements=string
                                            + / elements=string + @@ -252,7 +257,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -525,6 +532,8 @@ Parameters @@ -576,6 +585,8 @@ Parameters @@ -642,7 +653,8 @@ Parameters
                                            list - / elements=string
                                            + / elements=string + @@ -695,7 +707,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.redshift_subnet_group_module.rst b/docs/community.aws.redshift_subnet_group_module.rst index 6457827f096..c1097805de4 100644 --- a/docs/community.aws.redshift_subnet_group_module.rst +++ b/docs/community.aws.redshift_subnet_group_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                                            Parameter Choices/Defaults Comments
                                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_access_key, access_key
                                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_secret_key, secret_key
                                              Choices: @@ -394,7 +400,8 @@ Parameters
                                              string - / required
                                              + / required +
                                            Uses a boto profile. Only works with boto >= 2.24.0.
                                            +
                                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                            +
                                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                            aliases: aws_profile
                                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: aws_security_token, access_token
                                            - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -164,7 +168,8 @@ Parameters
                                            string - / required
                                            + / required + @@ -180,7 +185,8 @@ Parameters
                                            list - / elements=string
                                            + / elements=string + @@ -202,6 +208,8 @@ Parameters @@ -234,6 +242,8 @@ Parameters @@ -244,7 +254,8 @@ Parameters
                                            string - / required
                                            + / required +
                                            Parameter Choices/Defaults Comments
                                            AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_access_key, access_key
                                            AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: ec2_secret_key, secret_key
                                            Uses a boto profile. Only works with boto >= 2.24.0.
                                            +
                                            Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                            +
                                            aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                            aliases: aws_profile
                                            AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                            +
                                            If profile is set this parameter is ignored.
                                            +
                                            Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                            aliases: aws_security_token, access_token
                                              Choices: @@ -283,7 +294,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.route53_health_check_module.rst b/docs/community.aws.route53_health_check_module.rst index d3585ba8e22..7672b0d77b7 100644 --- a/docs/community.aws.route53_health_check_module.rst +++ b/docs/community.aws.route53_health_check_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -227,6 +231,8 @@ Parameters @@ -296,6 +302,8 @@ Parameters @@ -340,7 +348,8 @@ Parameters
                                              string - / required
                                              + / required +
                                              Parameter Choices/Defaults Comments
                                              AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                              +
                                              If profile is set this parameter is ignored.
                                              +
                                              Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                              aliases: ec2_access_key, access_key
                                              AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                              +
                                              If profile is set this parameter is ignored.
                                              +
                                              Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                              aliases: ec2_secret_key, secret_key
                                              Uses a boto profile. Only works with boto >= 2.24.0.
                                              +
                                              Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                              +
                                              aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                              aliases: aws_profile
                                              AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                              +
                                              If profile is set this parameter is ignored.
                                              +
                                              Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                              aliases: aws_security_token, access_token
                                                Choices: @@ -382,7 +391,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.route53_info_module.rst b/docs/community.aws.route53_info_module.rst index b4260fdc583..e6b62e7617a 100644 --- a/docs/community.aws.route53_info_module.rst +++ b/docs/community.aws.route53_info_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -310,6 +314,8 @@ Parameters @@ -320,7 +326,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -383,6 +391,8 @@ Parameters @@ -455,7 +465,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.route53_module.rst b/docs/community.aws.route53_module.rst index be7e3ce8272..1618d2a5c94 100644 --- a/docs/community.aws.route53_module.rst +++ b/docs/community.aws.route53_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                  Choices: @@ -359,7 +366,8 @@ Parameters
                                                  list - / elements=string
                                                  + / elements=string +
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                - + @@ -106,6 +106,8 @@ Parameters @@ -156,6 +158,8 @@ Parameters @@ -310,6 +314,8 @@ Parameters @@ -320,7 +326,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -372,6 +379,8 @@ Parameters @@ -382,7 +391,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -567,7 +579,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.route53_zone_module.rst b/docs/community.aws.route53_zone_module.rst index 54f7006e036..b2d46d9e36b 100644 --- a/docs/community.aws.route53_zone_module.rst +++ b/docs/community.aws.route53_zone_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                  Choices: @@ -421,7 +431,8 @@ Parameters
                                                  string - / required
                                                  + / required +
                                                  Choices: @@ -468,7 +479,8 @@ Parameters
                                                  list - / elements=string
                                                  + / elements=string +
                                                - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -203,6 +207,8 @@ Parameters @@ -235,6 +241,8 @@ Parameters @@ -313,7 +321,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -329,7 +338,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.s3_bucket_notification_module.rst b/docs/community.aws.s3_bucket_notification_module.rst index f0a0a08249a..c7729792c5f 100644 --- a/docs/community.aws.s3_bucket_notification_module.rst +++ b/docs/community.aws.s3_bucket_notification_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -114,7 +118,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -164,7 +169,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -179,7 +185,8 @@ Parameters
                                                list - / elements=string
                                                + / elements=string + @@ -309,6 +318,8 @@ Parameters @@ -374,7 +385,7 @@ Notes .. note:: - This module heavily depends on :ref:`community.aws.lambda_policy ` as you need to allow ``lambda:InvokeFunction`` permission for your lambda function. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.s3_lifecycle_module.rst b/docs/community.aws.s3_lifecycle_module.rst index c55f74ca544..4cad7c314af 100644 --- a/docs/community.aws.s3_lifecycle_module.rst +++ b/docs/community.aws.s3_lifecycle_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                  Choices: @@ -277,6 +284,8 @@ Parameters
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -179,7 +183,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -244,7 +249,8 @@ Parameters
                                                list - / elements=dictionary
                                                + / elements=dictionary + @@ -282,6 +288,8 @@ Parameters @@ -367,6 +375,8 @@ Parameters @@ -466,7 +476,8 @@ Parameters
                                                list - / elements=dictionary
                                                + / elements=dictionary + @@ -503,7 +514,7 @@ Notes .. note:: - If specifying expiration time as days then transition time must also be specified in days - If specifying expiration time as a date then transition time must also be specified as a date - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.s3_logging_module.rst b/docs/community.aws.s3_logging_module.rst index 3ffc8732686..545303e4c74 100644 --- a/docs/community.aws.s3_logging_module.rst +++ b/docs/community.aws.s3_logging_module.rst @@ -35,7 +35,7 @@ Parameters .. raw:: html
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                - + @@ -53,6 +53,8 @@ Parameters @@ -103,6 +105,8 @@ Parameters @@ -148,7 +152,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -169,6 +174,8 @@ Parameters @@ -201,6 +208,8 @@ Parameters @@ -281,7 +290,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.s3_sync_module.rst b/docs/community.aws.s3_sync_module.rst index ac4e710242f..735d89ebb3a 100644 --- a/docs/community.aws.s3_sync_module.rst +++ b/docs/community.aws.s3_sync_module.rst @@ -38,7 +38,7 @@ Parameters .. raw:: html
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                - + @@ -56,6 +56,8 @@ Parameters @@ -106,6 +108,8 @@ Parameters @@ -116,7 +120,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -242,7 +247,8 @@ Parameters
                                                path - / required
                                                + / required + @@ -355,6 +361,8 @@ Parameters @@ -402,6 +410,8 @@ Parameters @@ -432,7 +442,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.s3_website_module.rst b/docs/community.aws.s3_website_module.rst index 1f4924b9df1..b4d34254e0c 100644 --- a/docs/community.aws.s3_website_module.rst +++ b/docs/community.aws.s3_website_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -164,7 +168,8 @@ Parameters
                                                string - / required
                                                + / required + @@ -185,6 +190,8 @@ Parameters @@ -232,6 +239,8 @@ Parameters @@ -242,7 +251,8 @@ Parameters
                                                string - / required
                                                + / required +
                                                Parameter Choices/Defaults Comments
                                                AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_access_key, access_key
                                                AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: ec2_secret_key, secret_key
                                                Uses a boto profile. Only works with boto >= 2.24.0.
                                                +
                                                Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                +
                                                aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                aliases: aws_profile
                                                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                +
                                                If profile is set this parameter is ignored.
                                                +
                                                Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                aliases: aws_security_token, access_token
                                                  Choices: @@ -297,7 +307,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.sns_module.rst b/docs/community.aws.sns_module.rst index 3ba142330a7..1e61ff15984 100644 --- a/docs/community.aws.sns_module.rst +++ b/docs/community.aws.sns_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html - + @@ -70,6 +70,8 @@ Parameters @@ -120,6 +122,8 @@ Parameters @@ -277,7 +281,8 @@ Parameters
                                                  string - / required
                                                  + / required + @@ -299,6 +304,8 @@ Parameters @@ -331,6 +338,8 @@ Parameters @@ -386,7 +395,8 @@ Parameters
                                                  string - / required
                                                  + / required + @@ -421,7 +431,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.sns_topic_module.rst b/docs/community.aws.sns_topic_module.rst index 4e946e0ad93..100aac00b38 100644 --- a/docs/community.aws.sns_topic_module.rst +++ b/docs/community.aws.sns_topic_module.rst @@ -36,7 +36,7 @@ Parameters .. raw:: html
                                                  Parameter Choices/Defaults Comments
                                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_access_key, access_key
                                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_secret_key, secret_key
                                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                                  +
                                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                  +
                                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                  aliases: aws_profile
                                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: aws_security_token, access_token
                                                  - + @@ -54,6 +54,8 @@ Parameters @@ -104,6 +106,8 @@ Parameters @@ -179,7 +183,8 @@ Parameters
                                                  string - / required
                                                  + / required + @@ -215,6 +220,8 @@ Parameters @@ -266,6 +273,8 @@ Parameters @@ -295,7 +304,8 @@ Parameters
                                                  list - / elements=dictionary
                                                  + / elements=dictionary + @@ -328,7 +339,8 @@ Parameters
                                                  - - / required
                                                  + / required + @@ -364,7 +376,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.sqs_queue_module.rst b/docs/community.aws.sqs_queue_module.rst index 31047c4515d..106e2c24083 100644 --- a/docs/community.aws.sqs_queue_module.rst +++ b/docs/community.aws.sqs_queue_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                                  Parameter Choices/Defaults Comments
                                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_access_key, access_key
                                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_secret_key, secret_key
                                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                                  +
                                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                  +
                                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                  aliases: aws_profile
                                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: aws_security_token, access_token
                                                  Default:
                                                  []
                                                  @@ -312,7 +322,8 @@ Parameters
                                                  - - / required
                                                  + / required +
                                                  - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -246,7 +250,8 @@ Parameters
                                                  string - / required
                                                  + / required + @@ -282,6 +287,8 @@ Parameters @@ -384,6 +391,8 @@ Parameters @@ -465,7 +474,7 @@ Notes ----- .. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.sts_assume_role_module.rst b/docs/community.aws.sts_assume_role_module.rst index ba469d142fa..0de6e76c81b 100644 --- a/docs/community.aws.sts_assume_role_module.rst +++ b/docs/community.aws.sts_assume_role_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                                  Parameter Choices/Defaults Comments
                                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_access_key, access_key
                                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_secret_key, secret_key
                                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                                  +
                                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                  +
                                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                  aliases: aws_profile
                                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: aws_security_token, access_token
                                                  - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -233,6 +237,8 @@ Parameters @@ -259,7 +265,8 @@ Parameters
                                                  string - / required
                                                  + / required + @@ -274,7 +281,8 @@ Parameters
                                                  string - / required
                                                  + / required + @@ -295,6 +303,8 @@ Parameters @@ -326,7 +336,7 @@ Notes .. note:: - In order to use the assumed role in a following playbook task you must pass the access_key, access_secret and access_token. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/docs/community.aws.sts_session_token_module.rst b/docs/community.aws.sts_session_token_module.rst index c95a54565b9..432dda4191a 100644 --- a/docs/community.aws.sts_session_token_module.rst +++ b/docs/community.aws.sts_session_token_module.rst @@ -37,7 +37,7 @@ Parameters .. raw:: html
                                                  Parameter Choices/Defaults Comments
                                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_access_key, access_key
                                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_secret_key, secret_key
                                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                                  +
                                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                  +
                                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                  aliases: aws_profile
                                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: aws_security_token, access_token
                                                  - + @@ -55,6 +55,8 @@ Parameters @@ -105,6 +107,8 @@ Parameters @@ -201,6 +205,8 @@ Parameters @@ -233,6 +239,8 @@ Parameters @@ -264,7 +272,7 @@ Notes .. note:: - In order to use the session token in a following playbook task you must pass the *access_key*, *access_secret* and *access_token*. - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_CA_BUNDLE`` + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file diff --git a/galaxy.yml b/galaxy.yml index cf4fe742d7a..3a2958e0814 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: community name: aws -version: 1.1.0 +version: 1.2.0 readme: README.md authors: - Ansible (https://github.com/ansible) @@ -8,7 +8,7 @@ description: null license_file: COPYING tags: [community, aws, cloud, amazon] dependencies: - amazon.aws: '>=1.1.0' + amazon.aws: '>=1.2.0' repository: https://github.com/ansible-collections/community.aws documentation: https://github.com/ansible-collections/community.aws/tree/main/docs homepage: https://github.com/ansible-collections/community.aws diff --git a/tests/requirements.yml b/tests/requirements.yml index 5b38580e603..359b5600688 100644 --- a/tests/requirements.yml +++ b/tests/requirements.yml @@ -1,7 +1,7 @@ integration_tests_dependencies: -- amazon.aws >= 1.1.0 +- amazon.aws >= 1.2.0 - ansible.windows - community.crypto - community.general unit_tests_dependencies: -- amazon.aws >= 1.1.0 +- amazon.aws >= 1.2.0
                                                  Parameter Choices/Defaults Comments
                                                  AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_access_key, access_key
                                                  AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: ec2_secret_key, secret_key
                                                  Uses a boto profile. Only works with boto >= 2.24.0.
                                                  +
                                                  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
                                                  +
                                                  aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

                                                  aliases: aws_profile
                                                  AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
                                                  +
                                                  If profile is set this parameter is ignored.
                                                  +
                                                  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

                                                  aliases: aws_security_token, access_token